+
+
+
+
+
+ The IBM Z System Automation collection supports operational tasks using the IBM Z System Automation Operations API -such as creating and deleting dynamic resources from a template defined in the current active policy of an IBM Z System Automation environment.
-The Ansible roles in this collection are written in Ansible and interact with the Operations REST server component of IBM Z System Automation.
+such as creating and deleting dynamic resources from a template defined in the current active policy of an IBM Z System Automation environment. +The Ansible roles in this collection are written in Ansible and interact with the Operations REST server component of IBM Z System Automation.
Collection Content
Update collection to meet new requirements.
Added new parameters to create USS resources from templates.
Update collection to meet new requirements.
Roles
Add parameter for socket level timeout to URI tasks in roles.
Minor updates to the documentation.
Update not required
Minor updates to the documentation.
Update not required
Fixed broken links in the documentation.
Initial beta release of IBM Z System Automation collection, referred to as ibm_zos_sysauto which is part of the broader offering Red Hat® Ansible Certified Content for IBM Z.
The IBM Z System Automation collection contains roles that can be used in a playbook to create and resume, and to delete dynamic -resources in an environment that is automated by IBM Z System Automation. These roles greatly simplify the use of the services provided +resources in an environment that is automated by IBM Z System Automation. These roles greatly simplify the use of the services provided by the IBM Z System Automation Operations REST server in custom playbooks.
The IBM Z System Automation collection provides two roles. Reference material for each role contains documentation on how to use certain roles in your playbook.
Specifies the fulll qualified ZFS path to find the application to be started by this new resource.
+The maximum length for this value is 159.
+++Specifies an additional filter criteria to uniquely identify the USS process represented by this new resource.
+The maximum length for this value is 159.
+
Getting Started
-Getting Started
IBM z/OS collections minimally require these versions of software, for additional -supported versions review Ansible Automation Platform Certified Content.
+All IBM z/OS collections are either Ansible Automation Platform Certified Content (AAP) or undergoing certification. Thus, the supported versions of Ansible align with the AAP Life Cycle. For support, the controller must use the supported version of Ansible and when applicable the collections dependencies.
+The minimum software requirements for IBM z/OS collections are:
Ansible version: 2.9
Python: 2.7 or later
ansible-core: 2.15 (AAP 2.4) or later
IBM Open Enterprise SDK for Python: 3.11 or later
+can vary in terms of the requirements for the control node. When you install any of them, review the specific dependencies and required/supported software versions, if any.@@ -224,14 +215,7 @@
Control node -
-
-- z/OS z/OSMF
-
The repository for the IBM Z HMC collection is on GitHub:
This Github repo needs the following secret variables to be set in order +to run its Github Actions workflows successfully:
+GALAXY_API_KEY - API key for the Ansible Galaxy
+service. This variable is set at the repo level.
To get such an API key, you need to have a user on Ansible Galaxy and then go +to the user preferences page to view the API key the site has generated for +your user.
+SLACK_HOOK - Slack hook URL to send test result messages to the
+#python-zhmcclient-test-status
+Slack channel. Note that this channel is IBM-internal and looking at it requires
+an IBM ID. This variable is set at the organisation level.
To get such a URL, follow the instructions in +Sending messages using Incoming Webhooks
+The development environment is pretty easy to set up.
Besides having a supported operating system with a supported Python version (see Supported environments), it is recommended that you set up a @@ -221,7 +242,7 @@ list of valid Make targets and a short description of what each target does.
The documentation for the IBM Z HMC collection is published on GitHub Pages at https://zhmcclient.github.io/zhmc-ansible-modules/.
That web site represents a defined set of versions of this collection and @@ -250,7 +271,7 @@ has been built successfully.
Again, an invocation of Make runs against the currently active Python environment.
There are four kinds of tests currently, available as make targets:
3.10
latest
8.x
2.15
9.x
2.16
3.11
latest
8.x
2.15
9.x
2.16
2.7
3.12
latest
9.x
2.16
2.7
minimum
2.9
2.9
3.5
3.5
minimum
2.9
2.9
3.6
3.6
minimum
2.9
2.9
3.7
3.7
minimum
2.9
2.9
3.8
3.8
minimum
2.9
2.9
3.9
3.9
minimum
4.0
2.11
3.10
3.10
minimum
5.0
2.12
3.11
3.11
minimum
7.0
2.14
3.12
minimum
9.0
2.16
2.7
ansible
2.9
3.11
ansible
8.x+
2.15+
For reference, the following two tables show supported Python versions for -Ansible versions and vice versa, for the Python and Ansible versions that are -relevant for this collection. At the time of writing, the latest Python version -is 3.11 and the latest Ansible version is 8.0.
-Ansible |
-Ansible core |
-Supported Python versions |
-
2.9 |
-ansible 2.9 |
-2.7, 3.5 - 3.8 |
-
2.10 |
-ansible 2.10 |
-2.7, 3.5 - 3.8 |
-
3 |
-ansible-base 2.10 |
-2.7, 3.5 - 3.8 |
-
4 |
-ansible-core 2.11 |
-2.7, 3.5 - 3.9 (1) |
-
5 |
-ansible-core 2.12 |
-3.8 - 3.10 (2) |
-
6 |
-ansible-core 2.13 |
-3.8 - 3.10 (2) |
-
7 |
-ansible-core 2.14 |
-3.9 - 3.11+ |
-
8 |
-ansible-core 2.15 |
-3.9 - 3.11+ |
-
Python |
-Supported Ansible versions |
-||
2.7 |
-2.9, 2.10, 3, 4 |
-||
3.5 |
-2.9, 2.10, 3, 4 |
-||
3.6 |
-2.9, 2.10, 3, 4 |
-||
3.7 |
-2.9, 2.10, 3, 4 |
-||
3.8 |
-2.9, 2.10, 3 - 6 |
-||
3.9 |
-4 - 8+ |
-||
3.10 |
-5 - 8+ (1) |
+8.x |
+2.15 |
3.11 |
-7 - 8+ (2) |
+||
3.12 |
+ansible |
+9.x |
+2.16 |
Notes:
-(1) The sanity test of Ansible 4 supports Python only up to 3.9, so Python -3.10 requires at least Ansible 5.
(2) The sanity test of Ansible 5 and 6 supports Python only up to 3.10, so -Python 3.11 requires at least Ansible 7.
The versions for the ‘latest’ and ‘minimum’ package levels are in sync with the +latest and minimum Ansible versions supported for a particular Python version, +as documented in Supported environments. +The versions for the ‘ansible’ package level are designed to cover all +Ansible versions.
This section shows the steps for releasing a version to Ansible Galaxy.
It covers all variants of versions that can be released:
Remove all empty list items.
Update the authors:
+make authors
+Commit your changes and push the topic branch to the remote repo:
git commit -asm "Release ${MNU}"
git push --set-upstream origin release_${MNU}
@@ -679,7 +634,7 @@
This section shows the steps for starting development of a new version.
These steps may be performed right after the steps for Releasing a version, or independently.
diff --git a/zhmc-ansible-modules/docs/source/modules.html b/zhmc-ansible-modules/docs/source/modules.html index 9f5271ed..3f4a3b51 100644 --- a/zhmc-ansible-modules/docs/source/modules.html +++ b/zhmc-ansible-modules/docs/source/modules.html @@ -96,13 +96,15 @@Modules targeting the HMC (i.e. not a specific CPC):
Modules supported with CPCs in any operational mode:
@@ -248,6 +254,7 @@You can also access the documentation of each module from the command line by diff --git a/zhmc-ansible-modules/docs/source/modules/zhmc_adapter.html b/zhmc-ansible-modules/docs/source/modules/zhmc_adapter.html index 8517fcf7..94e1fa45 100644 --- a/zhmc-ansible-modules/docs/source/modules/zhmc_adapter.html +++ b/zhmc-ansible-modules/docs/source/modules/zhmc_adapter.html @@ -96,13 +96,15 @@
The hostname or IP address of the HMC.
+The hostnames or IP addresses of a single HMC or of a list of redundant HMCs. A single HMC can be specified as a string type or as an HMC list with one item. An HMC list can be specified as a list type or as a string type containing a Python list representation.
+The first available HMC of a list of redundant HMCs is used for the entire execution of the module.
The authentication credentials for the HMC.
@@ -272,7 +277,7 @@HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in zhmc_session – Manage HMC sessions across tasks.
HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in :ref:`zhmc_session_module`.
The name of the target adapter. In case of renaming an adapter, this is the new name of the adapter.
+The name of the CPC with the target adapter.
The name of the CPC with the target adapter.
+The name of the target adapter. In case of renaming an adapter, this is the new name of the adapter.
The desired state for the adapter. All states are fully idempotent within the limits of the properties that can be changed:
-set: Ensures that an existing adapter has the specified properties.
present: Ensures that a Hipersockets adapter exists and has the specified properties.
absent: Ensures that a Hipersockets adapter does not exist.
facts: Returns the adapter properties including its ports.
* set: Ensures that an existing adapter has the specified properties.
* present: Ensures that a Hipersockets adapter exists and has the specified properties.
* absent: Ensures that a Hipersockets adapter does not exist.
* facts: Returns the adapter properties including its ports.
Only for state=set|present: New values for the properties of the adapter. Properties omitted in this dictionary will remain unchanged. This parameter will be ignored for other states.
The parameter is a dictionary. The key of each dictionary item is the property name as specified in the data model for adapter resources, with underscores instead of hyphens. The value of each dictionary item is the property value (in YAML syntax). Integer properties may also be provided as decimal strings.
The possible properties in this dictionary are the properties defined as writeable in the data model for adapter resources, with the following exceptions:
-name: Cannot be specified as a property because the name has already been specified in the name module parameter.
type: The desired adapter type can be specified in order to support adapters that can change their type (e.g. the FICON Express adapter can change its type between ‘not-configured’, ‘fcp’ and ‘fc’).
crypto_type: The crypto type can be specified in order to support the ability of the Crypto Express adapters to change their crypto type. Valid values are ‘ep11’, ‘cca’ and ‘acc’. Changing to ‘acc’ will zeroize the crypto adapter.
* name: Cannot be specified as a property because the name has already been specified in the name module parameter.
* type: The desired adapter type can be specified in order to support adapters that can change their type (e.g. the FICON Express adapter can change its type between ‘not-configured’, ‘fcp’ and ‘fc’).
* crypto_type: The crypto type can be specified in order to support the ability of the Crypto Express adapters to change their crypto type. Valid values are ‘ep11’, ‘cca’ and ‘acc’. Changing to ‘acc’ will zeroize the crypto adapter.
Additional properties of the adapter, as described in the data model of the ‘Adapter’ object in the HMC API book. The property names have hyphens (-) as described in that book.
+Additional properties of the adapter, as described in the data model of the ‘Adapter’ object in the :term:`HMC API` book. The property names have hyphens (-) as described in that book.
+Artificial property for the ports of the adapter.
Additional properties of the port, as described in the data model of the ‘Network Port’ or ‘Storage Port’ element object of the ‘Adapter’ object in the HMC API book. The property names have hyphens (-) as described in that book. In case of unconfigured FICON adapters, the property list is short.
+Additional properties of the port, as described in the data model of the ‘Network Port’ or ‘Storage Port’ element object of the ‘Adapter’ object in the :term:`HMC API` book. The property names have hyphens (-) as described in that book. In case of unconfigured FICON adapters, the property list is short.
+The HMC userid must have object-access permissions to these objects: Target adapters, CPCs of target adapters (only for z13 and older).
The HMC userid must have object-access permissions to these objects: Target adapters, CPCs of target adapters (CPC access is only needed for HMC version 2.15 and older).
The hostname or IP address of the HMC.
+The hostnames or IP addresses of a single HMC or of a list of redundant HMCs. A single HMC can be specified as a string type or as an HMC list with one item. An HMC list can be specified as a list type or as a string type containing a Python list representation.
+The first available HMC of a list of redundant HMCs is used for the entire execution of the module.
The authentication credentials for the HMC.
@@ -270,7 +276,7 @@HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in zhmc_session – Manage HMC sessions across tasks.
HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in :ref:`zhmc_session_module`.
List of additional properties to be returned for each adapter, in addition to the default properties (see result description).
+Mutually exclusive with full_properties.
The property names are specified with underscores instead of hyphens.
+On HMCs with an API version below 4.10 (= HMC version 2.16.0 with some post-GA updates), all properties of each adapter will be returned if this parameter is specified, but you should not rely on that.
+If True, all properties of each adapter will be returned. Default: False.
+Mutually exclusive with additional_properties.
Note: Setting this to True causes a loop of ‘Get Adapter Properties’ operations to be executed. It is preferable from a performance perspective to use the additional_properties parameter instead.
File path of a log file to which the logic flow of this module as well as interactions with the HMC are logged. If null, logging will be propagated to the Python root logger.
The list of adapters, with a subset of their properties. For details on the properties, see the data model of the ‘Adapter’ resource (see HMC API)
+The list of adapters, with a subset of their properties. For details on the properties, see the data model of the ‘Adapter’ resource (see :term:`HMC API`)
Additional properties requested via full_properties or additional_properties. The property names will have underscores instead of hyphens.
No specific task or object-access permissions are required.
For state=facts, no specific task or object-access permissions are required.
For state=upgrade, task permission to the ‘Single Step Console Internal Code’ task is required.
The hostname or IP address of the HMC.
+The hostnames or IP addresses of a single HMC or of a list of redundant HMCs. A single HMC can be specified as a string type or as an HMC list with one item. An HMC list can be specified as a list type or as a string type containing a Python list representation.
+The first available HMC of a list of redundant HMCs is used for the entire execution of the module.
The authentication credentials for the HMC.
@@ -266,7 +273,7 @@HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in zhmc_session – Manage HMC sessions across tasks.
HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in :ref:`zhmc_session_module`.
The desired state for the HMC. For consistency with other modules, and for extensibility, this parameter is required even though it has only one value:
-facts: Returns facts about the HMC.
The action to be performed on the HMC:
+* facts: Returns facts about the HMC.
* upgrade: Upgrades the firmware of the HMC and returns the new facts after the upgrade. If the HMC firmware is already at the requested bundle level, nothing is changed and the module succeeds.
Name of the bundle to be installed on the HMC (e.g. ‘H71’)
+Required for state=upgrade
Timeout in seconds for waiting for completion of upgrade (e.g. 3600)
+Type of backup location for the HMC backup that is performed:
+* ‘ftp’: The FTP server that was used for the last console backup as defined on the ‘Configure Backup Settings’ user interface task in the HMC GUI.
+* ‘usb’: The USB storage device mounted to the HMC.
+Optional for state=upgrade, default: ‘usb’
Accept the previous bundle level before installing the new level.
+Optional for state=upgrade, default: True
File path of a log file to which the logic flow of this module as well as interactions with the HMC are logged. If null, logging will be propagated to the Python root logger.
@@ -316,6 +355,15 @@Additional properties of the Console object representing the targeted HMC, as described in the data model of the ‘Console’ object in the HMC API book. Note that the set of properties has been extended over the past HMC versions, so you will get less properties on older HMC versions. The property names have hyphens (-) as described in that book.
+Additional properties of the Console object representing the targeted HMC, as described in the data model of the ‘Console’ object in the :term:`HMC API` book. Note that the set of properties has been extended over the past HMC versions, so you will get less properties on older HMC versions. The property names have hyphens (-) as described in that book.
+Additional facts from the ‘Query API Version’ operation.
The properties returned from the ‘Query API Version’ operation, as described in the HMC API book. Note that the set of properties has been extended over the past HMC versions, so you will get less properties on older HMC versions. The property names have hyphens (-) as described in that book.
+The properties returned from the ‘Query API Version’ operation, as described in the :term:`HMC API` book. Note that the set of properties has been extended over the past HMC versions, so you will get less properties on older HMC versions. The property names have hyphens (-) as described in that book.
+The hostname or IP address of the HMC.
+The hostnames or IP addresses of a single HMC or of a list of redundant HMCs. A single HMC can be specified as a string type or as an HMC list with one item. An HMC list can be specified as a list type or as a string type containing a Python list representation.
+The first available HMC of a list of redundant HMCs is used for the entire execution of the module.
The authentication credentials for the HMC.
@@ -270,7 +276,7 @@HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in zhmc_session – Manage HMC sessions across tasks.
HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in :ref:`zhmc_session_module`.
The desired state for the CPC. All states are fully idempotent within the limits of the properties that can be changed:
-inactive: Ensures the CPC is inactive.
active: Ensures the CPC is active and then ensures that the CPC has the specified properties. The operational mode of the CPC cannot be changed.
set: Ensures that the CPC has the specified properties.
facts: Returns the CPC properties including its child resources.
* inactive: Ensures the CPC is inactive.
* active: Ensures the CPC is active and then ensures that the CPC has the specified properties. The operational mode of the CPC cannot be changed.
* set: Ensures that the CPC has the specified properties.
* facts: Returns the CPC properties including its child resources.
* upgrade: Upgrades the firmware of the SE of the CPC and returns the new facts after the upgrade. If the SE firmware is already at the requested bundle level, nothing is changed and the module succeeds.
Limits the returned properties of the CPC to those specified in this parameter plus those specified in the properties parameter.
The properties can be specified with underscores or hyphens in their names.
+Null indicates not to limit the returned properties in this way.
+This parameter is ignored for state values that cause no properties to be returned.
The returned child resources (adapters, partitions, storage groups) cannot be excluded using this parameter.
+The specified properties are passed to the ‘Get CPC Properties’ HMC operation using the ‘properties’ query parameter and save time for the HMC to pull together all properties.
+The name of the reset activation profile to be used when activating the CPC in the classic operational mode, for state=active. This parameter is ignored when the CPC is in classic mode and was already active, and when the CPC is in DPM mode.
Name of the bundle to be installed on the SE of the CPC (e.g. ‘S71’)
+Required for state=upgrade
Timeout in seconds for waiting for completion of upgrade (e.g. 10800)
+Accept the previous bundle level before installing the new level.
+Optional for state=upgrade, default: True
File path of a log file to which the logic flow of this module as well as interactions with the HMC are logged. If null, logging will be propagated to the Python root logger.
The CPC and its adapters, partitions, and storage groups.
+For state=inactive, an empty dictionary.
For state=active|set|facts|upgrade, the resource properties of the CPC after after any specified updates have been applied, and its adapters, partitions, and storage groups.
Additional properties of the CPC, as described in the data model of the ‘CPC’ object in the HMC API book. The property names have hyphens (-) as described in that book.
+Additional properties of the CPC, as described in the data model of the ‘CPC’ object in the :term:`HMC API` book. The property names have hyphens (-) as described in that book.
+The adapters of the CPC, with a subset of their properties. For details, see the HMC API book.
+The adapters of the CPC, with a subset of their properties. For details, see the :term:`HMC API` book.
The defined partitions of the CPC, with a subset of their properties. For details, see the HMC API book.
+The defined partitions of the CPC, with a subset of their properties. For details, see the :term:`HMC API` book.
The storage groups associated with the CPC, with a subset of their properties. For details, see the HMC API book.
+The storage groups associated with the CPC, with a subset of their properties. For details, see the :term:`HMC API` book.
The hostname or IP address of the HMC.
+The hostnames or IP addresses of a single HMC or of a list of redundant HMCs. A single HMC can be specified as a string type or as an HMC list with one item. An HMC list can be specified as a list type or as a string type containing a Python list representation.
+The first available HMC of a list of redundant HMCs is used for the entire execution of the module.
The authentication credentials for the HMC.
@@ -266,7 +271,7 @@HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in zhmc_session – Manage HMC sessions across tasks.
HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in :ref:`zhmc_session_module`.
If True, all properties of each CPC will be returned. Default: False.
+Note: Setting this to True causes a loop of ‘Get CPC Properties’ operations to be executed.
+File path of a log file to which the logic flow of this module as well as interactions with the HMC are logged. If null, logging will be propagated to the Python root logger.
The current status of the CPC. For details, see the description of the ‘status’ property in the data model of the ‘CPC’ resource (see HMC API). Only included for managed CPCs.
+The current status of the CPC. For details, see the description of the ‘status’ property in the data model of the ‘CPC’ resource (see :term:`HMC API`). Only included for managed CPCs.
Additional properties requested via full_properties. The property names will have underscores instead of hyphens.
The hostname or IP address of the HMC.
+The hostnames or IP addresses of a single HMC or of a list of redundant HMCs. A single HMC can be specified as a string type or as an HMC list with one item. An HMC list can be specified as a list type or as a string type containing a Python list representation.
+The first available HMC of a list of redundant HMCs is used for the entire execution of the module.
The authentication credentials for the HMC.
@@ -270,7 +275,7 @@HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in zhmc_session – Manage HMC sessions across tasks.
HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in :ref:`zhmc_session_module`.
The desired state for the crypto attachment. All states are fully idempotent within the limits of the properties that can be changed:
-attached: Ensures that the specified number of crypto adapters of the specified crypto type, and the specified range of domain index numbers in the specified access mode are attached to the partition.
detached: Ensures that no crypto adapter and no crypto domains are attached to the partition.
facts: Returns the crypto configuration of the partition.
* attached: Ensures that the specified number of crypto adapters of the specified crypto type, and the specified range of domain index numbers in the specified access mode are attached to the partition.
* detached: Ensures that no crypto adapter and no crypto domains are attached to the partition.
* facts: Returns the crypto configuration of the partition.
Only for state=attached: The number of crypto adapters the partition needs to have attached. The special value -1 means all adapters of the desired crypto type in the CPC. The adapter_names and adapter_count parameters are mutually exclusive; if neither is specified the default for adapter_count applies.
Only for state=attached: The number of crypto adapters the partition needs to have attached. The special value -1 means all adapters of the desired crypto type in the CPC. The adapter_names and adapter_count parameters are mutually exclusive and one of them must be specified.
Only for state=attached: The names of the crypto adapters the partition needs to have attached. The adapter_names and adapter_count parameters are mutually exclusive; if neither is specified the default for adapter_count applies.
Only for state=attached: The crypto type of the crypto adapters that will be selected from when adapter_count is specified. Ignored when adapter_names is specified.
Only for state=attached: The names of the crypto adapters the partition needs to have attached. The adapter_names and adapter_count parameters are mutually exclusive and one of them must be specified.
Only for state=attached: The crypto type of the crypto adapters that will be considered for attaching.
File path of a log file to which the logic flow of this module as well as interactions with the HMC are logged. If null, logging will be propagated to the Python root logger.
Additional properties of the adapter, as described in the data model of the ‘Adapter’ object in the HMC API book. The property names have hyphens (-) as described in that book.
+Additional properties of the adapter, as described in the data model of the ‘Adapter’ object in the :term:`HMC API` book. The property names have hyphens (-) as described in that book.
+The hostname or IP address of the HMC.
+The hostnames or IP addresses of a single HMC or of a list of redundant HMCs. A single HMC can be specified as a string type or as an HMC list with one item. An HMC list can be specified as a list type or as a string type containing a Python list representation.
+The first available HMC of a list of redundant HMCs is used for the entire execution of the module.
The authentication credentials for the HMC.
@@ -269,7 +274,7 @@HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in zhmc_session – Manage HMC sessions across tasks.
HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in :ref:`zhmc_session_module`.
The desired state for the HBA. All states are fully idempotent within the limits of the properties that can be changed:
-absent: Ensures that the HBA does not exist in the specified partition.
present: Ensures that the HBA exists in the specified partition and has the specified properties.
* absent: Ensures that the HBA does not exist in the specified partition.
* present: Ensures that the HBA exists in the specified partition and has the specified properties.
Dictionary with input properties for the HBA, for state=present. Key is the property name with underscores instead of hyphens, and value is the property value in YAML syntax. Integer properties may also be provided as decimal strings. Will be ignored for state=absent.
The possible input properties in this dictionary are the properties defined as writeable in the data model for HBA resources (where the property names contain underscores instead of hyphens), with the following exceptions:
-name: Cannot be specified because the name has already been specified in the name module parameter.
adapter_port_uri: Cannot be specified because this information is specified using the artificial properties adapter_name and adapter_port.
adapter_name: The name of the adapter that has the port backing the target HBA. Cannot be changed after the HBA exists.
adapter_port: The port index of the adapter port backing the target HBA. Cannot be changed after the HBA exists.
* name: Cannot be specified because the name has already been specified in the name module parameter.
* adapter_port_uri: Cannot be specified because this information is specified using the artificial properties adapter_name and adapter_port.
* adapter_name: The name of the adapter that has the port backing the target HBA. Cannot be changed after the HBA exists.
* adapter_port: The port index of the adapter port backing the target HBA. Cannot be changed after the HBA exists.
Properties omitted in this dictionary will remain unchanged when the HBA already exists, and will get the default value defined in the data model for HBAs when the HBA is being created.
Additional properties of the HBA, as described in the data model of the ‘HBA’ element object of the ‘Partition’ object in the HMC API book. The property names have hyphens (-) as described in that book.
+Additional properties of the HBA, as described in the data model of the ‘HBA’ element object of the ‘Partition’ object in the :term:`HMC API` book. The property names have hyphens (-) as described in that book.
+Gather facts about an LDAP Server Definition on an HMC of a Z system.
Create, delete, or update an LDAP Server Definition on an HMC.
The HMC userid must have these task permissions: ‘Manage LDAP Server Definitions’.
The hostnames or IP addresses of a single HMC or of a list of redundant HMCs. A single HMC can be specified as a string type or as an HMC list with one item. An HMC list can be specified as a list type or as a string type containing a Python list representation.
+The first available HMC of a list of redundant HMCs is used for the entire execution of the module.
+The authentication credentials for the HMC.
+The userid (username) for authenticating with the HMC. This is mutually exclusive with providing session_id.
The password for authenticating with the HMC. This is mutually exclusive with providing session_id.
HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in :ref:`zhmc_session_module`.
Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the ‘REQUESTS_CA_BUNDLE’ environment variable or the path name in the ‘CURL_CA_BUNDLE’ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the ‘certifi’ Python package are used for verifying the HMC certificate.
+If True (default), verify the HMC certificate as specified in the ca_certs parameter. If False, ignore what is specified in the ca_certs parameter and do not verify the HMC certificate.
The name of the target LDAP Server Definition object.
+The name is case-insensitive (but case-preserving).
+The desired state for the LDAP Server Definition. All states are fully idempotent within the limits of the properties that can be changed:
+* absent: Ensures that the LDAP Server Definition does not exist.
* present: Ensures that the LDAP Server Definition exists and has the specified properties.
* facts: Returns the LDAP Server Definition properties.
Dictionary with desired properties for the LDAP Server Definition. Used for state=present; ignored for state=absent|facts. Dictionary key is the property name with underscores instead of hyphens, and dictionary value is the property value in YAML syntax. Integer properties may also be provided as decimal strings.
The possible input properties in this dictionary are the properties defined as writeable in the data model for LDAP Server Definition resources (where the property names contain underscores instead of hyphens), with the following exceptions:
+* name: Cannot be specified because the name has already been specified in the name module parameter.
Properties omitted in this dictionary will remain unchanged when the LDAP Server Definition already exists, and will get the default value defined in the data model for LDAP Server Definitions in the :term:`HMC API` when the LDAP Server Definition is being created.
+File path of a log file to which the logic flow of this module as well as interactions with the HMC are logged. If null, logging will be propagated to the Python root logger.
+---
+# Note: The following examples assume that some variables named 'my_*' are set.
+
+- name: Gather facts about an LDAP Server Definition
+ zhmc_ldap_server_definition:
+ hmc_host: "{{ my_hmc_host }}"
+ hmc_auth: "{{ my_hmc_auth }}"
+ name: "{{ my_lsd_name }}"
+ state: facts
+ register: lsd1
+
+- name: Ensure the LDAP Server Definition does not exist
+ zhmc_ldap_server_definition:
+ hmc_host: "{{ my_hmc_host }}"
+ hmc_auth: "{{ my_hmc_auth }}"
+ name: "{{ my_lsd_name }}"
+ state: absent
+
+- name: Ensure the LDAP Server Definition exists
+ zhmc_ldap_server_definition:
+ hmc_host: "{{ my_hmc_host }}"
+ hmc_auth: "{{ my_hmc_auth }}"
+ name: "{{ my_lsd_name }}"
+ state: present
+ properties:
+ description: "Example LDAP Server Definition 1"
+ primary_hostname_ipaddr: "10.11.12.13"
+ search_distinguished_name: "test_user{0}"
+ register: lsd1
+Indicates if any change has been made by the module. For state=facts, always will be false.
An error message that describes the failure.
+For state=absent, an empty dictionary.
For state=present|facts, a dictionary with the resource properties of the target LDAP Server Definition.
++++{ + "backup-hostname-ipaddr": null, + "bind-distinguished-name": null, + "class": "ldap-server-definition", + "connection-port": null, + "description": "zhmc test LSD 1", + "element-id": "dcb6d966-465f-11ee-80ca-00106f234c71", + "element-uri": "/api/console/ldap-server-definitions/dcb6d966-465f-11ee-80ca-00106f234c71", + "location-method": "pattern", + "name": "zhmc_test_lsd_1", + "parent": "/api/console", + "primary-hostname-ipaddr": "10.11.12.13", + "replication-overwrite-possible": false, + "search-distinguished-name": "test_user{0}", + "search-filter": null, + "search-scope": null, + "tolerate-untrusted-certificates": null, + "use-ssl": false +} +
LDAP Server Definition name
+Additional properties of the LDAP Server Definition, as described in the data model of the ‘LDAP Server Definition’ object in the :term:`HMC API` book. The property names have hyphens (-) as described in that book.
+The HMC userid must have object-access permission to the target LDAP Server Definitions, or task permission to the ‘Manage Users’ task.
The hostnames or IP addresses of a single HMC or of a list of redundant HMCs. A single HMC can be specified as a string type or as an HMC list with one item. An HMC list can be specified as a list type or as a string type containing a Python list representation.
+The first available HMC of a list of redundant HMCs is used for the entire execution of the module.
+The authentication credentials for the HMC.
+The userid (username) for authenticating with the HMC. This is mutually exclusive with providing session_id.
The password for authenticating with the HMC. This is mutually exclusive with providing session_id.
HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in :ref:`zhmc_session_module`.
Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the ‘REQUESTS_CA_BUNDLE’ environment variable or the path name in the ‘CURL_CA_BUNDLE’ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the ‘certifi’ Python package are used for verifying the HMC certificate.
+If True (default), verify the HMC certificate as specified in the ca_certs parameter. If False, ignore what is specified in the ca_certs parameter and do not verify the HMC certificate.
File path of a log file to which the logic flow of this module as well as interactions with the HMC are logged. If null, logging will be propagated to the Python root logger.
+---
+# Note: The following examples assume that some variables named 'my_*' are set.
+
+- name: List LDAP Server Definitions
+ zhmc_ldap_server_definition_list:
+ hmc_host: "{{ my_hmc_host }}"
+ hmc_auth: "{{ my_hmc_auth }}"
+ register: lsd_list
+Indicates if any change has been made by the module. This will always be false.
+An error message that describes the failure.
+The list of LDAP Server Definitions, with a subset of their properties.
+++++[ + { + "name": "Standard" + }, + { + "name": "User 1" + } +] +
User name
+The hostname or IP address of the HMC.
+The hostnames or IP addresses of a single HMC or of a list of redundant HMCs. A single HMC can be specified as a string type or as an HMC list with one item. An HMC list can be specified as a list type or as a string type containing a Python list representation.
+The first available HMC of a list of redundant HMCs is used for the entire execution of the module.
The authentication credentials for the HMC.
@@ -273,7 +278,7 @@HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in zhmc_session – Manage HMC sessions across tasks.
HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in :ref:`zhmc_session_module`.
The desired state for the LPAR:
-inactive: Ensures that the LPAR is inactive (i.e. status ‘not-activated’), unless the LPAR is currently operating and the force parameter was not set to True. Properties cannot be updated. The LPAR is deactivated if needed.
reset_clear: Initialize the LPAR for loading by performing a ‘Reset Clear’ operation (clearing its pending interruptions, resetting its channel subsystem, resetting its processors, clearing its memory), unless the LPAR is currently loaded (i.e. status is ‘operating’ or ‘acceptable’) and the force parameter was not set to True. Properties cannot be updated. After successful execution of the ‘Reset Normal’ operation, the LPAR will be inactive (i.e. status ‘not-activated’).
reset_normal: Initialize the LPAR for loading by performing a ‘Reset Normal’ operation (clearing its pending interruptions, resetting its channel subsystem, resetting its processors), unless the LPAR is currently loaded (i.e. status is ‘operating’ or ‘acceptable’) and the force parameter was not set to True. Properties cannot be updated. After successful execution of the ‘Reset Normal’ operation, the LPAR will be inactive (i.e. status ‘not-activated’).
active: Ensures that the LPAR is at least active (i.e. status is ‘not-operating’, ‘operating’ or ‘acceptable’), and then ensures that the LPAR properties have the specified values. The LPAR is activated if needed. If auto-load is set in the activation profile, the LPAR will also be loaded.
loaded: Ensures that the LPAR is loaded (i.e. status is ‘operating’ or ‘acceptable’), and then ensures that the LPAR properties have the specified values. The LPAR is first activated if needed, and then loaded if needed.
set: Ensures that the LPAR properties have the specified values. Requires that the LPAR is at least active (i.e. status is ‘not-operating’, ‘operating’ or ‘acceptable’) but does not activate the LPAR if that is not the case.
facts: Returns the current LPAR properties.
* inactive: Ensures that the LPAR is inactive (i.e. status ‘not-activated’), unless the LPAR is currently operating and the force parameter was not set to True. Properties cannot be updated. The LPAR is deactivated if needed.
* active: Ensures that the LPAR is at least active (i.e. status is ‘not-operating’, ‘operating’ or ‘exceptions’), and then ensures that the LPAR properties have the specified values. The LPAR is activated if needed using the ‘Activate Logical Partition’ operation. In certain cases, that operation will automatically load the LPAR. For details, see the activation_profile_name parameter.
* loaded: Ensures that the LPAR is loaded (i.e. status is ‘operating’ or ‘exceptions’), and then ensures that the LPAR properties have the specified values. The LPAR is first activated if needed using the ‘Activate Logical Partition’ operation, and then loaded if needed using the ‘Load Logical Partition’ operation. For details, see the activation_profile_name parameter.
* reset_clear: Performs the ‘Reset Clear’ HMC operation on the LPAR. This initializes the LPAR for loading by clearing its pending interruptions, resetting its channel subsystem, resetting its processors, and clearing its memory). The LPAR must be in status ‘not-operating’, ‘operating’, or ‘exceptions’. If the LPAR status is ‘operating’ or ‘exceptions’, the operation will fail unless the force parameter is set to True. Properties cannot be updated.
* reset_normal: Performs the ‘Reset Normal’ HMC operation on the LPAR. This initializes the LPAR for loading by clearing its pending interruptions, resetting its channel subsystem, and resetting its processors). It does not clear the memory. The LPAR must be in status ‘not-operating’, ‘operating’, or ‘exceptions’. If the LPAR status is ‘operating’ or ‘exceptions’, the operation will fail unless the force parameter is set to True. Properties cannot be updated.
* set: Ensures that the LPAR properties have the specified values. Requires that the LPAR is at least active (i.e. status is ‘not-operating’, ‘operating’ or ‘exceptions’) but does not activate the LPAR if that is not the case.
* facts: Returns the current LPAR properties.
In all cases, the LPAR must exist.
Limits the returned properties of the LPAR to those specified in this parameter plus those specified in the properties parameter.
The properties can be specified with underscores or hyphens in their names.
+Null indicates not to limit the returned properties in this way.
+This parameter is ignored for state values that cause no properties to be returned.
The specified properties are passed to the ‘Get Logical Partition Properties’ HMC operation using the ‘properties’ query parameter and save time for the HMC to pull together all properties.
+The name of the image or load activation profile to be used when the LPAR needs to be activated, for state=active and state=loaded.
This parameter is not allowed for the other state values.
Default: The image or load activation profile specified in the ‘next-activation-profile-name’ property of the LPAR is used when the LPAR needs to be activated.
-If the LPAR was already active, the force parameter determines what happens.
For LPARs with activation modes other than SSC or zAware, the following applies: If an image activation profile is specified, the ‘load-at-activation’ property of the image activation profile determines whether an automatic load is performed, using the load parameters from the image activation profile. If a load activation profile is specified, an automatic load is always performed, using the parameters from the load activation profile.
+For LPARs with activation modes SSC or zAware, the following applies: A load activation profile cannot be specified. The LPAR is always auto-loaded using internal load parameters (ignoring the ‘load-at-activation’ property and the load-related properties of their image activation profile).
+The hexadecimal address of an I/O device that provides access to the control program to be loaded, for state=loaded.
This parameter is not allowed for the other state values.
This parameter is used only when the LPAR is explicitly loaded using the ‘Load Logical Partition’ operation. It is not used when the LPAR is automatically loaded during the ‘Activate Logical Partition’ operation.
+For z13 and older generations, this parameter is required. Starting with z14, this parameter is optional and defaults to the load address specified in the ‘last-used-load-address’ property of the LPAR.
+A parameter string that is passed to the control program when loading it, for state=loaded.
This parameter is not allowed for the other state values.
This parameter is used only when the LPAR is explicitly loaded using the ‘Load Logical Partition’ operation. It is not used when the LPAR is automatically loaded during the ‘Activate Logical Partition’ operation.
Controls whether operations that change the LPAR status are performed when the LPAR is currently loaded (i.e. status ‘operating’ or ‘acceptable’):
+Controls whether memory is cleared before performing the load, for state=loaded.
This parameter is not allowed for the other state values.
This parameter is used only when the LPAR is explicitly loaded using the ‘Load Logical Partition’ operation. It is not used when the LPAR is automatically loaded during the ‘Activate Logical Partition’ operation.
+Controls whether the current values of CPU timer, clock comparator, program status word, and the contents of the processor registers are stored to their assigned absolute storage locations, for state=loaded.
This parameter is not allowed for the other state values.
This parameter is used only when the LPAR is explicitly loaded using the ‘Load Logical Partition’ operation. It is not used when the LPAR is automatically loaded during the ‘Activate Logical Partition’ operation.
+Timeout in seconds, for activate (if needed) and for load (if needed).
+Controls whether operations that change the LPAR status are performed when the LPAR is currently loaded (i.e. status ‘operating’ or ‘exceptions’):
If True, such operations are performed regardless of the current LPAR status.
-If False, such operations are performed only if the LPAR is not currently loaded, and are rejected otherwise.
+If False (default), such operations are performed only if the LPAR is not currently loaded, and are rejected otherwise.
The resource properties of the LPAR, after any specified updates have been applied.
-Note that the returned properties may show different values than the ones that were specified as input for the update. For example, memory properties may be rounded up, hexadecimal strings may be shown with a different representation format, and other properties may change as a result of updating some properties. For details, see the data model of the ‘Logical Partition’ object in the HMC API book.
+For state=inactive|reset_clear|reset_normal, an empty dictionary.
For state=active|loaded|set|facts, the resource properties of the LPAR after after any specified updates have been applied.
Note that the returned properties may show different values than the ones that were specified as input for the update. For example, memory properties may be rounded up, hexadecimal strings may be shown with a different representation format, and other properties may change as a result of updating some properties. For details, see the data model of the ‘Logical Partition’ object in the :term:`HMC API` book.
Additional properties of the LPAR, as described in the data model of the ‘Logical Partition’ object in the HMC API book. The property names have hyphens (-) as described in that book.
+Additional properties of the LPAR, as described in the data model of the ‘Logical Partition’ object in the :term:`HMC API` book. The property names have hyphens (-) as described in that book.
+The hostname or IP address of the HMC.
+The hostnames or IP addresses of a single HMC or of a list of redundant HMCs. A single HMC can be specified as a string type or as an HMC list with one item. An HMC list can be specified as a list type or as a string type containing a Python list representation.
+The first available HMC of a list of redundant HMCs is used for the entire execution of the module.
The authentication credentials for the HMC.
@@ -269,7 +274,7 @@HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in zhmc_session – Manage HMC sessions across tasks.
HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in :ref:`zhmc_session_module`.
List of additional properties to be returned for each LPAR, in addition to the default properties (see result description).
+Mutually exclusive with full_properties.
The property names are specified with underscores instead of hyphens.
+On HMCs with an API version below 4.10 (= HMC version 2.16.0 plus some post-GA updates), all properties of each LPAR will be returned if this parameter is specified, but you should not rely on that.
+If True, all properties of each LPAR will be returned. Default: False.
+Mutually exclusive with additional_properties.
Note: Setting this to True causes a loop of ‘Get Logical Partition Properties’ operations to be executed. It is preferable from a performance perspective to use the additional_properties parameter instead.
File path of a log file to which the logic flow of this module as well as interactions with the HMC are logged. If null, logging will be propagated to the Python root logger.
The current status of the LPAR. For details, see the description of the ‘status’ property in the data model of the ‘Logical Partition’ resource (see HMC API).
+The current status of the LPAR. For details, see the description of the ‘status’ property in the data model of the ‘Logical Partition’ resource (see :term:`HMC API`).
The activation mode of the LPAR. For details, see the description of the ‘activation-mode’ property in the data model of the ‘Logical Partition’ resource (see HMC API).
+The activation mode of the LPAR. For details, see the description of the ‘activation-mode’ property in the data model of the ‘Logical Partition’ resource (see :term:`HMC API`).
Additional properties requested via full_properties or additional_properties. The property names will have underscores instead of hyphens.
The targeted CPC must be in the classic operational mode.
The targeted LPAR must be loaded (i.e. running an operating system).
The HMC userid must have these task permissions: ‘Operating System Messages’ (view-only is sufficient)
The HMC userid must have object-access permissions to these objects: Target CPC, target LPAR.
The hostnames or IP addresses of a single HMC or of a list of redundant HMCs. A single HMC can be specified as a string type or as an HMC list with one item. An HMC list can be specified as a list type or as a string type containing a Python list representation.
+The first available HMC of a list of redundant HMCs is used for the entire execution of the module.
+The authentication credentials for the HMC.
+The userid (username) for authenticating with the HMC. This is mutually exclusive with providing session_id.
The password for authenticating with the HMC. This is mutually exclusive with providing session_id.
HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in :ref:`zhmc_session_module`.
Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the ‘REQUESTS_CA_BUNDLE’ environment variable or the path name in the ‘CURL_CA_BUNDLE’ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the ‘certifi’ Python package are used for verifying the HMC certificate.
+If True (default), verify the HMC certificate as specified in the ca_certs parameter. If False, ignore what is specified in the ca_certs parameter and do not verify the HMC certificate.
The name of the CPC with the target LPAR.
+The name of the target LPAR.
+A message sequence number to limit returned messages. Messages with a sequence number less than this are omitted from the results.
+If null, no such filtering is performed.
+A message sequence number to limit returned messages. Messages with a sequence number greater than this are omitted from the results.
+If null, no such filtering is performed.
+Limits the returned messages to the specified maximum number, starting from the begin of the sequence numbers in the result that would otherwise be returned.
+If null or 0, no such filtering is performed.
+Limit the returned messages to only held (if true) or only non-held (if false) messages.
+If null, no such filtering is performed.
+Limit the returned messages to only priority (if true) or only non-priority (if false) messages.
+If null, no such filtering is performed.
+File path of a log file to which the logic flow of this module as well as interactions with the HMC are logged. If null, logging will be propagated to the Python root logger.
+---
+# Note: The following examples assume that some variables named 'my_*' are set.
+
+- name: Get OS console messages for the OS in the LPAR
+ zhmc_lpar_messages:
+ hmc_host: "{{ my_hmc_host }}"
+ hmc_auth: "{{ my_hmc_auth }}"
+ cpc_name: "{{ my_cpc_name }}"
+ name: "{{ my_lpar_name }}"
+ register: lpar_messages
+Indicates if any change has been made by the module. This will always be false.
+An error message that describes the failure.
+The list of operating system console messages.
+++++[ + { + "is_held": false, + "is_priority": false, + "message_id": 2328551, + "message_text": "Uncompressing Linux... ", + "os_name": null, + "prompt_text": "", + "sequence_number": 0, + "sound_alarm": false, + "timestamp": null + }, + { + "is_held": false, + "is_priority": false, + "message_id": 2328552, + "message_text": "Ok, booting the kernel. ", + "os_name": null, + "prompt_text": "", + "sequence_number": 1, + "sound_alarm": false, + "timestamp": null + } +] +
The sequence number assigned to this message by the HMC.
+Although sequence numbers may wrap over time, this number can be considered a unique identifier for the message.
+The text of the message
+The message identifier assigned to this message by the operating system.
+The point in time (as an ISO 8601 date and time value) when the message was created, or null if this information is not available from the operating system.
+Indicates whether the message should cause the alarm to be sounded.
+Indicates whether the message is a priority message.
+A priority message indicates a critical condition that requires immediate attention.
+Indicates whether the message is a held message.
+A held message is one that requires a response.
+The prompt text that is associated with this message, or null indicating that there is no prompt text for this message.
+The prompt text is used when responding to a message. The response is to be sent as an operating system command where the command is prefixed with the prompt text and followed by the response to the message.
+The name of the operating system that generated this omessage, or null indicating there is no operating system name associated with this message.
+This name is determined by the operating system and may be unrelated to the name of the LPAR in which the operating system is running.
+The hostname or IP address of the HMC.
+The hostnames or IP addresses of a single HMC or of a list of redundant HMCs. A single HMC can be specified as a string type or as an HMC list with one item. An HMC list can be specified as a list type or as a string type containing a Python list representation.
+The first available HMC of a list of redundant HMCs is used for the entire execution of the module.
The authentication credentials for the HMC.
@@ -270,7 +275,7 @@HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in zhmc_session – Manage HMC sessions across tasks.
HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in :ref:`zhmc_session_module`.
The desired state for the NIC. All states are fully idempotent within the limits of the properties that can be changed:
-absent: Ensures that the NIC does not exist in the specified partition.
present: Ensures that the NIC exists in the specified partition and has the specified properties.
facts: Returns the NIC properties.
* absent: Ensures that the NIC does not exist in the specified partition.
* present: Ensures that the NIC exists in the specified partition and has the specified properties.
* facts: Returns the NIC properties.
Dictionary with input properties for the NIC, for state=present. Key is the property name with underscores instead of hyphens, and value is the property value in YAML syntax. Integer properties may also be provided as decimal strings. Will be ignored for state=absent.
The possible input properties in this dictionary are the properties defined as writeable in the data model for NIC resources (where the property names contain underscores instead of hyphens), with the following exceptions:
-name: Cannot be specified because the name has already been specified in the name module parameter.
network_adapter_port_uri and virtual_switch_uri: Cannot be specified because this information is specified using the artificial properties adapter_name and adapter_port.
adapter_name: The name of the adapter that has the port backing the target NIC. Used for all adapter families (ROCE, OSA, Hipersockets).
adapter_port: The port index of the adapter port backing the target NIC. Used for all adapter families (ROCE, OSA, Hipersockets).
* name: Cannot be specified because the name has already been specified in the name module parameter.
* network_adapter_port_uri and virtual_switch_uri: Cannot be specified because this information is specified using the artificial properties adapter_name and adapter_port.
* adapter_name: The name of the adapter that has the port backing the target NIC. Used for all adapter families (ROCE, OSA, Hipersockets).
* adapter_port: The port index of the adapter port backing the target NIC. Used for all adapter families (ROCE, OSA, Hipersockets).
Properties omitted in this dictionary will remain unchanged when the NIC already exists, and will get the default value defined in the data model for NICs when the NIC is being created.
Additional properties of the NIC, as described in the data model of the ‘NIC’ element object of the ‘Partition’ object in the HMC API book. The property names have hyphens (-) as described in that book.
+Additional properties of the NIC, as described in the data model of the ‘NIC’ element object of the ‘Partition’ object in the :term:`HMC API` book. The property names have hyphens (-) as described in that book.
+The hostname or IP address of the HMC.
+The hostnames or IP addresses of a single HMC or of a list of redundant HMCs. A single HMC can be specified as a string type or as an HMC list with one item. An HMC list can be specified as a list type or as a string type containing a Python list representation.
+The first available HMC of a list of redundant HMCs is used for the entire execution of the module.
The authentication credentials for the HMC.
@@ -268,7 +273,7 @@HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in zhmc_session – Manage HMC sessions across tasks.
HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in :ref:`zhmc_session_module`.
If True, all properties of each NIC will be returned. Default: False.
+Note: Setting this to True causes a loop of ‘Get NIC Properties’ operations to be executed.
+File path of a log file to which the logic flow of this module as well as interactions with the HMC are logged. If null, logging will be propagated to the Python root logger.
Additional properties requested via full_properties. The property names will have underscores instead of hyphens.
The hostname or IP address of the HMC.
+The hostnames or IP addresses of a single HMC or of a list of redundant HMCs. A single HMC can be specified as a string type or as an HMC list with one item. An HMC list can be specified as a list type or as a string type containing a Python list representation.
+The first available HMC of a list of redundant HMCs is used for the entire execution of the module.
The authentication credentials for the HMC.
@@ -272,7 +277,7 @@HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in zhmc_session – Manage HMC sessions across tasks.
HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in :ref:`zhmc_session_module`.
The desired state for the partition. All states are fully idempotent within the limits of the properties that can be changed:
-absent: Ensures that the partition does not exist in the specified CPC.
stopped: Ensures that the partition exists in the specified CPC, has the specified properties, and is in one of the inactive statuses (‘stopped’, ‘terminated’, ‘paused’, ‘reservation-error’).
active: Ensures that the partition exists in the specified CPC, has the specified properties, and is in one of the active statuses (‘active’, ‘degraded’).
facts: Returns the partition properties and the properties of its child resources (HBAs, NICs, and virtual functions).
* absent: Ensures that the partition does not exist in the specified CPC.
* stopped: Ensures that the partition exists in the specified CPC, has the specified properties, and is in one of the inactive statuses (‘stopped’, ‘terminated’, ‘paused’, ‘reservation-error’).
* active: Ensures that the partition exists in the specified CPC, has the specified properties, and is in one of the active statuses (‘active’, ‘degraded’).
* mount_iso: Ensures that an ISO image with the specified name is mounted to the partition, and that the specified INS file is set. The content of a currnetly mounted ISO image is not verified.
* unmount_iso: Ensures that no ISO image is mounted to the partition.
* facts: Returns the partition properties and the properties of its child resources (HBAs, NICs, and virtual functions).
Limits the returned properties of the partition to those specified in this parameter plus those specified in the properties parameter.
The properties can be specified with underscores or hyphens in their names.
+Null indicates not to limit the returned properties in this way.
+This parameter is ignored for state values that cause no properties to be returned.
The specified properties are passed to the ‘Get Partition Properties’ HMC operation using the ‘properties’ query parameter and save time for the HMC to pull together all properties.
+Dictionary with input properties for the partition, for state=stopped and state=active. Key is the property name with underscores instead of hyphens, and value is the property value in YAML syntax. Integer properties may also be provided as decimal strings. Will be ignored for state=absent.
The possible input properties in this dictionary are the properties defined as writeable in the data model for Partition resources (where the property names contain underscores instead of hyphens), with the following exceptions:
-name: Cannot be specified because the name has already been specified in the name module parameter.
type: Cannot be changed once the partition exists, because updating it is not supported.
boot_storage_device: Cannot be specified because this information is specified using the artificial property boot_storage_hba_name.
boot_network_device: Cannot be specified because this information is specified using the artificial property boot_network_nic_name.
boot_storage_hba_name: The name of the HBA whose URI is used to construct boot_storage_device. Specifying it requires that the partition exists.
boot_network_nic_name: The name of the NIC whose URI is used to construct boot_network_device. Specifying it requires that the partition exists.
crypto_configuration: The crypto configuration for the partition, in the format of the crypto-configuration property of the partition (see HMC API for details), with the exception that adapters are specified with their names in field crypto_adapter_names instead of their URIs in field crypto_adapter_uris. If the crypto_adapter_names field is null, all crypto adapters of the CPC will be used.
Properties omitted in this dictionary will remain unchanged when the partition already exists, and will get the default value defined in the data model for partitions in the HMC API when the partition is being created.
+* name: Cannot be specified because the name has already been specified in the name module parameter.
* type: Cannot be changed once the partition exists, because updating it is not supported.
* boot_storage_device: Cannot be specified because this information is specified using the artificial property boot_storage_hba_name.
* boot_network_device: Cannot be specified because this information is specified using the artificial property boot_network_nic_name.
* boot_storage_hba_name: The name of the HBA whose URI is used to construct boot_storage_device. Specifying it requires that the partition exists. Only valid when the partition is on a z13.
* boot_storage_group_name: The name of the storage group that contains the boot volume specified with boot_storage_volume_name.
* boot_storage_volume_name: The name of the storage volume in storage group boot_storage_group_name whose URI is used to construct boot_storage_volume. This property is mutually exclusive with boot_storage_volume. Specifying it requires that the partition and storage group exist. Only valid when the partition is on a z14 or later.
* boot_network_nic_name: The name of the NIC whose URI is used to construct boot_network_device. Specifying it requires that the partition exists.
* crypto_configuration: The crypto configuration for the partition, in the format of the crypto-configuration property of the partition (see :term:`HMC API` for details), with the exception that adapters are specified with their names in field crypto_adapter_names instead of their URIs in field crypto_adapter_uris. If the crypto_adapter_names field is null, all crypto adapters of the CPC will be used.
Properties omitted in this dictionary will remain unchanged when the partition already exists, and will get the default value defined in the data model for partitions in the :term:`HMC API` when the partition is being created.
Name of the ISO image for state=iso_mount (required). Not permitted for any other state values.
This value is shown in the ‘boot-iso-image-name’ property of the partition.
+If an ISO image with this name is already mounted to the partition, the new image will not be mounted. The image conntent is not verified.
+Path name of the local ISO image file for state=iso_mount (required). Not permitted for any other state values.
When mounting an ISO image, this file is opened for reading and its content is sent to the HMC using the ‘Mount ISO Image’ operation. This file is not used when an image with the name specified in image_name was already mounted.
Path name of the INS file within the ISO image that will be used when booting from the ISO image for state=iso_mount (required). Not permitted for any other state values.
This value is shown in the ‘boot-iso-ins-file’ property of the partition.
+The ‘boot-iso-ins-file’ property of the partition is always updated, even when the ISO image was already mounted and thus is not re-mounted.
+Boolean that controls whether the returned partition contains an additional artificial property ‘storage-groups’ that is the list of storage groups attached to the partition, with properties as described for the zhmc_storage_group module with expand=true.
---
# Note: The following examples assume that some variables named 'my_*' are set.
-# Because configuring LUN masking in the SAN requires the host WWPN, and the
-# host WWPN is automatically assigned and will be known only after an HBA has
-# been added to the partition, the partition needs to be created in stopped
-# state. Also, because the HBA has not yet been created, the boot
-# configuration cannot be done yet:
- name: Ensure the partition exists and is stopped
zhmc_partition:
hmc_host: "{{ my_hmc_host }}"
@@ -379,11 +413,20 @@ Examplesmaximum_memory: 1024
register: part1
-# After an HBA has been added (see Ansible module zhmc_hba), and LUN masking
-# has been configured in the SAN, and a bootable image is available at the
-# configured LUN and target WWPN, the partition can be configured for boot
-# from the FCP LUN and can be started:
-- name: Configure boot device and start the partition
+- name: Configure an FCP boot volume and start the partition (z14 or later)
+ zhmc_partition:
+ hmc_host: "{{ my_hmc_host }}"
+ hmc_auth: "{{ my_hmc_auth }}"
+ cpc_name: "{{ my_cpc_name }}"
+ name: "{{ my_partition_name }}"
+ state: active
+ properties:
+ boot_device: storage-volume
+ boot_storage_group_name: sg1
+ boot_storage_volume_name: boot1
+ register: part1
+
+- name: Configure an FTP boot server and start the partition
zhmc_partition:
hmc_host: "{{ my_hmc_host }}"
hmc_auth: "{{ my_hmc_auth }}"
@@ -391,10 +434,11 @@ Examplesname: "{{ my_partition_name }}"
state: active
properties:
- boot_device: storage-adapter
- boot_storage_device_hba_name: hba1
- boot_logical_unit_number: 00000000001
- boot_world_wide_port_name: abcdefabcdef
+ boot_device: ftp
+ boot_ftp_host: 10.11.12.13
+ boot_ftp_username: ftpuser
+ boot_ftp_password: ftppass
+ boot_ftp_insfile: /insfile
register: part1
- name: Ensure the partition does not exist
@@ -424,6 +468,25 @@ Examplesaccess_mode: control
register: part1
+- name: Ensure that an ISO image is mounted to the partition
+ zhmc_partition:
+ hmc_host: "{{ my_hmc_host }}"
+ hmc_auth: "{{ my_hmc_auth }}"
+ cpc_name: "{{ my_cpc_name }}"
+ name: "{{ my_partition_name }}"
+ image_name: "{{ my_image_name }}"
+ image_file: "{{ my_image_file }}"
+ ins_file: "{{ my_ins_file }}"
+ state: iso_mount
+
+- name: Ensure that no ISO image is mounted to the partition
+ zhmc_partition:
+ hmc_host: "{{ my_hmc_host }}"
+ hmc_auth: "{{ my_hmc_auth }}"
+ cpc_name: "{{ my_cpc_name }}"
+ name: "{{ my_partition_name }}"
+ state: iso_unmount
+
- name: Gather facts about a partition
zhmc_partition:
hmc_host: "{{ my_hmc_host }}"
@@ -464,7 +527,7 @@ Return Valuestype: str
For state=absent, an empty dictionary.
For state=absent|iso_mount|iso_unmount, an empty dictionary.
For state=stopped|active|facts, the resource properties of the partition after any changes, including its child resources as described below.
Additional properties of the partition, as described in the data model of the ‘Partition’ object in the HMC API book. The property names have hyphens (-) as described in that book.
+Additional properties of the partition, as described in the data model of the ‘Partition’ object in the :term:`HMC API` book. The property names have hyphens (-) as described in that book.
+HBAs of the partition. If the CPC does not have the storage-management feature enabled (ie. before z15), the list is empty.
+HBAs of the partition. If the CPC does not have the storage-management feature enabled (ie. on z13), the list is empty.
Additional properties of the HBA, as described in the data model of the ‘HBA’ element object of the ‘Partition’ object in the HMC API book. The property names have hyphens (-) as described in that book.
+Additional properties of the HBA, as described in the data model of the ‘HBA’ element object of the ‘Partition’ object in the :term:`HMC API` book. The property names have hyphens (-) as described in that book.
+Additional properties of the NIC, as described in the data model of the ‘NIC’ element object of the ‘Partition’ object in the HMC API book. The property names have hyphens (-) as described in that book.
+Additional properties of the NIC, as described in the data model of the ‘NIC’ element object of the ‘Partition’ object in the :term:`HMC API` book. The property names have hyphens (-) as described in that book.
+Additional properties of the virtual function, as described in the data model of the ‘Virtual Function’ element object of the ‘Partition’ object in the HMC API book. The property names have hyphens (-) as described in that book.
+Additional properties of the virtual function, as described in the data model of the ‘Virtual Function’ element object of the ‘Partition’ object in the :term:`HMC API` book. The property names have hyphens (-) as described in that book.
+The hostname or IP address of the HMC.
+The hostnames or IP addresses of a single HMC or of a list of redundant HMCs. A single HMC can be specified as a string type or as an HMC list with one item. An HMC list can be specified as a list type or as a string type containing a Python list representation.
+The first available HMC of a list of redundant HMCs is used for the entire execution of the module.
The authentication credentials for the HMC.
@@ -271,7 +276,7 @@HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in zhmc_session – Manage HMC sessions across tasks.
HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in :ref:`zhmc_session_module`.
List of additional properties to be returned for each partition, in addition to the default properties (see result description).
+Mutually exclusive with full_properties.
The property names are specified with underscores instead of hyphens.
+On HMCs with an HMC version below 2.14.0, all properties of each partition will be returned if this parameter is specified, but you should not rely on that.
+If True, all properties of each partition will be returned. Default: False.
+Mutually exclusive with additional_properties.
Note: Setting this to True causes a loop of ‘Get Partition Properties’ operations to be executed. It is preferable from a performance perspective to use the additional_properties parameter instead.
File path of a log file to which the logic flow of this module as well as interactions with the HMC are logged. If null, logging will be propagated to the Python root logger.
The current status of the partition. For details, see the description of the ‘status’ property in the data model of the ‘Logical Partition’ resource (see HMC API).
+The current status of the partition. For details, see the description of the ‘status’ property in the data model of the ‘Logical Partition’ resource (see :term:`HMC API`).
Additional properties requested via full_properties or additional_properties. The property names will have underscores instead of hyphens.
The targeted CPC must be in the DPM operational mode.
The targeted partition must be active (i.e. running an operating system).
The HMC userid must have these task permissions: ‘Operating System Messages’ (view-only is sufficient)
The HMC userid must have object-access permissions to these objects: Target CPC, target partition.
The hostnames or IP addresses of a single HMC or of a list of redundant HMCs. A single HMC can be specified as a string type or as an HMC list with one item. An HMC list can be specified as a list type or as a string type containing a Python list representation.
+The first available HMC of a list of redundant HMCs is used for the entire execution of the module.
+The authentication credentials for the HMC.
+The userid (username) for authenticating with the HMC. This is mutually exclusive with providing session_id.
The password for authenticating with the HMC. This is mutually exclusive with providing session_id.
HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in :ref:`zhmc_session_module`.
Path name of certificate file or certificate directory to be used for verifying the HMC certificate. If null (default), the path name in the ‘REQUESTS_CA_BUNDLE’ environment variable or the path name in the ‘CURL_CA_BUNDLE’ environment variable is used, or if neither of these variables is set, the certificates in the Mozilla CA Certificate List provided by the ‘certifi’ Python package are used for verifying the HMC certificate.
+If True (default), verify the HMC certificate as specified in the ca_certs parameter. If False, ignore what is specified in the ca_certs parameter and do not verify the HMC certificate.
The name of the CPC with the target partition.
+The name of the target partition.
+A message sequence number to limit returned messages. Messages with a sequence number less than this are omitted from the results.
+If null, no such filtering is performed.
+A message sequence number to limit returned messages. Messages with a sequence number greater than this are omitted from the results.
+If null, no such filtering is performed.
+File path of a log file to which the logic flow of this module as well as interactions with the HMC are logged. If null, logging will be propagated to the Python root logger.
+---
+# Note: The following examples assume that some variables named 'my_*' are set.
+
+- name: Get OS console messages for the OS in the partition
+ zhmc_partition_messages:
+ hmc_host: "{{ my_hmc_host }}"
+ hmc_auth: "{{ my_hmc_auth }}"
+ cpc_name: "{{ my_cpc_name }}"
+ name: "{{ my_part_name }}"
+ register: part_messages
+Indicates if any change has been made by the module. This will always be false.
+An error message that describes the failure.
+The list of operating system console messages.
+++++[ + { + "is_held": false, + "is_priority": false, + "message_id": 2328551, + "message_text": "Uncompressing Linux... ", + "os_name": null, + "prompt_text": "", + "sequence_number": 0, + "sound_alarm": false, + "timestamp": null + }, + { + "is_held": false, + "is_priority": false, + "message_id": 2328552, + "message_text": "Ok, booting the kernel. ", + "os_name": null, + "prompt_text": "", + "sequence_number": 1, + "sound_alarm": false, + "timestamp": null + } +] +
The sequence number assigned to this message by the HMC.
+Although sequence numbers may wrap over time, this number can be considered a unique identifier for the message.
+The text of the message
+The message identifier assigned to this message by the operating system.
+The point in time (as an ISO 8601 date and time value) when the message was created, or null if this information is not available from the operating system.
+Indicates whether the message should cause the alarm to be sounded.
+Indicates whether the message is a priority message.
+A priority message indicates a critical condition that requires immediate attention.
+Indicates whether the message is a held message.
+A held message is one that requires a response.
+The prompt text that is associated with this message, or null indicating that there is no prompt text for this message.
+The prompt text is used when responding to a message. The response is to be sent as an operating system command where the command is prefixed with the prompt text and followed by the response to the message.
+The name of the operating system that generated this omessage, or null indicating there is no operating system name associated with this message.
+This name is determined by the operating system and may be unrelated to the name of the partition in which the operating system is running.
+The hostname or IP address of the HMC.
+The hostnames or IP addresses of a single HMC or of a list of redundant HMCs. A single HMC can be specified as a string type or as an HMC list with one item. An HMC list can be specified as a list type or as a string type containing a Python list representation.
+The first available HMC of a list of redundant HMCs is used for the entire execution of the module.
The authentication credentials for the HMC.
@@ -267,7 +272,7 @@HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in zhmc_session – Manage HMC sessions across tasks.
HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in :ref:`zhmc_session_module`.
The desired state for the HMC password rule. All states are fully idempotent within the limits of the properties that can be changed:
-absent: Ensures that the password rule does not exist.
present: Ensures that the password rule exists and has the specified properties.
facts: Returns the password rule properties.
* absent: Ensures that the password rule does not exist.
* present: Ensures that the password rule exists and has the specified properties.
* facts: Returns the password rule properties.
Dictionary with desired properties for the password rule. Used for state=present; ignored for state=absent|facts. Dictionary key is the property name with underscores instead of hyphens, and dictionary value is the property value in YAML syntax. Integer properties may also be provided as decimal strings.
The possible input properties in this dictionary are the properties defined as writeable in the data model for Password Rule resources (where the property names contain underscores instead of hyphens), with the following exceptions:
-name: Cannot be specified because the name has already been specified in the name module parameter.
Properties omitted in this dictionary will remain unchanged when the password rule already exists, and will get the default value defined in the data model for password rules in the HMC API when the password rule is being created.
+* name: Cannot be specified because the name has already been specified in the name module parameter.
Properties omitted in this dictionary will remain unchanged when the password rule already exists, and will get the default value defined in the data model for password rules in the :term:`HMC API` when the password rule is being created.
Additional properties of the password rule, as described in the data model of the ‘Password Rule’ object in the HMC API book. The property names have hyphens (-) as described in that book.
+Additional properties of the password rule, as described in the data model of the ‘Password Rule’ object in the :term:`HMC API` book. The property names have hyphens (-) as described in that book.
+The hostname or IP address of the HMC.
+The hostnames or IP addresses of a single HMC or of a list of redundant HMCs. A single HMC can be specified as a string type or as an HMC list with one item. An HMC list can be specified as a list type or as a string type containing a Python list representation.
+The first available HMC of a list of redundant HMCs is used for the entire execution of the module.
The authentication credentials for the HMC.
@@ -266,7 +271,7 @@HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in zhmc_session – Manage HMC sessions across tasks.
HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in :ref:`zhmc_session_module`.
If True, all properties of each password rule will be returned. Default: False.
+Note: Setting this to True causes a loop of ‘Get Password Rule Properties’ operations to be executed.
+File path of a log file to which the logic flow of this module as well as interactions with the HMC are logged. If null, logging will be propagated to the Python root logger.
Additional properties requested via full_properties. The property names will have underscores instead of hyphens.
The hostname or IP address of the HMC.
+The hostnames or IP addresses of a single HMC or of a list of redundant HMCs. A single HMC can be specified as a string type or as an HMC list with one item. An HMC list can be specified as a list type or as a string type containing a Python list representation.
+The first available HMC of a list of redundant HMCs is used for the entire execution of the module.
The authentication credentials for the HMC.
@@ -287,10 +292,8 @@The action to perform for the HMC session. Since an HMC session does not have a name, it is not possible to specify the desired end state in an idempotent manner, so this module uses actions:
-create: Create a new session on the HMC and verify that the credentials are valid. Requires hmc_auth.userid and hmc_auth.password and uses hmc_auth.ca_certs and hmc_auth.verify if provided.
delete: Delete the specified session on the HMC. No longer existing sessions are tolerated. Requires hmc_auth.session_id.
* create: Create a new session on the HMC and verify that the credentials are valid. Requires hmc_auth.userid and hmc_auth.password and uses hmc_auth.ca_certs and hmc_auth.verify if provided.
* delete: Delete the specified session on the HMC. No longer existing sessions are tolerated. Requires hmc_auth.session_id.
The hostname or IP address of the HMC that was actually used for the session creation, for action=create. This value must be specified as ‘hmc_host’ for action=delete.
For action=delete, returns the null value.
Credentials for the HMC session, for use by other tasks. This return value should be protected with no_log=true for action=create, since it contains the HMC session ID. For action=delete, the same structure is returned, just with null values. This can be used to reset the variable that was set for action=create.
{
"ca_certs": null,
"session_id": "xyz.........",
- "userid": "my_user",
"verify": true
}
The hostname or IP address of the HMC.
+The hostnames or IP addresses of a single HMC or of a list of redundant HMCs. A single HMC can be specified as a string type or as an HMC list with one item. An HMC list can be specified as a list type or as a string type containing a Python list representation.
+The first available HMC of a list of redundant HMCs is used for the entire execution of the module.
The authentication credentials for the HMC.
@@ -271,7 +276,7 @@HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in zhmc_session – Manage HMC sessions across tasks.
HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in :ref:`zhmc_session_module`.
The desired state for the storage group. All states are fully idempotent within the limits of the properties that can be changed, unless otherwise stated:
-absent: Ensures that the storage group does not exist. If the storage group is currently attached to any partitions, the module will fail (this is an idempotency limitation).
present: Ensures that the storage group exists and is associated with the specified CPC, and has the specified properties. The attachment state of an already existing storage group to a partition is not changed.
facts: Returns the storage group properties.
* absent: Ensures that the storage group does not exist. If the storage group is currently attached to any partitions, the module will fail (this is an idempotency limitation).
* present: Ensures that the storage group exists and is associated with the specified CPC, and has the specified properties. The attachment state of an already existing storage group to a partition is not changed.
* discover: Triggers LUN discovery. If discover_wait is specified, waits for completion of the discovery. Requires that the storage group exists and is of type ‘fcp’.
* facts: Returns the storage group properties.
Dictionary with desired properties for the storage group. Used for state=present; ignored for state=absent|facts. Dictionary key is the property name with underscores instead of hyphens, and dictionary value is the property value in YAML syntax. Integer properties may also be provided as decimal strings.
The possible input properties in this dictionary are the properties defined as writeable in the data model for Storage Group resources (where the property names contain underscores instead of hyphens), with the following exceptions:
-name: Cannot be specified because the name has already been specified in the name module parameter.
type: Cannot be changed once the storage group exists.
Properties omitted in this dictionary will remain unchanged when the storage group already exists, and will get the default value defined in the data model for storage groups in the HMC API when the storage group is being created.
+* name: Cannot be specified because the name has already been specified in the name module parameter.
* type: Cannot be changed once the storage group exists.
Properties omitted in this dictionary will remain unchanged when the storage group already exists, and will get the default value defined in the data model for storage groups in the :term:`HMC API` when the storage group is being created.
Boolean that controls whether to wait for completion of the FCP discovery for state=discover.
Timeout in seconds for how long to wait for completion of the FCP discovery for state=discover.
File path of a log file to which the logic flow of this module as well as interactions with the HMC are logged. If null, logging will be propagated to the Python root logger.
For state=absent, an empty dictionary.
For state=present|facts, the resource properties of the target storage group after any changes, plus additional artificial properties as described below.
For state=present|facts|discover, the resource properties of the target storage group after any changes, plus additional artificial properties as described below.
Additional properties of the storage group, as described in the data model of the ‘Storage Group’ object in the HMC API book. The property names have hyphens (-) as described in that book.
+Additional properties of the storage group, as described in the data model of the ‘Storage Group’ object in the :term:`HMC API` book. The property names have hyphens (-) as described in that book.
+Names of the partitions to which the storage group is attached.
Only present if expand=true: List of candidate storage adapter ports of the storage group.
Only present if expand=true: List of candidate storage adapter ports of the storage group. Will be empty for storage group types other than FCP.
Additional properties of the storage port, as described in the data model of the ‘Storage Port’ element object of the ‘Adapter’ object in the HMC API book. The property names have hyphens (-) as described in that book.
+Additional properties of the storage port, as described in the data model of the ‘Storage Port’ element object of the ‘Adapter’ object in the :term:`HMC API` book. The property names have hyphens (-) as described in that book.
+Storage adapter of the candidate port.
Additional properties of the storage adapter, as described in the data model of the ‘Adapter’ object in the HMC API book. The property names have hyphens (-) as described in that book.
+Additional properties of the storage adapter, as described in the data model of the ‘Adapter’ object in the :term:`HMC API` book. The property names have hyphens (-) as described in that book.
+Additional properties of the storage volume, as described in the data model of the ‘Storage Volume’ element object of the ‘Storage Group’ object in the HMC API book. The property names have hyphens (-) as described in that book.
+Additional properties of the storage volume, as described in the data model of the ‘Storage Volume’ element object of the ‘Storage Group’ object in the :term:`HMC API` book. The property names have hyphens (-) as described in that book.
+Only present if expand=true: Virtual storage resources of the storage group.
Only present if expand=true: Virtual storage resources of the storage group. Will be empty for storage group types other than FCP.
Properties of the virtual storage resource, as described in the data model of the ‘Virtual Storage Resource’ element object of the ‘Storage Group’ object in the HMC API book. The property names have hyphens (-) as described in that book.
+Properties of the virtual storage resource, as described in the data model of the ‘Virtual Storage Resource’ element object of the ‘Storage Group’ object in the :term:`HMC API` book. The property names have hyphens (-) as described in that book.
+Properties of the partition, as described in the data model of the ‘Partition’ object in the HMC API book. The property names have hyphens (-) as described in that book.
+Properties of the partition, as described in the data model of the ‘Partition’ object in the :term:`HMC API` book. The property names have hyphens (-) as described in that book.
+The hostname or IP address of the HMC.
+The hostnames or IP addresses of a single HMC or of a list of redundant HMCs. A single HMC can be specified as a string type or as an HMC list with one item. An HMC list can be specified as a list type or as a string type containing a Python list representation.
+The first available HMC of a list of redundant HMCs is used for the entire execution of the module.
The authentication credentials for the HMC.
@@ -271,7 +276,7 @@HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in zhmc_session – Manage HMC sessions across tasks.
HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in :ref:`zhmc_session_module`.
The desired state for the storage group attachment. All states are fully idempotent within the limits of the properties that can be changed, unless otherwise stated:
-detached: Ensures that the storage group is not attached to the partition. If the storage group is currently attached to the partition and the partition is currently active, the module will fail (this is an idempotency limitation).
attached: Ensures that the storage group is attached to the partition.
facts: Returns the attachment status.
* detached: Ensures that the storage group is not attached to the partition. If the storage group is currently attached to the partition and the partition is currently active, the module will fail (this is an idempotency limitation).
* attached: Ensures that the storage group is attached to the partition.
* facts: Returns the attachment status.
The hostname or IP address of the HMC.
+The hostnames or IP addresses of a single HMC or of a list of redundant HMCs. A single HMC can be specified as a string type or as an HMC list with one item. An HMC list can be specified as a list type or as a string type containing a Python list representation.
+The first available HMC of a list of redundant HMCs is used for the entire execution of the module.
The authentication credentials for the HMC.
@@ -271,7 +276,7 @@HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in zhmc_session – Manage HMC sessions across tasks.
HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in :ref:`zhmc_session_module`.
The desired state for the storage volume. All states are fully idempotent within the limits of the properties that can be changed:
-absent: Ensures that the storage volume does not exist in the specified storage group.
present: Ensures that the storage volume exists in the specified storage group, and has the specified properties.
facts: Returns the storage volume properties.
* absent: Ensures that the storage volume does not exist in the specified storage group.
* present: Ensures that the storage volume exists in the specified storage group, and has the specified properties.
* facts: Returns the storage volume properties.
Dictionary with desired properties for the storage volume. Used for state=present; ignored for state=absent|facts. Dictionary key is the property name with underscores instead of hyphens, and dictionary value is the property value in YAML syntax. Integer properties may also be provided as decimal strings.
The possible input properties in this dictionary are the properties defined as writeable in the data model for Storage Volume resources (where the property names contain underscores instead of hyphens), with the following exceptions:
-name: Cannot be specified because the name has already been specified in the name module parameter.
Properties omitted in this dictionary will remain unchanged when the storage volume already exists, and will get the default value defined in the data model for storage volumes in the HMC API when the storage volume is being created.
+* name: Cannot be specified because the name has already been specified in the name module parameter.
Properties omitted in this dictionary will remain unchanged when the storage volume already exists, and will get the default value defined in the data model for storage volumes in the :term:`HMC API` when the storage volume is being created.
Additional properties of the storage volume, as described in the data model of the ‘Storage Volume’ element object of the ‘Storage Group’ object in the HMC API book. The property names have hyphens (-) as described in that book.
+Additional properties of the storage volume, as described in the data model of the ‘Storage Volume’ element object of the ‘Storage Group’ object in the :term:`HMC API` book. The property names have hyphens (-) as described in that book.
+The hostname or IP address of the HMC.
+The hostnames or IP addresses of a single HMC or of a list of redundant HMCs. A single HMC can be specified as a string type or as an HMC list with one item. An HMC list can be specified as a list type or as a string type containing a Python list representation.
+The first available HMC of a list of redundant HMCs is used for the entire execution of the module.
The authentication credentials for the HMC.
@@ -268,7 +273,7 @@HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in zhmc_session – Manage HMC sessions across tasks.
HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in :ref:`zhmc_session_module`.
The desired state for the HMC user. All states are fully idempotent within the limits of the properties that can be changed:
-absent: Ensures that the user does not exist.
present: Ensures that the user exists and has the specified properties.
facts: Returns the user properties.
* absent: Ensures that the user does not exist.
* present: Ensures that the user exists and has the specified properties.
* facts: Returns the user properties.
Dictionary with desired properties for the user. Used for state=present; ignored for state=absent|facts. Dictionary key is the property name with underscores instead of hyphens, and dictionary value is the property value in YAML syntax. Integer properties may also be provided as decimal strings.
The possible input properties in this dictionary are the properties defined as writeable in the data model for User resources (where the property names contain underscores instead of hyphens), with the following exceptions:
-name: Cannot be specified because the name has already been specified in the name module parameter.
type: Cannot be changed once the user exists.
user_roles: Cannot be set directly, but indirectly via the artificial property user_role_names which replaces the current user roles, if specified.
user_pattern_uri: Cannot be set directly, but indirectly via the artificial property user_pattern_name.
password_rule_uri: Cannot be set directly, but indirectly via the artificial property password_rule_name.
ldap_server_definition_uri: Cannot be set directly, but indirectly via the artificial property ldap_server_definition_name.
default_group_uri: Cannot be set directly, but indirectly via the artificial property default_group_name.
Properties omitted in this dictionary will remain unchanged when the user already exists, and will get the default value defined in the data model for users in the HMC API when the user is being created.
+* name: Cannot be specified because the name has already been specified in the name module parameter.
* type: Cannot be changed once the user exists.
* user_roles: Cannot be set directly, but indirectly via the artificial property user_role_names which replaces the current user roles, if specified.
* user_pattern_uri: Cannot be set directly, but indirectly via the artificial property user_pattern_name.
* password_rule_uri: Cannot be set directly, but indirectly via the artificial property password_rule_name.
* ldap_server_definition_uri: Cannot be set directly, but indirectly via the artificial property ldap_server_definition_name.
* default_group_uri: Cannot be set directly, but indirectly via the artificial property default_group_name.
Properties omitted in this dictionary will remain unchanged when the user already exists, and will get the default value defined in the data model for users in the :term:`HMC API` when the user is being created.
Additional properties of the user, as described in the data model of the ‘User’ object in the HMC API book. The property names have hyphens (-) as described in that book.
+Additional properties of the user, as described in the data model of the ‘User’ object in the :term:`HMC API` book. The property names have hyphens (-) as described in that book.
+Name of the user roles referenced by property user-roles.
Properties of the user role, as described in the data model of the ‘User Pattern’ object in the HMC API book. The property names have hyphens (-) as described in that book.
+Properties of the user role, as described in the data model of the ‘User Pattern’ object in the :term:`HMC API` book. The property names have hyphens (-) as described in that book.
+Properties of the user pattern, as described in the data model of the ‘User Pattern’ object in the HMC API book. The property names have hyphens (-) as described in that book.
+Properties of the user pattern, as described in the data model of the ‘User Pattern’ object in the :term:`HMC API` book. The property names have hyphens (-) as described in that book.
+Properties of the password rule, as described in the data model of the ‘Password Rule’ object in the HMC API book. The property names have hyphens (-) as described in that book.
+Properties of the password rule, as described in the data model of the ‘Password Rule’ object in the :term:`HMC API` book. The property names have hyphens (-) as described in that book.
+Properties of the LDAP server definition, as described in the data model of the ‘LDAP Server Definition’ object in the HMC API book. The property names have hyphens (-) as described in that book.
+Properties of the LDAP server definition, as described in the data model of the ‘LDAP Server Definition’ object in the :term:`HMC API` book. The property names have hyphens (-) as described in that book.
+The hostname or IP address of the HMC.
+The hostnames or IP addresses of a single HMC or of a list of redundant HMCs. A single HMC can be specified as a string type or as an HMC list with one item. An HMC list can be specified as a list type or as a string type containing a Python list representation.
+The first available HMC of a list of redundant HMCs is used for the entire execution of the module.
The authentication credentials for the HMC.
@@ -266,7 +271,7 @@HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in zhmc_session – Manage HMC sessions across tasks.
HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in :ref:`zhmc_session_module`.
If True, all properties of each user will be returned. Default: False.
+Note: Setting this to True causes a loop of ‘Get User Properties’ operations to be executed.
+File path of a log file to which the logic flow of this module as well as interactions with the HMC are logged. If null, logging will be propagated to the Python root logger.
Additional properties requested via full_properties. The property names will have underscores instead of hyphens.
The hostname or IP address of the HMC.
+The hostnames or IP addresses of a single HMC or of a list of redundant HMCs. A single HMC can be specified as a string type or as an HMC list with one item. An HMC list can be specified as a list type or as a string type containing a Python list representation.
+The first available HMC of a list of redundant HMCs is used for the entire execution of the module.
The authentication credentials for the HMC.
@@ -267,7 +272,7 @@HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in zhmc_session – Manage HMC sessions across tasks.
HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in :ref:`zhmc_session_module`.
The desired state for the HMC user role. All states are fully idempotent within the limits of the properties that can be changed:
-absent: Ensures that the user role does not exist.
present: Ensures that the user role exists and has the specified properties.
facts: Returns the user role properties.
* absent: Ensures that the user role does not exist.
* present: Ensures that the user role exists and has the specified properties.
* facts: Returns the user role properties.
Dictionary with desired properties for the user role. Used for state=present; ignored for state=absent|facts. Dictionary key is the property name with underscores instead of hyphens, and dictionary value is the property value in YAML syntax. Integer properties may also be provided as decimal strings.
The possible input properties in this dictionary are the properties defined as writeable in the data model for user role resources (where the property names contain underscores instead of hyphens), with the following exceptions:
-name: Cannot be specified because the name has already been specified in the name module parameter.
associated_system_defined_user_role_uri: Cannot be specified because this information is specified using the artificial property associated_system_defined_user_role_name.
associated_system_defined_user_role_name: The name of the associated system-defined user role.
permissions: Can be specified as if it were writeable.
Properties omitted in this dictionary will remain unchanged when the user role already exists, and will get the default value defined in the data model for user roles in the HMC API when the user role is being created.
+* name: Cannot be specified because the name has already been specified in the name module parameter.
* associated_system_defined_user_role_uri: Cannot be specified because this information is specified using the artificial property associated_system_defined_user_role_name.
* associated_system_defined_user_role_name: The name of the associated system-defined user role.
* permissions: Can be specified as if it were writeable.
Properties omitted in this dictionary will remain unchanged when the user role already exists, and will get the default value defined in the data model for user roles in the :term:`HMC API` when the user role is being created.
Any other property defined as writeable in the data model for user role resources (where the property names contain underscores instead of hyphens), except those excluded in the description above.
The name of the associated system-defined user role. Specifying it requires that the referenced user role exists.
@@ -334,7 +335,7 @@The permissions for this user role.
-This property is represented different from its description in the HMC API: The property is a list of permissions. Each list item is a dictionary that specifies a single permission item, any required scoping items, and optional option items.
+This property is represented different from its description in the :term:`HMC API`: The property is a list of permissions. Each list item is a dictionary that specifies a single permission item, any required scoping items, and optional option items.
The permissions for this user role.
-This property is represented different from its description in the HMC API: The property is a list of permissions. Each list item is a dictionary that specifies a single permission item, any needed scoping items, and any applicable option items.
+This property is represented different from its description in the :term:`HMC API`: The property is a list of permissions. Each list item is a dictionary that specifies a single permission item, any needed scoping items, and any applicable option items.
Additional properties of the user role, as described in the data model of the ‘User Role’ object in the HMC API book. The property names have hyphens (-) as described in that book.
+Additional properties of the user role, as described in the data model of the ‘User Role’ object in the :term:`HMC API` book. The property names have hyphens (-) as described in that book.
+The hostname or IP address of the HMC.
+The hostnames or IP addresses of a single HMC or of a list of redundant HMCs. A single HMC can be specified as a string type or as an HMC list with one item. An HMC list can be specified as a list type or as a string type containing a Python list representation.
+The first available HMC of a list of redundant HMCs is used for the entire execution of the module.
The authentication credentials for the HMC.
@@ -266,7 +271,7 @@HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in zhmc_session – Manage HMC sessions across tasks.
HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in :ref:`zhmc_session_module`.
If True, all properties of each user role will be returned. Default: False.
+Note: Setting this to True causes a loop of ‘Get User Role Properties’ operations to be executed.
+File path of a log file to which the logic flow of this module as well as interactions with the HMC are logged. If null, logging will be propagated to the Python root logger.
Additional properties requested via full_properties. The property names will have underscores instead of hyphens.
The hostname or IP address of the HMC.
+The hostnames or IP addresses of a single HMC or of a list of redundant HMCs. A single HMC can be specified as a string type or as an HMC list with one item. An HMC list can be specified as a list type or as a string type containing a Python list representation.
+The first available HMC of a list of redundant HMCs is used for the entire execution of the module.
The authentication credentials for the HMC.
@@ -269,7 +274,7 @@HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in zhmc_session – Manage HMC sessions across tasks.
HMC session ID to be used. This is mutually exclusive with providing userid and password and can be created as described in :ref:`zhmc_session_module`.
The desired state for the virtual function. All states are fully idempotent within the limits of the properties that can be changed:
-absent: Ensures that the virtual function does not exist in the specified partition.
present: Ensures that the virtual function exists in the specified partition and has the specified properties.
* absent: Ensures that the virtual function does not exist in the specified partition.
* present: Ensures that the virtual function exists in the specified partition and has the specified properties.
Dictionary with input properties for the virtual function, for state=present. Key is the property name with underscores instead of hyphens, and value is the property value in YAML syntax. Integer properties may also be provided as decimal strings. Will be ignored for state=absent.
The possible input properties in this dictionary are the properties defined as writeable in the data model for Virtual Function resources (where the property names contain underscores instead of hyphens), with the following exceptions:
-name: Cannot be specified because the name has already been specified in the name module parameter.
adapter_uri: Cannot be specified because this information is specified using the artificial property adapter_name.
adapter_name: The name of the adapter that backs the target virtual function.
* name: Cannot be specified because the name has already been specified in the name module parameter.
* adapter_uri: Cannot be specified because this information is specified using the artificial property adapter_name.
* adapter_name: The name of the adapter that backs the target virtual function.
Properties omitted in this dictionary will remain unchanged when the virtual function already exists, and will get the default value defined in the data model for virtual functions when the virtual function is being created.
Additional properties of the virtual function, as described in the data model of the ‘Virtual Function’ element object of the ‘Partition’ object in the HMC API book. The property names have hyphens (-) as described in that book.
+Additional properties of the virtual function, as described in the data model of the ‘Virtual Function’ element object of the ‘Partition’ object in the :term:`HMC API` book. The property names have hyphens (-) as described in that book.
+Released: 2023-06-23
+Released: 2024-02-29
Availability: AutomationHub, Galaxy, GitHub
Bug fixes:
Addressed safety issues from 6/23, by increasing ‘requests’ to 2.31.0 -on Python >=3.7.
Fixed safety issues up to 2024-02-18.
Fixed dependabot issues up to 2024-02-18.
Fixed readable attribute error when ensuring ISO mounted onto the partition. +(related to issue #932)
Cleanup:
+Resolved the ‘no-log-needed’ issue raised by the sanity test and ansible-lint +on the ‘os_ipl_token’ input parameter of the ‘zhmc_lpar’ module. That +allowed to get rid of the corresponding entries in the ignore files. +(issue #915)
Resolved the ‘return-syntax-error’ issue raised by the sanity test and +ansible-lint on all modules that specify generic return properties. That +allowed to get rid of the corresponding entries in the ignore files. +(issue #915)
Released: 2024-01-28
+Availability: AutomationHub, Galaxy, GitHub
+Bug fixes:
+Fixed safety issues up to 2024-01-26.
Fixed a performance issue in the ‘zhmc_lpar_list’ and ‘zhmc_partition_list’ +modules where the ‘se-version’ property was fetched from CPCs even if it +was already available in the LPAR/partition properties. (issue #904)
Increased the minimum version of zhmcclient to 1.13.3 to pick up fixes and +performance improvements. (related to issue #904)
Released: 2024-01-15
+Availability: AutomationHub, Galaxy, GitHub
+Bug fixes:
+Addressed collection import issues on AutomationHub.
This version contains all fixes up to version 1.7.4.
+Released: 2024-01-15
+ +Bug fixes:
+Addressed safety issues up to 2024-01-08.
Fixed link to Ansible Galaxy on README page. (issue #785)
Fixed that the ‘name’ property was missing in result of the ‘zhmc_nic_list’ +module.
Development: Added package level to .done files. (issue #799)
Logging: Fixed the result name in the log message for module success.
Fixed that the ‘zhmc_lpar’ module with state=reset_normal/clear waited for +LPAR status “operational” which never happened, by picking up the fix +in zhmcclient 1.11.3. (issue #801)
In the description of the ‘zhmc_lpar’ module, changed incorrect references +to the “acceptable” status to be “exceptions”.
Fixed that the ‘zhmc_lpar’ module with state=set when invoked in check mode +rejected the property update in status “exceptions”.
Fixed and improved the description of the ‘zhmc_lpar’ module for +state=active/loaded; cleaned up the code without functional changes.
Dev: Pinned voluptuous package to <0.14 on Python < 3.6.
Fixed “missing required arguments: b, u, n, d, l, e, _, l, e, v, e, l” +error when using the ‘zhmc_console’ or ‘zhmc_cpc’ modules with ‘state=upgrade’. +(issue #834)
Fixed end2end test for zhmc_cpc_list module that failed when the HMC had +unmanaged CPCs or had HMC version 2.14.
Fixed KeyError in ‘zhmc_storage_group’ module when used with non-FCP storage +groups, and clarified that the artificial properties ‘candidate-adapter-ports’ +and ‘virtual-storage-resources’ returned by the module will be empty arrays +for non-FCP storage groups. (e.g. NVMe). (issue #864)
Fixed that on HMC versions 2.14 and 2.15, the zhmc_adapter_list module +failed because it tried to use the “List Permitted Adapters” operation +that was added in HMC version 2.16 (actually API version 4.10). +(issue #850)
Fixed that on HMC versions 2.14 and 2.15, the zhmc_partition_list module +failed because it tried to use the ‘additional-properties’ query parameter +that was added in HMC version 2.16 (actually API version 4.10). +(issue #850)
Clarified that Ansible versions below 7 (ansible-core 2.14) are not officially +supported, but only supported on a best-can-do basis. As part of that change, +the Ansible sanity checks are reduced to run only on officially supported +Ansible versions. (issue #784)
Corrected the status reported in the log when zhmc_lpar was called with +state=active or loaded, and check mode was enabled. (related to issue #851)
Clarified in the description of the return parameters of the ‘zhmc_cpc’ +module that for state ‘inactive’, an empty dict is returned. +(related to issue #851)
Clarified in the description of the return parameters of the ‘zhmc_lpar’ +module that for state ‘facts’, properties are returned. +(related to issue #851)
Dev: Fixed the call to pipdeptree in the test workflow to use ‘python -m’ +because otherwise it does not show the correct packages of the virtual env.
Docs: Increased minimum Sphinx versions to 7.1.0 on Python 3.8 and to 7.2.0 on +Python >=3.9 and adjusted dependent package versions in order to fix a version +incompatibility between sphinxcontrib-applehelp and Sphinx. +Disabled Sphinx runs on Python <=3.7 in order to no longer having to deal +with older Sphinx versions. (issue #890)
Enhancements:
+Added support for Python 3.12. (issue #796)
Added support for Ansible 9.
Increased minimum version of zhmcclient to 1.13.0 to pick up fixes and +functionality.
Added new Ansible modules ‘zhmc_lpar_messages’ and ‘zhmc_partition_messages’ +that retrieve and return console messages from the operating system running +in an LPAR or DPM partition. (issue #565)
Added upgrade_timeout parameter to zhmc_console and zhmc_cpc modules.
Added a new make target ‘make ansible_lint’ which invokes ansible-lint. +Fixed some of the warnings reported by ansible-lint. +(related to issue #784)
Increased the minimum versions of the following packages used for installing +the collection:
+packaging to 21.3 (on Python >= 3.6)
PyYAML to 6.0.1 (on Python >= 3.6)
jsonschema to 4.10.0 (on Python >= 3.7)
In the ‘zhmc_adapter_list’ module, improved the use of the “Permitted +Adapters” operation so that it is now also used when the ‘additional_properties’ +module parameter is used and the HMC API version is 4.10 or higher. +(related to issue #850)
Docs: In the ‘zhmc_lpar_list’ module, clarified that the use of the “List +Permitted Logical Partitions” operation does not affect the module result +data. (related to issue #850)
Docs: In the ‘zhmc_partition_list’ module, clarified that the use of the “List +Permitted Partitions” operation does not affect the module result data. +(related to issue #850)
Added support for mounting and unmounting ISO images to partitions (DPM mode) +via new state values ‘iso_mount’ and ‘iso_unmount’ for the ‘zhmc_partition’ +module (issue #551)
Support for limiting the properties returned by the ‘zhmc_cpc’, ‘zhmc_lpar’ +and ‘zhmc_partition’ modules by specifying a new ‘select_properties’ input +parameter. (issue #851)
Added support for a new make target ‘authors’ that generates an AUTHORS.md +file from the git commit history. Added the invocation of ‘make authors’ to +the description of how to release a version in the development +documentation. (issue #631)
Added support for redundant HMC hosts. The ‘hmc_host’ module input parameter +can now be specified as a single HMC as before, or as a list of redundant +HMCs. The HMC list can be specified as a list type or as a Python string +representation of a list in order to accomodate Ansible expressions. +(issue #849)
The ‘zhmc_session’ module now has an additional module return parameter +‘hmc_host’ which for ‘action=create’ contains the actually used HMC. +If you use that module and now start specifying redundant HMCs for +‘action=create’, you need to also change the ‘hmc_host’ parameter of all +ibm_zhmc modules that use that session including the ‘zhmc_session’ module +with ‘action=delete’, to specify the so returned HMC. If you use that +module with a single HMC, no change is needed. (related to issue #849)
Test: Added Python 3.8 with latest package levels to normal tests because +that is now the minimum version to run Sphinx. (related to issue #890)
In the ‘zhmc_lpar_list’ module, added support for the ‘additional_properties’ +input parameter. (issue #853)
Cleanup:
+Removed documentation and test files (except sanity test ignore files) from +the collection package that is built, for consistency with the other IBM Z +collections and in order to get rid of the dependency to have the doc extractor +installed as a dependency to build and install the collection locally.
This version contains all fixes up to version 1.6.1.
+Released: 2023-10-09
+Availability: AutomationHub, Galaxy, GitHub
+Incompatible changes:
+zhmc_adapter - Fixed the ‘match’ input parameter to have priority over the +‘name’ input parameter. Previously, the ‘name’ parameter had priority if +(and only if) an adapter with that name existed. +This bug fix changes the behavior if ‘match’ is used and another adapter with +the new name already exists: Before this change, the other adapter was used +and other input properties were updated in that adapter, which in all +likelyhood was not intended because it was not the adapter identified by the +‘match’ parameter. With this change, the adapter identified by the ‘match’ +parameter is always used regardless of whether another adapter with that name +exists, i.e. the name change in that case will fail.
zhmc_crypto_attachment - Now, one of the ‘adapter_count’ or ‘adapter_names’ +parameters must be specified. Previously, not providing any of them +resulted in a default of adapter_count = -1 (all adapters of the specified +crypto type). That made it impossible to properly check for whether both +had been specified when dapter_count was specified with its default -1. +To use all adapters now, explicitly specify ‘adapter_count: -1’.
Bug fixes:
+Fixed safety issues from 2023-09-15.
Test: Circumvented a pip-check-reqs issue by excluding its version 2.5.0.
Test: Fixed end2end tests in modules test_zhmc_partition.py, +test_zhmc_session.py, and test_zhmc_user.py.
Docs: Removed incorrect ‘userid’ property from return value documentation of +zhmc_session module.
zhmc_partition: Fixed configuration of boot from storage volume. It can now +be configured either by setting the ‘boot_storage_volume’ input property to +the URI of the boot volume, or by setting the ‘boot_storage_volume_name’ +and ‘boot_storage_group_name’ input properties to the name of the boot volume +and its storage group, respectively. (issue #640)
zhmc_partition: Fixed issue that partitions in ‘paused’ status could not be +stopped. As part of that, redesigned the start_partition(), stop_partition() +and wait_for_transition_completion() methods to use a simple state machine. +This will cause any bad statuses that happen on the way to be raised as +exceptions (they were previously returned). (issue #642)
Enhancements:
+Increased minimum version of zhmcclient to 1.11.2 to pick up fixes for +mock support for LDAP Server Definitions, improved mock support for Adapters, +and new functionality.
Docs: Clarified that firmware upgrades of SE and HMC do nothing and succeed +if the firmware was already at the desired bundle level.
Test: Clarified in make help that coverage data is added by each test. +Enabled end2end test for test coverage.
zhmc_ldap_server_definition - Added support for retrieving, creating and +deleting LDAP Server Definitions (issue 364).
zhmc_ldap_server_definition_list - Added support for listing LDAP Server +Definitions (issue 364).
zhmc_user_role: Added support for user role permissions based on groups.
Added support for requesting full properties with a new “full_properties” +input parameter for the list modules. (issue #651)
Added support for requesting specific additional properties with a new +“additional_properties” input parameter for the zhmc_adapter_list and +zhmc_partition_list modules. (issue #651)
zhmc_adapter - Added new properties for z15 (nvme related) and z16 +(‘network-ports’), and improved the output properties for hipersocket +create in check mode.
zhmc_adapter - Improved the check mode support: It now recognizes if an +adapter gets renamed to another existing adapter and rejects that just +as in non-check mode.
zhmc_crypto_attachment - The ‘crypto_type’ parameter is now ignored when +‘adapter_names’ is specified. That allows specifying adapter names without +having to know their crypto type.
Added CHANGELOG.rst file to satisfy requirement for RedHat Automation Hub. +For now, it includes release_notes.rst. A transition to fragments-based +creation of CHANGELOG.rst is postponed because the unified documentation +for the IBM Z set of collections first needs to find a common solution +for all of its collections.
Added new parameters load_address, load_parameter, clear_indicator, +store_status_indicator and timeout for the zhmc_lpar module with +state=loaded. (issue #556)
Added new parameter timeout for the zhmc_lpar module with state=active. +(issue #556)
Cleanup:
+Test: Changed identification of adapters in end2end test module +test_zhmc_adapter_list.py to be based on adapter IDs (PCHIDs) instead of +adapter names to accomodate a system on the test floor that currently has +that bug.
Test: Always provided optional module input parameters in end2end tests. This +allows modules to rely on optional parameters being provided with their +default values by the calling Ansible environent. Changed the modules to rely +on that.
Test: Added a check in the Actions test workflow for the module .rst files +to be up to date in the PR. (issue #755)
Released: 2306-08-04
+Availability: AutomationHub, Galaxy, GitHub
+Enhancements:
+Added support for upgrading HMC firmware to the zhmc_console module and +for upgrading the SE firmware to the ibm_cpc module, with a new state value +‘upgrade’. Increased minimum zhmcclient version to 1.10.0 (issue #719)
This version contains all fixes up to version 1.4.1.
+Released: 2023-07-18
+Availability: AutomationHub, Galaxy, GitHub
+Bug fixes:
+Addressed safety issues from 6+7/2023, by increasing ‘requests’ to 2.31.0 +on Python >=3.7, and ‘cryptography’ to 41.0.2 on Python >=3.7, and by +increasing other packages only needed for development.
Fixed issue in the new zhmc_nic_list module that resulted in TypeError.
Increased minimum version of cryptography package to 41.0.2 to address an +issue.
Picked up zhmcclient version 1.9.1 to get fixes. This required upgrading +several other packages.
Enhancements:
+Documented the secret variables needed for the Github Actions workflows.
Added support for FCP discovery to the zhmc_storage_group module with a new +state ‘discover’. (issue #704)