zhmc_storage_group - Manages DPM storage groups (with “dpm-storage-management” feature)

Synopsis

• Gathers facts about a storage group associated with a CPC, including its storage volumes and virtual storage resources.
• Creates, deletes and updates a storage group associated with a CPC.

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 associated with the target storage group.
expand	no		yes no	Boolean that controls whether the returned storage group contains additional artificial properties that expand certain URI or name properties to the full set of resource properties (see description of return values of this module).
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.
name	yes			The name of the target storage group.
properties	no	No 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 book when the storage group is being created.
state	yes		absent present facts	The desired state for the target storage group: * absent: Ensures that the storage group does not exist. If the storage group is currently attached to any partitions, the module will fail. * present: Ensures that the storage group exists and is associated with the specified CPC, and has the specified properties. The attachment state of the storage group to a partition is not changed. * facts: Does not change anything on the storage group and returns the storage group properties.

Examples

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

- name: Gather facts about a storage group
  zhmc_storage_group:
    hmc_host: "{{ my_hmc_host }}"
    hmc_auth: "{{ my_hmc_auth }}"
    cpc_name: "{{ my_cpc_name }}"
    name: "{{ my_storage_group_name }}"
    state: facts
    expand: true
  register: sg1

- name: Ensure the storage group does not exist
  zhmc_storage_group:
    hmc_host: "{{ my_hmc_host }}"
    hmc_auth: "{{ my_hmc_auth }}"
    cpc_name: "{{ my_cpc_name }}"
    name: "{{ my_storage_group_name }}"
    state: absent

- name: Ensure the storage group exists
  zhmc_storage_group:
    hmc_host: "{{ my_hmc_host }}"
    hmc_auth: "{{ my_hmc_auth }}"
    cpc_name: "{{ my_cpc_name }}"
    name: "{{ my_storage_group_name }}"
    state: present
    expand: true
    properties:
      description: "Example storage group 1"
      type: fcp
      shared: false
      connectivity: 4
      max-partitions: 1
  register: sg1

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	For state=absent, an empty dictionary. For state=present|facts, a dictionary with the resource properties of the target storage group, plus additional artificial properties as described in the following list items. The dictionary keys are the exact property names as described in the data model for the resource, i.e. they contain hyphens (-), not underscores (_). The dictionary values are the property values using the Python representations described in the documentation of the zhmcclient Python package. The additional artificial properties are: * attached-partition-names: List of partition names to which the storage group is attached. * cpc-name: Name of the CPC that is associated to this storage group. * candidate-adapter-ports (only if expand was requested): List of candidate adapter ports of the storage group. Each port is represented as a dictionary of its properties; in addition each port has an artificial property parent-adapter which represents the adapter of the port. Each adapter is represented as a dictionary of its properties. * storage-volumes (only if expand was requested): List of storage volumes of the storage group. Each storage volume is represented as a dictionary of its properties. * virtual-storage-resources (only if expand was requested): List of virtual storage resources of the storage group. Each virtual storage resource is represented as a dictionary of its properties. * attached-partitions (only if expand was requested): List of partitions to which the storage group is attached. Each partition is represented as a dictionary of its properties. * cpc (only if expand was requested): The CPC that is associated to this storage group. The CPC is represented as a dictionary of its properties.	success	dict	{ "name": "sg-1", "description": "storage group #1", ... }

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 definition of storage group objects and their attachment to partitions. This module does not perform any actions against storage subsystems or SAN switches.
• Attachment of a storage group to and from partitions is managed by the Ansible module zhmc_storage_group_attachment.
• 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.