nimclient Command

Purpose

The nimclient command allows Network Installation Management (NIM) operations to be performed from a NIM client.

Syntax

To Enable or Disable the NIM Master's Push Permissions
nimclient { -p  } | { -P  }
To Enable or Disable Cryptographic Authentication for NIM Master Push Operations
nimclient {  -c } | { -C }
To List Information about the NIM Environment
nimclient -l LsnimParameters
To Set the Date and Time to That of the NIM Master
nimclient -d
To Perform a NIM Operation
nimclient -o Operation-a Attribute=Value ] ...

Description

The nimclient command is used by workstations that are NIM clients to pull NIM resources. This command can enable or disable the NIM master server's ability to initiate workstation installation and customization for the workstation. The nimclient command can be used to generate a list of available NIM resources or display the NIM resources that are already allocated to the client. The nimclient command with the -o flag can perform limited set of NIM operations.

Flags

Table 1. Flags
Item Description
-a Attribute=Value Passes information to NIM operations.
From the master
Use the lsnim -q Operation -t Type command to get a list of valid attributes for a specific operation.
From the client
Use the nimclient -l -q Operation -t Type command to get a list of valid attributes for a specific operation.
-c Enables SSL authentication during NIM master push operations.
Note: OpenSSL certificates must be configured on the NIM master by using the nimconfig -c command. The SSL certificate is copied from the NIM master when nimclient -c is executed.
-C Disables SSL authentication and uses standard nimsh security during NIM master push operations.
-d Sets the client's date and time to that of the master.
-e Configures NIM client environment to support the dual-stack mode, which means implementation of IPv4 and IPv6 protocols over a single interface definition.
Note: Run the autoconf6 command and start the ndpd-host daemon before configuring the dual-stack environment.
-l Lsnim parameters Executes the lsnim command on the master by using the lsnim parameters that you specify. All the parameters that you use with this option must adhere to the syntax rules of the lsnim command. Some lsnim syntax requires the use of a NIM object name. To find out what the NIM name is for your machine, look in the /etc/niminfo file.
Note: start of changeStarting with AIX® 7.3, Technology Level 3, a new customer object type is introduced for the NIM object types. With the introduction of the NIM customer object type, the nimclient -l command displays only the resources that are part of the current customer object group. For more information about the NIM object types, see the -t flag in the nim command page.end of change
-o Operation Performs the specified operation. Following are the possible operations:
allocate
Allocates a resource for use.
bos_inst
Performs a BOS installation.
change
Changes an object's attributes.
check
Checks the status of a NIM object.
cust
Performs software customization.
deallocate
Deallocates a resource.
diag
This operation enables a machine to boot a diagnostic image.
maint_boot
This operation enables a machine to boot in maintenance mode.
reset
Resets an object's NIM state.
showres
Displays the contents of a NIM resource.
-p The -p flag enables the NIM master to push commands.
-P Removes the NIM master's permission to push commands.
Note: The master can override this restriction by using the -F flag.

Security

Access Control
You must have root authority to run the nimclient command.
RBCA users
Attention RBAC users: This command can perform privileged operations. Only privileged users can run privileged operations. For more information about authorizations and privileges, see Privileged Command Database in Security. For a list of privileges and the authorizations that are associated with this command, see the lssecattr command or the getcmdattr subcommand.

Examples

  1. To list all the NIM resources that are available to this machine when its NIM name is pluto, enter the following command:
    nimclient -l -L pluto
  2. To list all the Shared Product Object Trees (SPOTs) which are available to this machine when its NIM name is pluto, enter the following command:
    nimclient -l -L -t spot pluto
  3. To list the operations that might be initiated from this machine, enter the following command:
    nimclient -l -p -s pull_ops
  4. To prevent the NIM master from running commands locally on the client, enter the following command:
    nimclient -P
  5. To allocate a spot resource that is named myspot, an lpp_source resource that is named images, and an installp bundle file that is named dept_bundle, enter the following command:
    nimclient -o allocate -a spot=myspot -a lpp_source=images \
    -a installp_bundle=dept_bundle
  6. To perform a base system installation after the required resources are allocated, enter the following command:
    nimclient -o bos_inst
  7. From a stand-alone client, to allocate an lpp_source and install a software product such that the image for the installable option, adt, is contained in the lpp_source, images, enter the following command:
    nimclient -o allocate -a lpp_source=images
    Then enter the following command:
    nimclient -o cust -a filesets="adt"
  8. From a stand-alone client, to allocate an lpp_source and install a software product such that the image for the installable option, adt, is contained in the lpp_source, images, and the name of the installable option is contained in the installp_bundle, bundle3, enter the following command:
    nimclient -o allocate -a lpp_source=images \
    -a installp_bundle=bundle3
    Then enter the following command:
    nimclient -o cust
  9. To install all fileset updates associated with APAR IX12345, residing in the lpp_source updt_images, enter the following command:
    nimclient -o allocate -a lpp_source=updt_images
    nimclient -o cust -afixes=IX12345
  10. From the stand-alone NIM, to run a live update for an APAR IX12345, residing in the lpp_source lpp_source1, enter the following command:
    nimclient -o allocate -a lpp_source=lpp_source1
    nimclient -o cust -a live_update=yes -a filesets=IX12345
  11. To update all installed software on the client with the latest updates from the updt_images lpp_source, enter the following command:
    nimclient -o allocate -a lpp_source=updt_images
    nimclient -o cust -afixes=update_all
  12. To enable the system to boot in maintenance mode by using a SPOT resource named spot1, enter the following command:
    nimclient -o maint_boot -a spot=spot1
    This command sets up the maintenance boot operation, but you must initiate the network boot locally.
  13. To show the contents of the config script script1, enter the following command:
    nimclient -o showres -a resource=script1
  14. To show the contents of the bosinst.data resource bosinst_data1, enter the following command:
    nimclient -o showres -a resource=bosinst_data1
  15. To list all the filesets in the lpp_source lpp_source1 relative to what is currently installed on the machine machine1, from the NIM client machine machine1, enter the following command:
    nimclient -o showres -a resource=lpp_source1
    The reference attribute is automatically supplied by the nimclient command.
  16. To list all problems fixed by software on the lpp_source lpp_source1, enter the following command:
    nimclient -o showres -a instfix_flags="T" -a resource=lpp_source1
  17. To install the filesets that are listed in the NIM installp_bundle client_bundle by using the lpp_source client_images, while automatically allocating these resources during the installation operation, enter the following command:
    nimclient -o cust -a installp_bundle=client_bundle \
    -a lpp_source=client_images
  18. To perform a base system installation while automatically allocating all applicable resources from the NIM resource group named client_grp, enter the following command:
    nimclient -o bos_inst -a group=client_grp
  19. To perform a base system installation while automatically allocating all applicable resources from the NIM group defined as the default resource group on the master, enter the following command:
    nimclient -o bos_inst 
  20. To copy an SSL certificate and enable SSL authentication, type:
    nimclient -c
    Note: OpenSSL must be installed on the NIM client before using this command option.
  21. To configure a dual-stack environment, type:
    nimclient -e  en0

Files

Item Description
/etc/niminfo Contains variables that are used by NIM.