nimclient – Allows Network Installation Management (NIM) operations to be performed from a NIM client.

Synopsis

The nimclient module is used by workstations that are NIM clients to pull NIM resources.

This module can enable or disable the NIM master server’s ability to initiate workstation installation and customization for the workstation.

The nimclient module can be used to generate a list of available NIM resources or display the NIM resources that have already been allocated to the client.

A limited set of NIM operations can also be performed by the nimclient command using (action=’perform_nim_op’) action.

Requirements

The below requirements are needed on the host that executes this module.

  • AIX >= 7.1

  • Python >= 3.9

Parameters

action (True, str, None)

Specifies which action needs to be performed. list executes the lsnim command on the master, listing all the resources. perform_nim_op specifies to perform NIM related operations with operation. other_op specifies to perform Non - NIM related operations.

operation (False, str, None)

Specifies which operation needs to be performed. 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 the resource diag enables a machine to boot a diagnostic image. maint_boot enables a machine to boot in maintenance mode. reset resets an object’s NIM state. showres displays the contents of a NIM resource.

master_push_perm (optional, str, None)

enable enables the NIM master to push commands.

disable removes the NIM master’s permissions to push commands.

crypto_auth_perm (optional, str, None)

enable enables SSL authentication during NIM master push operations

disable disables SSL authentication and uses standard nimsh security during NIM master push operations.

set_master_date (optional, bool, False)

To Set the Date and Time to That of the NIM Master

attributes (optional, list, None)

Passes information to NIM operations.

Notes

Note

Examples

- name: List all available NIM resources
  ibm.power_aix.nimclient:
    action: list

- name: Enable crypto auth permission
  ibm.power_aix.nimclient:
    action: other_op
    crypto_auth_perm: enable

- name: Enable master push auth permission
  ibm.power_aix.nimclient:
    action: other_op
    master_push_perm: enable

- name: Set same date as master
  ibm.power_aix.nimclient:
    action: other_op
    set_master_date: true

- name: perform bos_inst
  ibm.power_aix.nimclient:
    action: perform_nim_op
    operation: bos_inst

- name: allocate a lpp_source and spot
  ibm.power_aix.nimclient:
    action: perform_nim_op
    operation: allocate
    attributes:
      - lpp_source=2342B_73D
      - spot=2342B_73D_SPOT

- name: Show contents of a resource
  ibm.power_aix.nimclient:
    action: perform_nim_op
    operation: showres
    attributes:
      - resource=2342B_73D

- name: Enable the system to boot in maintenance mode using a SPOT
  ibm.power_aix.nimclient:
    action: perform_nim_op
    operation: maint_boot
    attributes:
      - spot=2342B_73D_SPOT

- name: Reset the state of client
  ibm.power_aix.nimclient:
    action: perform_nim_op
    operation: reset

Return Values

msg (always, str, )

The execution message.

cmd (always, str, )

The command executed.

rc (always, int, )

The command return code.

stdout (always, str, )

The standard output of the command.

stderr (always, str, )

The standard error of the command.

changed (always, bool, )

Shows if any change was made.

timezone_details (If I(action=list_versions) or I(action=print_updated_zones), dict, )

Contains the details related to timezone.

Status

  • This module is not guaranteed to have a backwards compatible interface. [preview]

  • This module is maintained by community.

Authors

  • Shreyansh Chamola (@schamola)