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_console – Manage the HMC
• zhmc_user – Create HMC users
• zhmc_user_list – List HMC users
• zhmc_password_rule – Create HMC password rules
• zhmc_password_rule_list – List Password Rules
• zhmc_user_role – Create HMC user roles
• zhmc_user_role_list – List HMC user roles
• zhmc_ldap_server_definition – Manage LDAP Server Definitions
• zhmc_ldap_server_definition_list – List LDAP Server Definitions

Modules supported with CPCs in any operational mode:

• zhmc_cpc – Manage CPCs
• zhmc_cpc_list – List CPCs

Modules supported only with CPCs in DPM operational mode:

• zhmc_adapter – Update adapters and create Hipersocket adapters
• zhmc_adapter_list – List adapters
• zhmc_crypto_attachment – Attach crypto resources to partitions
• zhmc_hba – Create HBAs in partitions
• zhmc_nic – Create NICs in partitions
• zhmc_nic_list – List NICs
• zhmc_partition – Create partitions
• zhmc_partition_list – List partitions
• zhmc_partition_messages – Get console messages for OS in a partition
• zhmc_storage_group – Create storage groups
• zhmc_storage_group_attachment – Attach storage groups to partitions
• zhmc_storage_volume – Create storage volumes
• zhmc_virtual_function – Create virtual functions in partitions

Modules supported only with CPCs in classic operational mode:

• zhmc_lpar – Manage LPARs
• zhmc_lpar_list – List LPARs
• zhmc_lpar_messages – Get console messages for OS in an LPAR

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