Modules

Ansible® modules can be used from the command line, in a playbook or in a role.

The IBM Z® HMC collection provides several modules. Reference material for each module contains documentation on what parameters the module accepts and what will returned.

Module for HMC sessions:

• zhmc_session – Manage HMC sessions across tasks

Modules targeting the HMC (i.e. not a specific CPC):

• zhmc_versions – Retrieve HMC/CPC version and feature facts
• zhmc_console – Manage the HMC
• zhmc_user – Manage an HMC user
• zhmc_user_list – List HMC users
• zhmc_password_rule – Manage an HMC password rule
• zhmc_password_rule_list – List HMC password rules
• zhmc_user_role – Manage an HMC user role
• zhmc_user_role_list – List HMC user roles
• zhmc_user_pattern – Manage an HMC user pattern
• zhmc_user_pattern_list – List HMC user patterns
• zhmc_ldap_server_definition – Manage an LDAP Server Definition on the HMC
• zhmc_ldap_server_definition_list – List LDAP Server Definitions on the HMC

Modules supported with CPCs in any operational mode:

• zhmc_cpc – Manage a CPC
• zhmc_cpc_list – List CPCs
• zhmc_cpc_capacity – Manage temporary processor capacity

Modules supported only with CPCs in DPM operational mode:

• zhmc_adapter – Manage an adapter (DPM mode)
• zhmc_adapter_list – List adapters (DPM mode)
• zhmc_crypto_attachment – Manage the crypto configuration of a partition (DPM mode)
• zhmc_hba – Manage an HBA of a partition (z13 only, DPM mode)
• zhmc_nic – Manage a NIC of a partition (DPM mode)
• zhmc_nic_list – List NICs of a partition (DPM mode)
• zhmc_partition – Manage a partition (DPM mode)
• zhmc_partition_command – Execute OS console command in a partition (DPM mode)
• zhmc_partition_list – List partitions (DPM mode)
• zhmc_partition_messages – Get console messages for OS in a partition (DPM mode)
• zhmc_storage_group – Manage a storage group (DPM mode)
• zhmc_storage_group_attachment – Manage attachment of a storage group to a partition (DPM mode)
• zhmc_storage_volume – Manage a storage volume (DPM mode)
• zhmc_virtual_function – Manage a virtual function of a partition (DPM mode)

Modules supported only with CPCs in classic operational mode:

• zhmc_lpar – Manage an LPAR (classic mode)
• zhmc_lpar_command – Execute OS console command in an LPAR (classic mode)
• zhmc_lpar_list – List LPARs (classic mode)
• zhmc_lpar_messages – Get console messages for OS in an LPAR (classic mode)

You can also access the documentation of each module from the command line by using the ansible-doc command, for example:

$ ansible-doc ibm.ibm_zhmc.zhmc_adapter