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

New in hitachivantara.vspone_block 3.1.0

Synopsis

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.

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

integer

Primary Volume Id.

remote_device_group_name

string

Remote Device Group Name.

secondary_storage_serial_number

integer

Secondary Storage Serial Number.

secondary_volume_id

integer

Secondary Volume Id.

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.

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_pairs

list / elements=dictionary

List of GAD pairs with their attributes.

Returned: success

consistency_group_id

integer

Consistency group ID.

Returned: success

Sample: 1

copy_pace_track_size

integer

Copy pace track size.

Returned: success

Sample: -1

copy_rate

integer

Copy rate.

Returned: success

Sample: 0

mirror_unit_id

integer

Mirror unit ID.

Returned: success

Sample: 1

pair_name

string

Pair name.

Returned: success

Sample: ""

primary_hex_volume_id

string

Primary hex volume ID.

Returned: success

Sample: "00:00:01"

primary_v_s_m_resource_group_name

string

Primary VSM resource group name.

Returned: success

Sample: ""

primary_virtual_hex_volume_id

string

Primary virtual hex volume ID.

Returned: success

Sample: "00:00:01"

primary_virtual_storage_id

string

Primary virtual storage ID.

Returned: success

Sample: ""

primary_virtual_volume_id

integer

Primary virtual volume ID.

Returned: success

Sample: -1

primary_volume_id

integer

Primary volume ID.

Returned: success

Sample: 1

primary_volume_storage_id

integer

Primary volume storage ID.

Returned: success

Sample: 811111

secondary_hex_volume_id

string

Secondary hex volume ID.

Returned: success

Sample: "00:00:02"

secondary_v_s_m_resource_group_name

string

Secondary VSM resource group name.

Returned: success

Sample: ""

secondary_virtual_hex_volume_id

integer

Secondary virtual hex volume ID.

Returned: success

Sample: -1

secondary_virtual_storage_id

string

Secondary virtual storage ID.

Returned: success

Sample: ""

secondary_virtual_volume_id

integer

Secondary virtual volume ID.

Returned: success

Sample: -1

secondary_volume_id

integer

Secondary volume ID.

Returned: success

Sample: 2

secondary_volume_storage_id

integer

Secondary volume storage ID.

Returned: success

Sample: 811112

status

string

Status of the GAD pair.

Returned: success

Sample: "PAIR"

storage_serial_number

string

Storage serial number.

Returned: success

Sample: "811111"

svol_access_mode

string

Secondary volume access mode.

Returned: success

Sample: "READONLY"

type

string

Type of GAD pair.

Returned: success

Sample: "GAD"

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)