zhmc_storage_group_attachment - Manages the attachment of DPM storage groups to partitions (with “dpm-storage-management” feature)¶

Synopsis
Requirements (on host that executes module)
Options
Examples
Return Values
Notes
- Status
- Support
- Shipment

Synopsis ¶

Gathers facts about the attachment of a storage group to a partition.
Attaches and detaches a storage group to and from a partition.

Requirements (on host that executes module)¶

Network access to HMC

zhmcclient >=0.20.0

ansible >=2.2.0.0

Options ¶

parameter required default choices comments

cpc_name

yes

The name of the CPC that has the partition and is associated with the storage group.

faked_session

no

Real HMC will be used.

A zhmcclient_mock.FakedSession object that has a mocked HMC set up. If provided, it will be used instead of connecting to a real HMC. This is used for testing purposes only.

hmc_auth

yes

The authentication credentials for the HMC.

**Dictionary object hmc_auth**
parameter	required	default	choices	comments
userid	yes			The userid (username) for authenticating with the HMC.
password	yes			The password for authenticating with the HMC.

hmc_host

yes

The hostname or IP address of the HMC.

log_file

no

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.

partition_name

yes

The name of the partition for the attachment.

state

yes

detached
attached
facts

The desired state for the attachment:

* 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.

* attached: Ensures that the storage group is attached to the partition.

* facts: Does not change anything on the attachment and returns the attachment status.

storage_group_name

yes

The name of the storage group for the attachment.

Examples ¶

---
# Note: The following examples assume that some variables named 'my_*' are set.

- name: Gather facts about the attachment
  zhmc_storage_group_attachment:
    hmc_host: "{{ my_hmc_host }}"
    hmc_auth: "{{ my_hmc_auth }}"
    cpc_name: "{{ my_cpc_name }}"
    storage_group_name: "{{ my_storage_group_name }}"
    partition_name: "{{ my_partition_name }}"
    state: facts
  register: sga1

- name: Ensure the storage group is attached to the partition
  zhmc_storage_group_attachment:
    hmc_host: "{{ my_hmc_host }}"
    hmc_auth: "{{ my_hmc_auth }}"
    cpc_name: "{{ my_cpc_name }}"
    storage_group_name: "{{ my_storage_group_name }}"
    partition_name: "{{ my_partition_name }}"
    state: attached

- name: "Ensure the storage group is not attached to the partition."
  zhmc_storage_group_attachment:
    hmc_host: "{{ my_hmc_host }}"
    hmc_auth: "{{ my_hmc_auth }}"
    cpc_name: "{{ my_cpc_name }}"
    storage_group_name: "{{ my_storage_group_name }}"
    partition_name: "{{ my_partition_name }}"
    state: detached

Return Values ¶

Common return values are documented here Return Values, the following are the fields unique to this module:

name	description	returned	type	sample
storage_group_attachment	A dictionary with a single key 'attached' whose boolean value indicates whether the storage group is now actually attached to the partition. If check mode was requested, the actual (i.e. not the desired) attachment state is returned.	success	dict	`{"attached": true}`

Notes ¶

Note

The CPC that is associated with the target storage group must be in the Dynamic Partition Manager (DPM) operational mode and must have the “dpm-storage-management” firmware feature enabled. That feature has been introduced with the z14-ZR1 / Rockhopper II machine generation.
This module performs actions only against the Z HMC regarding the attachment of storage group objects to partitions. This module does not perform any actions against storage subsystems or SAN switches.
The Ansible module zhmc_hba is no longer used on CPCs that have the “dpm-storage-management” feature enabled.

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support ¶

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support.

For help in developing on modules, should you be so inclined, please read the contribution guidelines in the module’s source repository, Testing Ansible and Developing Modules.

Shipment ¶

This module is a third-party module and is not shipped with Ansible. See the module’s source repository for details.