hitachivantara.vspone_block.vsp.hv_gad_facts module – Retrieves GAD pairs information 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_gad_facts.

New in hitachivantara.vspone_block 3.1.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Returned Facts

Synopsis

This module allows to fetch GAD pairs on VSP block storage systems.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/gad_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.
secondary_connection_info dictionary	Information required to establish a connection to the secondary storage system.
address string / required	IP address or hostname of the secondary storage.
api_token string	Value of the lock token to operate on locked resources. Provide this only when operation is on locked resources.
password string	Password for authentication. This field is required for secondary storage connection api_token is not provided.
username string	Username for authentication. This field is required for secondary storage connection if api_token is not provided.
spec dictionary / required	Specification for the GAD pairs task.
copy_group_name string	Copy Group Name.
copy_pair_name string	Copy Pair Name.
local_device_group_name string	Local Device Group Name.
primary_volume_id string	Primary Volume Id. Required for the Get GAD pair using primary volume ID task.
remote_device_group_name string	Remote Device Group Name.
secondary_storage_serial_number integer	Secondary Storage Serial Number.
secondary_volume_id string	Secondary Volume Id. Required for the Get GAD pair using secondary volume ID task.
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 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.
Currently, only pairs that belong to a copy group are retrieved. Therefore, it is recommended to delete any existing pair that is not part of a copy group and re-create the replication pairs using direct connect with copy group technology.
When working with remote replication facts (GAD, HUR, TC), it’s best practice to use the task that specifies the copy group name. For example, Get all GAD pairs by copy group name.

Examples

- name: Get all GAD pairs
  hitachivantara.vspone_block.vsp.hv_gad_facts:
    connection_info:
      address: storage1.company.com
      username: "username"
      password: "password"
    secondary_connection_info:
      address: storage2.company.com
      username: "admin"
      password: "secret"

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
gad_pair list / elements=dictionary	List of GAD pairs with their attributes. Returned: success
consistency_group_id integer	Consistency group ID. Returned: success Sample: `-1`
copy_group_name string	Copy group name. Returned: success Sample: `"cp_group_840"`
copy_pace_track_size integer	Deprecated. Copy pace track size. Returned: success Sample: `""`
copy_pair_name string	Pair name. Returned: success Sample: `"gad_pair_840"`
copy_rate string	Deprecated. Copy rate. Returned: success Sample: `""`
fence_level string	Fence level. Returned: success Sample: `"NEVER"`
is_alua_enabled boolean	Whether ALUA is enabled or not. Returned: success Sample: `false`
local_device_group_name string	Local device group name. Returned: success Sample: `"cp_group_840S_"`
mirror_unit_id integer	Deprecated. Use mirror_unit_number instead. Mirror unit ID. Returned: success Sample: `0`
mirror_unit_number integer	Mirror unit number. Returned: success Sample: `0`
primary_virtual_serial_number integer	Primary virtual serial number. Returned: success Sample: `-1`
primary_virtual_volume_id integer	Primary virtual volume id. Returned: success Sample: `-1`
primary_volume_id integer	Primary volume ID. Returned: success Sample: `840`
primary_volume_id_hex string	Primary volume ID in hexadecimal format. Returned: success Sample: `"00:03:48"`
primary_volume_size string	Size of the primary volume. Display only for single GAD pair query. Returned: success Sample: `"4.00GB"`
primary_volume_status string	Status of the GAD pair. Returned: success Sample: `"PSUE"`
primary_volume_storage_id string	Deprecated. Use primary_volume_storage_serial_number instead. Returned: success Sample: `"810050"`
primary_volume_storage_serial_number string	Primary volume storage serial number. Returned: success Sample: `"810050"`
primary_vsm_resource_group_name string	Primary VSM resource group name. Returned: success Sample: `""`
quorum_disk_id integer	Quorum disk ID. Returned: success Sample: `21`
remote_device_group_name string	Remote device group name. Returned: success Sample: `"cp_group_840P_"`
remote_mirror_copy_pair_id string	Deprecated. Remote mirror copy pair ID. Returned: success Sample: `"A34000810050,cp_group_840,cp_group_840S_,cp_group_840P_,gad_pair_840"`
secondary_virtual_serial_number integer	Secondary virtual storage serial number. Returned: success Sample: `-1`
secondary_virtual_volume_id integer	Secondary virtual volume ID. Returned: success Sample: `-1`
secondary_volume_id integer	Secondary volume ID. Returned: success Sample: `831`
secondary_volume_id_hex string	Secondary volume ID in hexadecimal format. Returned: success Sample: `"00:03:3F"`
secondary_volume_size string	Size of the secondary volume. Display only for single GAD pair query. Returned: success Sample: `"4.00GB"`
secondary_volume_status string	Status of the GAD pair. Returned: success Sample: `"PSUE"`
secondary_volume_storage_id string	Deprecated. Use secondary_volume_storage_serial_number instead. Returned: success Sample: `"810045"`
secondary_volume_storage_serial_number string	Secondary volume storage serial number. Returned: success Sample: `"810045"`
secondary_vsm_resource_group_name string	Secondary VSM resource group name. 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_gad_facts_module.html