W3cubDocs

/Ansible

hitachivantara.vspone_block.vsp.hv_gad module – Manages GAD pairs on 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.

New in hitachivantara.vspone_block 3.1.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Return Values

Synopsis

This module allows for the creation, deletion, splitting, and resynchronization of GAD pairs on Hitachi VSP storage systems.
It supports various GAD pairs operations based on the specified task level.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/gad_pair.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.
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.
password string	Password for authentication. This field is required for secondary storage connection if 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.
allocate_new_consistency_group boolean	Allocate and assign a new consistency group ID. Choices: `false` `true`
begin_secondary_volume_id integer	Specify beginning ldev id for LDEV range for svol. This is an optional field during create operation. If this field is specified, end_secondary_volume_id must also be specified. If this field is not specified, Ansible modules will try to create SVOL ID same as the PVOL ID if available, otherwise it will use the first available LDEV ID.
consistency_group_id integer	Consistency Group ID.
copy_group_name string	The name for the copy group.
copy_pace string	Copy pace. Choices: `"HIGH"` `"MEDIUM"` ← (default) `"LOW"`
copy_pair_name string	The name for the pair in the copy group.
do_initial_copy boolean	Whether to perform an initial copy. Choices: `false` `true` ← (default)
end_secondary_volume_id integer	Specify end ldev id for LDEV range for svol. This is an optional field during create operation. If this field is specified, begin_secondary_volume_id must also be specified. If this field is not specified, Ansible modules will try to create SVOL ID same as PVOL ID iff available, otherwise it will use the first available LDEV ID.
fence_level string	Fence level. Choices: `"NEVER"` ← (default) `"DATA"` `"STATUS"` `"UNKNOWN"`
is_consistency_group boolean	Specify true for consistency group. Choices: `false` `true`
is_data_reduction_force_copy boolean	Whether to forcibly create a pair. Choices: `false` `true` ← (default)
is_new_group_creation boolean	Specify true for a new copy group name. Choices: `false` `true`
local_device_group_name string	The device group name in the local storage system.
mu_number string	The mirror unit number.
new_volume_size string	Required for resize or expand operation. Value should be grater than the current volume size.
path_group_id integer	Path group ID.
primary_hostgroups list / elements=dictionary	The list of host groups on the primary storage device.
enable_preferred_path boolean	Enables the preferred path for the specified host group. Choices: `false` `true`
lun_id integer	LUN ID.
name string / required	Host group name.
port string / required	Port name.
primary_resource_group_name string	The primary resource group name.
primary_storage_serial_number string	The serial number of the primary storage device.
primary_volume_id integer	Primary Volume ID.
provisioned_secondary_volume_id integer	ID of the provisioned secondary volume that you want to use for the GAD pair creation.
quorum_disk_id integer	The quorum disk ID.
remote_device_group_name string	The device group name in the remote storage system.
secondary_hostgroups list / elements=dictionary	The list of host groups on the secondary storage device.
enable_preferred_path boolean	Enables the preferred path for the specified host group. Choices: `false` `true`
lun_id integer	LUN ID.
name string / required	Host group name.
port string / required	Port name.
secondary_iscsi_targets list / elements=dictionary	The list of iscsi targets on the secondary storage device.
enable_preferred_path boolean	Enables the preferred path for the specified ISCSI target. Choices: `false` `true`
lun_id integer	LUN ID.
name string / required	ISCSI target name.
port string / required	Port name.
secondary_nvm_subsystem dictionary	NVM subsystem details of the secondary volume.
name string / required	Name of the NVM subsystem on the secondary storage system.
paths list / elements=string	Host NQN paths information on the secondary storage system.
secondary_pool_id integer	Pool ID of the secondary storage system.
secondary_resource_group_name string	The secondary resource group name.
secondary_storage_serial_number string	The serial number of the secondary storage device.
set_alua_mode boolean	Set the ALUA mode to True. Choices: `false` `true`
should_delete_svol boolean	Specify true to delete the SVOL. Choices: `false` ← (default) `true`
state string	The level of the GAD pairs task. Choices: `"present"` ← (default) `"absent"` `"split"` `"resync"` `"swap_split"` `"swap_resync"` `"resize"` `"expand"`
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: none	Determines if the module should run in check mode.

Notes

Note

Connection type gateway was removed starting from version 3.4.0. Please use an earlier version if you require this connection type.

Examples

- name: Swap-Split a GAD pair
  hitachivantara.vspone_block.vsp.hv_gad:
    state: "swap_split"
    connection_info:
      address: storage1.company.com
      username: "username"
      password: "password"
    secondary_connection_info:
      address: storage2.company.com
      username: "admin"
      password: "secret"
    spec:
      copy_group_name: "gad_copy_group_name_8"
      copy_pair_name: "gad_copy_pair_name_8"
      local_device_group_name: "gad_local_device_group_name_8"
      remote_device_group_name: "gad_remote_device_group_name_8"

- name: Swap-Resync a GAD pair
  hitachivantara.vspone_block.vsp.hv_gad:
    state: "swap_resync"
    connection_info:
      address: storage2.company.com
      username: "username"
      password: "password"
    secondary_connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      copy_group_name: "gad_copy_group_name_8"
      copy_pair_name: "gad_copy_pair_name_8"
      local_device_group_name: "gad_local_device_group_name_8"
      remote_device_group_name: "gad_remote_device_group_name_8"

- name: Increase size of volumes of a GAD pair
  hitachivantara.vspone_block.vsp.hv_gad:
    state: "resize"
    connection_info:
      address: storage1.company.com
      username: "username"
      password: "password"
    secondary_connection_info:
      address: storage2.company.com
      username: "admin"
      password: "secret"
    spec:
      copy_group_name: "gad_copy_group_name_9"
      copy_pair_name: "gad_copy_pair_name_9"
      new_volume_size: "4GB"

- name: Create a GAD-NVMe pair
  hitachivantara.vspone_block.vsp.hv_gad:
    state: "present"
    connection_info:
      address: storage1.company.com
      username: "username"
      password: "password"
    secondary_connection_info:
      address: storage2.company.com
      username: "admin"
      password: "secret"
    spec:
      copy_group_name: "copy_group_name_1"
      copy_pair_name: "copy_pair_name_1"

      primary_volume_id: 12
      secondary_pool_id: 1
      secondary_nvm_subsystem:
        name: gk-nvm-sub-75
        paths:
          - "nqn.2014-08.com.ucpa-sc-hv:nvme:gk-test-12346"
      quorum_disk_id: 1

- name: Create a GAD-ISCSI pair
  hitachivantara.vspone_block.vsp.hv_gad:
    state: "present"
    connection_info:
      address: storage1.company.com
      username: "username"
      password: "password"
    secondary_connection_info:
      address: storage2.company.com
      username: "admin"
      password: "secret"
    spec:
      copy_group_name: "copy_group_name_1"
      copy_pair_name: "copy_pair_name_1"

      primary_volume_id: 12
      secondary_pool_id: 1
      secondary_iscsi_targets:
        - name: "test"
          port: "CL1-A"
          enable_preferred_path: false
          lun_id: 1
      quorum_disk_id: 1

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
data dictionary	Newly created GAD pair object. 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	SVOL access mode. Returned: success Sample: `"READONLY"`
type string	Type of the GAD pair. Returned: success Sample: `"GAD"`

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