hitachivantara.vspone_block.vsp.hv_shadow_image_pair_facts module – Retrieves information about shadow image pairs from VSP block storage systems.

Note

This module is part of the hitachivantara.vspone_block collection (version 4.8.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install hitachivantara.vspone_block. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: hitachivantara.vspone_block.vsp.hv_shadow_image_pair_facts.

New in hitachivantara.vspone_block 3.0.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Returned Facts

Synopsis

This module retrieves information about shadow image pairs from VSP block storage systems.
It provides details about shadow image pair such as ID, status and other relevant information.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/shadow_image_pair_facts.yml

Requirements

The below requirements are needed on the host that executes this module.

python >= 3.9

Parameters

Parameter	Comments
connection_info dictionary / required	Information required to establish a connection to the storage system.
address string / required	IP address or hostname of the storage system.
api_token string	Token used to operate on locked resources.
connection_type string	Type of connection to the storage system. Choices: `"direct"` ← (default)
password string	Password for authentication. This is a required field.
username string	Username for authentication. This is a required field.
spec dictionary	Specification for retrieving shadow image pair information.
copy_group_name string	Name of the copy group. Required for the Get ShadowImage pairs by copy_group_name and copy_pair_name task.
copy_pair_name string	Name of the copy pair. Required for the Get ShadowImage pairs by copy_group_name and copy_pair_name task.
primary_volume_id string	Primary volume id. Required for the Get ShadowImage pairs by P-VOL task.
refresh boolean	Whether refresh pairs Required for the Get all ShadowImage pairs along with refresh task. Choices: `false` `true`
storage_system_info dictionary	Information about the storage system. This field is an optional field.
serial string	The serial number of the storage system.

Attributes

Attribute	Support	Description
check_mode	Support: full	Determines if the module should run in check mode.

Notes

Note

The output parameters entitlement_status, subscriber_id and partner_id were removed in version 3.4.0. They were also deprecated due to internal API simplification and are no longer supported.
Connection type gateway was removed starting from version 3.4.0. Please use an earlier version if you require this connection type.
This module displays information about ShadowImage pairs, including their ID, status, and other relevant details. Only pairs that belong to a copy group are retrieved. Therefore, it is recommended to remove any existing pair that is not part of a copy group and re-create the replication pairs using direct connect with copy group technology.

Examples

- name: Retrieve information about all shadow image pairs
  hitachivantara.vspone_block.vsp.hv_shadow_image_pair_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"

    storage_system_info:
      serial: 811150

- name: Retrieve information about a specific shadow image pair
  hitachivantara.vspone_block.vsp.hv_shadow_image_pair_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    spec:
      primary_volume_id: 274

- name: Retrieve information about a specific shadow image pair using copy group name and copy pair name
  hitachivantara.vspone_block.vsp.hv_shadow_image_pair_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    spec:
      copy_group_name: "copy_group_1"
      copy_pair_name: "copy_pair_1"

Returned Facts

Facts returned by this module are added/updated in the hostvars host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them.

Key	Description
data list / elements=dictionary	List of shadow image pairs. Returned: success
consistency_group_id integer	Consistency group ID. Returned: success Sample: `-1`
copy_group_name string	Copy group name. Returned: success Sample: `"SI_768"`
copy_pace_track_size string	Copy pace track size. Returned: success Sample: `"MEDIUM"`
copy_pair_name string	Copy pair name. Returned: success Sample: `"SI_768"`
copy_rate integer	Copy rate. Returned: success Sample: `100`
mirror_unit_id integer	Deprecated. Use mirror_unit_number instead. Returned: success Sample: `0`
mirror_unit_number integer	Mirror unit number. Returned: success Sample: `0`
primary_volume_host_groups list / elements=dictionary	Primary volume host groups. Returned: success Sample: `[{"host_group_name": "hostserver1153", "host_group_number": 189, "lun": 0, "port_id": "CL2-B"}]`
primary_volume_id integer	Primary volume ID. Returned: success Sample: `768`
primary_volume_id_hex string	Primary hex volume ID in hexadecimal. Returned: success Sample: `"00:03:00"`
primary_volume_iscsi_targets list / elements=dictionary	Primary volume iSCSI targets. Returned: success Sample: `[]`
primary_volume_nvm_subsystem_name string	Primary volume’s nvm subsystem name. Returned: success Sample: `""`
pvol_host_groups list / elements=dictionary	Deprecated. Use primary_volume_host_groups instead. Returned: success Sample: `[{"host_group_name": "hostserver1153", "host_group_number": 189, "lun": 0, "port_id": "CL2-B"}]`
pvol_iscsi_targets list / elements=dictionary	Deprecated. Use primary_volume_iscsi_targets instead. Returned: success Sample: `[]`
pvol_nvm_subsystem_name string	Deprecated. Use primary_volume_nvm_subsystem_name instead. Returned: success Sample: `""`
secondary_volume_host_groups list / elements=dictionary	Secondary volume host groups. Returned: success Sample: `[{"host_group_name": "hostserver1153", "host_group_number": 189, "lun": 1, "port_id": "CL2-B"}]`
secondary_volume_id integer	Secondary volume ID. Returned: success Sample: `771`
secondary_volume_id_hex string	Secondary hex volume ID in hexadecimal. Returned: success Sample: `"00:03:03"`
secondary_volume_iscsi_targets list / elements=dictionary	Secondary volume iSCSI targets. Returned: success Sample: `[]`
secondary_volume_nvm_subsystem_name string	Secondary volume’s nvm subsystem name. Returned: success Sample: `""`
status string	Status of the shadow image pair. Returned: success Sample: `"PAIR"`
storage_serial_number string	Storage serial number. Returned: success Sample: `"810045"`
svol_host_groups list / elements=dictionary	Deprecated. Use secondary_volume_host_groups instead. Returned: success Sample: `[{"host_group_name": "hostserver1153", "host_group_number": 189, "lun": 1, "port_id": "CL2-B"}]`
svol_iscsi_targets list / elements=dictionary	Deprecated. Use secondary_volume_iscsi_targets instead. Returned: success Sample: `[]`
svol_nvm_subsystem_name string	Deprecated. Use secondary_volume_nvm_subsystem_name instead. Returned: success Sample: `""`

Authors

Hitachi Vantara LTD (@hitachi-vantara)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/hitachivantara/vspone_block/vsp.hv_shadow_image_pair_facts_module.html