W3cubDocs

/Ansible

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

Note

This module is part of the hitachivantara.vspone_block collection (version 3.5.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 Hitachi VSP 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	This field is used to pass the value of the lock token 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 if api_token is not provided.
username string	Username for authentication. This is a required field if api_token is not provided.
spec dictionary	Specification for retrieving shadow image pair information.
copy_group_name string	Name of the copy group.
copy_pair_name string	Name of the copy pair.
primary_volume_id integer	Primary volume id.
refresh boolean	Whether refresh pairs 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.

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_pace_track_size string	Copy pace track size. Returned: success Sample: `"MEDIUM"`
copy_rate integer	Copy rate. Returned: success Sample: `100`
mirror_unit_id integer	Mirror unit ID. Returned: success Sample: `-1`
primary_hex_volume_id string	Primary hex volume ID. Returned: success Sample: `"00:01:12"`
primary_volume_id integer	Primary volume ID. Returned: success Sample: `274`
resource_id string	Resource ID. Returned: success Sample: `"localpair-2749fed78e8d23a61ed17a8af71c85f8"`
secondary_hex_volume_id string	Secondary hex volume ID. Returned: success Sample: `"00:01:17"`
secondary_volume_id integer	Secondary volume ID. Returned: success Sample: `279`
status string	Status of the shadow image pair. Returned: success Sample: `"PAIR"`
storage_serial_number string	Storage serial number. Returned: success Sample: `"811150"`
svol_access_mode string	SVol access mode. Returned: success Sample: `"READONLY"`

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/ansible/latest/collections/hitachivantara/vspone_block/vsp.hv_shadow_image_pair_facts_module.html