zhmc_storage_volume - Manages DPM storage volumes in existing storage groups (with “dpm-storage-management” feature)¶

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

Synopsis ¶

Gathers facts about a storage volume in a storage group associated with a CPC.
Creates, deletes and updates a storage volume in 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 storage group containing the target storage volume.

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

properties

no

No 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 book when the storage volume is being created.

state

yes

absent
present
facts

The desired state for the target storage volume:

* 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: Does not change anything on the storage volume and returns the storage volume properties.

storage_group_name

yes

The name of the storage group containing the target storage volume.

Examples ¶

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

- name: Gather facts about a storage volume
  zhmc_storage_volume:
    hmc_host: "{{ my_hmc_host }}"
    hmc_auth: "{{ my_hmc_auth }}"
    cpc_name: "{{ my_cpc_name }}"
    storage_group_name: "{{ my_storage_group_name }}"
    name: "{{ my_storage_volume_name }}"
    state: facts
  register: sv1

- name: Ensure the storage volume does not exist
  zhmc_storage_volume:
    hmc_host: "{{ my_hmc_host }}"
    hmc_auth: "{{ my_hmc_auth }}"
    cpc_name: "{{ my_cpc_name }}"
    storage_group_name: "{{ my_storage_group_name }}"
    name: "{{ my_storage_volume_name }}"
    state: absent

- name: Ensure the storage volume exists
  zhmc_storage_volume:
    hmc_host: "{{ my_hmc_host }}"
    hmc_auth: "{{ my_hmc_auth }}"
    cpc_name: "{{ my_cpc_name }}"
    storage_group_name: "{{ my_storage_group_name }}"
    name: "{{ my_storage_volume_name }}"
    state: present
    properties:
      description: "Example storage volume 1"
      size: 1
  register: sv1

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_volume	For `state=absent`, an empty dictionary. For `state=present\|facts`, a dictionary with the resource properties of the storage volume, indicating the state after changes from this module (if any) have been applied. 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: * `type`: Type of the storage volume ('fc' or 'fcp'), as defined in its storage group.	success	dict	`{ "name": "sv-1", "description": "storage volume #1", ... }`

Notes ¶

Note

The CPC that is associated with the 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 volume objects within storage group objects. 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.