IBM Z HMC collection
The IBM Z HMC collection provides Ansible modules that can manage platform resources on IBM Z and LinuxONE machines.
The goal of this collection is to be able to utilize the power and ease of use of Ansible for the management of IBM Z platform resources.
The IBM Z platform resources that can be managed include for example partitions, I/O adapters, the Z system itself, or various resources on its Hardware Management Console (HMC).
The Ansible modules in this collection are fully
idempotent,
following an important principle for Ansible modules.
The idempotency of a module allows Ansible playbooks to specify the desired end
state for a resource, regardless of what the current state is. For example, an
IBM Z partition can be specified to have state=active which means that
it must exist and be in the active operational status. Depending on the current
state of the partition, actions will be taken by the module to reach this
desired end state: If the partition does not exist, it will be created and
started. If it exists but is not active, it will be started. If it is already
active, nothing will be done. Other initial states including transitional
states such as starting or stopping also will be taken care of.
The idempotency of modules makes Ansible playbooks restartable: If an error
happens and some things have been changed already, the playbook can simply be
re-run and will automatically do the right thing, because the initial state
does not matter for reaching the desired end state.
The Ansible modules in this collection are written in Python and interact with the Web Services API of the Hardware Management Console (HMC) of the Z machines to be managed.
Note: Before version 0.9.0, the Ansible modules in this collection have been distributed as the zhmc-ansible-modules package on Pypi. Starting with version 0.9.0, the Ansible modules are no longer distributed on Pypi, but as the ibm.ibm_zhmc collection on Ansible Galaxy. Starting with version 1.0.0, the Ansible modules are additionally distributed as the ibm.ibm_zhmc collection on Ansible AutomationHub.
Features
The IBM Z HMC collection includes Modules to automate the management of IBM Z platform resources. There are Sample Playbooks that show how to invoke these modules in playbook tasks.
Getting Started
References
- Modules
- zhmc_session – Manage HMC sessions across tasks
- 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
- zhmc_cpc – Manage a CPC
- zhmc_cpc_list – List CPCs
- zhmc_cpc_capacity – Manage temporary processor capacity
- 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)
- 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)
- Playbooks
Community Guides
Requirements
Appendices
Copyright
Copyright IBM Corporation 2016,2020
License
This collection is licensed under the Apache 2.0 License.
Reporting issues
If you encounter any problem with this collection, or if you have questions of any kind related to this collection (even when they are not about a problem), please open an issue in the issue tracker.