hitachivantara.vspone_block.vsp.hv_vsp_one_gad_consistency_group_facts module – Retrieves consistency group of GAD pairs from VSP One 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_vsp_one_gad_consistency_group_facts.

New in hitachivantara.vspone_block 4.8.0

Synopsis
Requirements
Parameters
Attributes
Examples
Returned Facts

Synopsis

This module allows to fetch consistency groups of GAD pairs on VSP One storage systems.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/vsp_one_gad_consistency_group_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 / required	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	Specification for the GAD pairs task.
consistency_group_id integer	Consistency group ID. Required for the Get GAD pair using consistency group ID task.

Attributes

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

Examples

- name: Get all consistency groups for 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"

- name: Get specific consistency group for 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"
    spec:
      consistency_group_id: 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
gad_consistency_groups dictionary	Details of the GAD (Global Active Device) consistency group configuration. Returned: success
id integer	Identifier of the GAD pair. Returned: success Sample: `1`
io_preference string	I/O preference setting for the GAD pair. Returned: success Sample: `"DISABLED"`
local_volume_io_modes list / elements=string	List of I/O modes for the local volumes. Returned: success Sample: `["MIRROR"]`
local_volume_positions list / elements=string	Positions of the local volumes in the pair. Returned: success Sample: `["PRIMARY"]`
local_volume_statuses list / elements=string	Statuses of the local volumes. Returned: success Sample: `["PAIR"]`
mirror_unit_number integer	Mirror unit number associated with the pair. Returned: success Sample: `0`
number_of_pairs integer	Total number of pairs in the configuration. Returned: success Sample: `1`
pair_operation_modes_for_blocked_quorum_disk list / elements=string	Operation modes when quorum disk is blocked. Returned: success Sample: `["QUORUMLESS"]`
quorum_disk_id integer	Identifier of the quorum disk. Returned: success Sample: `22`
remote_connection_id dictionary	Remote storage connection details. Returned: success
path_group_id integer	Path group ID for the remote connection. Returned: success Sample: `0`
storage_model string	Model of the remote storage system. Returned: success Sample: `"RH20ETP"`
storage_serial_number string	Serial number of the remote storage system. Returned: success Sample: `"70041"`

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_vsp_one_gad_consistency_group_facts_module.html