W3cubDocs

/Ansible

hitachivantara.vspone_block.vsp.hv_remote_copy_group module – Manages Remote Copy Group 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_remote_copy_group.

New in hitachivantara.vspone_block 3.2.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Return Values

Synopsis

- This module allows for the splitting, swap-splitting, re-syncing, swap-resyncing and deletion of Remote Copy Group on Hitachi VSP storage systems. - It supports various remote copy pairs operations based on the specified task level. - The module supports the following replication types: HUR, TC, GAD. - For examples go to URL
https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/remote_copy_group.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.
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 / required	Information required to establish a connection to the secondary storage system.
address string / required	IP address or hostname of the secondary storage system.
api_token string	Value of the lock token to operate on locked resources.
password string	Password for authentication for secondary storage. This is a required field if api_token is not provided.
username string	Username for authentication for secondary storage. This is a required field if api_token is not provided.
spec dictionary / required	Specification for the Remote Copy Group task.
consistency_group_id integer	For TC, specify the consistency group ID by using a decimal number in the range from 0 to 255.
copy_group_name string / required	Copy group name, required for all operations.
copy_pace integer	For TC, specify a decimal number in the range from 1 to 15 for the size of tracks to be copied. The larger the value you specify, the faster the copy speed.
do_data_suspend boolean	For UR, specify whether to forcibly stop operations on a journal when the amount of access to the journal increases. Choices: `false` `true`
do_failback boolean	Specify whether to perform a failback if a failure occurs in a 3DC cascade configuration. If set to true, the failback is performed. If set to false, the failback is not performed. If the value is omitted, false is assumed. Choices: `false` ← (default) `true`
do_pvol_write_protect boolean	For TC, specify whether to forcibly disable write operations for the P-VOL. Choices: `false` `true`
failback_mirror_unit_number integer	Specify the MU (mirror unit) number of the volume to be failed back. You can specify this attribute only if the do_failback attribute is set to true.
fence_level string	Specifies the primary volume fence level setting and determines if the host is denied access or continues to access the primary volume when the pair is suspended because of an error. Choices: `"NEVER"` `"DATA"` `"STATUS"`
is_consistency_group boolean	For TC, specify the value as follows according to whether the pair is registered in a consistency group. If the pair is not registered in a consistency group true - Registers the pair in a consistency group. false - Leaves the pair as it is without registering it in a consistency group. If the pair is registered in a consistency group true - Leaves the pair registered in a consistency group. false - Cancels the registration of the pair in a consistency group, and places it in an unregistered state. Choices: `false` `true`
is_svol_writable boolean	Whether svol is writable or not. Choices: `false` `true`
local_device_group_name string	Device group name in the local storage system.
remote_device_group_name string	Device group name in the remote storage system.
replication_type string	Replication type, either `UR`, `TC` or `GAD`. Choices: `"UR"` `"TC"` `"GAD"`
svol_operation_mode string	Specify this attribute to forcibly change the status of the pairs of the S-VOL in cases such as if a failure occurs in the storage system of the primary site.
state string	The level of the Remote Copy Group pairs task. Choices are `present`, `absent`, `split`, `resync`, `swap_split`, `swap_resync`. Choices: `"present"` ← (default) `"absent"` `"split"` `"resync"` `"swap_split"` `"swap_resync"`
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: Split remote copy group for HUR
  hitachivantara.vspone_block.vsp.hv_remote_copy_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: split
    spec:
      local_device_group_name: remote_copy_group_local_device_group_name_1
      remote_device_group_name: remote_copy_group_remote_device_group_name_1
      copy_group_name: remote_copy_group_copy_group_name_1
      replication_type: hur
      is_svol_writable: false
      do_data_suspend: false

- name: Resync remote copy group for HUR
  hitachivantara.vspone_block.vsp.hv_remote_copy_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: resync
    spec:
      local_device_group_name: remote_copy_group_local_device_group_name_1
      remote_device_group_name: remote_copy_group_remote_device_group_name_1
      copy_group_name: remote_copy_group_copy_group_name_1
      replication_type: hur

- name: Swap split remote copy group for HUR
  hitachivantara.vspone_block.vsp.hv_remote_copy_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: swap_split
    spec:
      local_device_group_name: remote_copy_group_local_device_group_name_1
      remote_device_group_name: remote_copy_group_remote_device_group_name_1
      copy_group_name: remote_copy_group_copy_group_name_1
      replication_type: hur

- name: Swap resync remote copy group for HUR
  hitachivantara.vspone_block.vsp.hv_remote_copy_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: swap_resync
    spec:
      local_device_group_name: remote_copy_group_local_device_group_name_1
      remote_device_group_name: remote_copy_group_remote_device_group_name_1
      copy_group_name: remote_copy_group_copy_group_name_1
      replication_type: hur

- name: Delete remote copy group for HUR
  hitachivantara.vspone_block.vsp.hv_remote_copy_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: absent
    spec:
      copy_group_name: remote_copy_group_copy_group_name_1

- name: Split remote copy group for TrueCopy
  hitachivantara.vspone_block.vsp.hv_remote_copy_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: split
    spec:
      local_device_group_name: remote_copy_group_local_device_group_name_1
      remote_device_group_name: remote_copy_group_remote_device_group_name_1
      copy_group_name: remote_copy_group_copy_group_name_1
      replication_type: TC
      is_svol_writable: false
      do_pvol_write_protect: false

- name: Resync remote copy group for TrueCopy
  hitachivantara.vspone_block.vsp.hv_remote_copy_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: resync
    spec:
      local_device_group_name: remote_copy_group_local_device_group_name_1
      remote_device_group_name: remote_copy_group_remote_device_group_name_1
      copy_group_name: remote_copy_group_copy_group_name_1
      replication_type: TC
      is_consistency_group: true
      consistency_group_id: 47
      fence_level: NEVER
      copy_pace: 3

- name: Swap split remote copy group for TrueCopy
  hitachivantara.vspone_block.vsp.hv_remote_copy_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: swap_split
    spec:
      local_device_group_name: remote_copy_group_local_device_group_name_1
      remote_device_group_name: remote_copy_group_remote_device_group_name_1
      copy_group_name: remote_copy_group_copy_group_name_1
      replication_type: TC

- name: Swap resync remote copy group for TrueCopy
  hitachivantara.vspone_block.vsp.hv_remote_copy_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: swap_resync
    spec:
      local_device_group_name: remote_copy_group_local_device_group_name_1
      remote_device_group_name: remote_copy_group_remote_device_group_name_1
      copy_group_name: remote_copy_group_copy_group_name_1
      replication_type: TC

- name: Delete remote copy group for TrueCopy
  hitachivantara.vspone_block.vsp.hv_remote_copy_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: absent
    spec:
      copy_group_name: remote_copy_group_copy_group_name_1

- name: Split remote copy group for GAD
  hitachivantara.vspone_block.vsp.hv_remote_copy_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: split
    spec:
      local_device_group_name: remote_copy_group_local_device_group_name_1
      remote_device_group_name: remote_copy_group_remote_device_group_name_1
      copy_group_name: remote_copy_group_copy_group_name_1
      replication_type: GAD

- name: Resync remote copy group for GAD
  hitachivantara.vspone_block.vsp.hv_remote_copy_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: resync
    spec:
      local_device_group_name: remote_copy_group_local_device_group_name_1
      remote_device_group_name: remote_copy_group_remote_device_group_name_1
      copy_group_name: remote_copy_group_copy_group_name_1
      replication_type: GAD
      is_consistency_group: true
      consistency_group_id: 47

- name: Swap split remote copy group for GAD
  hitachivantara.vspone_block.vsp.hv_remote_copy_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: swap_split
    spec:
      local_device_group_name: remote_copy_group_local_device_group_name_1
      remote_device_group_name: remote_copy_group_remote_device_group_name_1
      copy_group_name: remote_copy_group_copy_group_name_1
      replication_type: GAD

- name: Swap resync remote copy group for GAD
  hitachivantara.vspone_block.vsp.hv_remote_copy_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: swap_resync
    spec:
      local_device_group_name: remote_copy_group_local_device_group_name_1
      remote_device_group_name: remote_copy_group_remote_device_group_name_1
      copy_group_name: remote_copy_group_copy_group_name_1
      replication_type: GAD

- name: Delete remote copy group for GAD
  hitachivantara.vspone_block.vsp.hv_remote_copy_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: absent
    spec:
      copy_group_name: remote_copy_group_copy_group_name_1

Return Values

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

Key	Description
data dictionary	Newly created remote copy group object. Returned: success
copy_group_name string	Copy group name. Returned: success Sample: `"copygroupname001"`
copy_pairs list / elements=dictionary	List of copy pairs in the copy group. Returned: success
consistency_group_id integer	Consistency group ID. Returned: success Sample: `51`
copy_group_name string	Copy group name. Returned: success Sample: `"copygroupname001"`
copy_pair_name string	Copy pair name. Returned: success Sample: `"copypairname00190"`
fence_level string	Fence level. Returned: success Sample: `"ASYNC"`
pvol_difference_data_management string	PVOL difference data management. Returned: success Sample: `"S"`
pvol_i_o_mode string	PVOL I/O mode. Returned: success
pvol_journal_id integer	PVOL journal ID. Returned: success Sample: `37`
pvol_ldev_id integer	PVOL LDEV ID. Returned: success Sample: `1872`
pvol_processing_status string	PVOL processing status. Returned: success Sample: `"N"`
pvol_status string	PVOL status. Returned: success Sample: `"PSUS"`
pvol_storage_device_id string	PVOL storage device ID. Returned: success Sample: `"900000040014"`
quorum_disk_id string	Quorum disk ID. Returned: success
remote_mirror_copy_pair_id string	Remote mirror copy pair ID. Returned: success Sample: `"900000040015,copygroupname001,copygroupname001P_,copygroupname001S_,copypairname00190"`
replication_type string	Replication type. Returned: success Sample: `"UR"`
svol_difference_data_management string	SVOL difference data management. Returned: success Sample: `"S"`
svol_i_o_mode string	SVOL I/O mode. Returned: success
svol_journal_id integer	SVOL journal ID. Returned: success Sample: `40`
svol_ldev_id integer	SVOL LDEV ID. Returned: success Sample: `2180`
svol_processing_status string	SVOL processing status. Returned: success Sample: `"N"`
svol_status string	SVOL status. Returned: success Sample: `"SSUS"`
svol_storage_device_id string	SVOL storage device ID. Returned: success Sample: `"900000040015"`
local_device_group_name string	Local device group name. Returned: success Sample: `"copygroupname001P_"`
remote_device_group_name string	Remote device group name. Returned: success Sample: `"copygroupname001S_"`
remote_mirror_copy_group_id string	Remote mirror copy group ID. Returned: success Sample: `"900000040015,copygroupname001,copygroupname001P_,copygroupname001S_"`
remote_storage_device_id string	Remote storage device ID. Returned: success Sample: `"900000040015"`

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