hitachivantara.vspone_block.vsp.hv_shadow_image_group module – Manages Remote Copy Group on Hitachi VSP storage systems.

Note

This module is part of the hitachivantara.vspone_block collection (version 3.4.0).

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_shadow_image_group.

New in hitachivantara.vspone_block 3.2.0

Synopsis

• • This module allows for the splitting, re-syncing, restore and deletion of Shadow Image Group on Hitachi VSP storage systems. - It supports various Shadow image 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/shadow_image_group.yml

Requirements

The below requirements are needed on the host that executes this module.

• python >= 3.8

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 Hitachi 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.
username string	Username for authentication. This is a required field.
spec dictionary / required	Specification for the Shadow Image Group task.
copy_group_name string / required	Copy group name, required for all operations.
copy_pace integer	Specify the copy pace.
force_delete boolean	Specify whether force delete. Choices: false true
force_suspend boolean	Specify whether force suspend. Choices: false true
primary_volume_device_group_name string	Specify the P-VOL device group name .
quick_mode boolean	Specify whether quick mode. Choices: false true
secondary_volume_device_group_name string	Specify the S-VOL device group name .
state string	The level of the Shadow Image Group pairs task. Choices are present, absent, split, sync, restore. Choices: "present" ← (default) "absent" "split" "resync" "sync" "restore"

Attributes

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

Examples

- name: Split local copy group
  hitachivantara.vspone_block.vsp.hv_shadow_image_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: split
    spec:
      copy_group_name: remote_copy_group_copy_group_name_1
      primary_volume_device_group_name: remote_copy_group_local_device_group_name_1
      secondary_volume_device_group_name: remote_copy_group_remote_device_group_name_1
      quick_mode: true
      copy_pace: 100
      force_suspend: true

- name: Resync local copy group
  hitachivantara.vspone_block.vsp.hv_shadow_image_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: sync
    spec:
      copy_group_name: remote_copy_group_copy_group_name_1
      primary_volume_device_group_name: remote_copy_group_local_device_group_name_1
      secondary_volume_device_group_name: remote_copy_group_remote_device_group_name_1
      quick_mode: true
      copy_pace: 100

- name: Restore local copy group
  hitachivantara.vspone_block.vsp.hv_shadow_image_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: swap_split
    spec:
      copy_group_name: remote_copy_group_copy_group_name_1
      primary_volume_device_group_name: remote_copy_group_local_device_group_name_1
      secondary_volume_device_group_name: remote_copy_group_remote_device_group_name_1
      quick_mode: true
      copy_pace: 100

- name: Delete local copy group
  hitachivantara.vspone_block.vsp.hv_shadow_image_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: absent
    spec:
      copy_group_name: remote_copy_group_copy_group_name_1
      primary_volume_device_group_name: remote_copy_group_local_device_group_name_1
      secondary_volume_device_group_name: remote_copy_group_remote_device_group_name_1
      force_delete: true

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_mode string	Copy mode. Returned: success Sample: ""
copy_pair_name string	Copy pair name. Returned: success Sample: "copypairname00190"
copy_progress_rate integer	Copy progress rate. Returned: success Sample: 0
local_clone_copypair_id string	Local clone copy pair ID. Returned: success Sample: ""
pvol_difference_data_management string	PVOL difference data management. Returned: success Sample: "S"
pvol_ldev_id integer	PVOL LDEV ID. Returned: success Sample: 1872
pvol_mu_number integer	PVOL MU number. Returned: success Sample: 0
pvol_processing_status string	PVOL processing status. Returned: success Sample: "N"
pvol_status string	PVOL status. Returned: success Sample: "PSUS"
replication_type string	Replication type. Returned: success Sample: "UR"
svol_difference_data_management string	SVOL difference data management. Returned: success Sample: "S"
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"
local_clone_copy_group_id string	Local clone copy group ID. Returned: success Sample: "copygroupname001"
primary_volume_device_group_name string	P-VOL device group name. Returned: success Sample: "copygroupname001"
secondary_volume_device_group_name string	S-VOL device group name. Returned: success Sample: "copygroupname001"

Authors

• Hitachi Vantara, LTD. (@hitachi-vantara)

Collection links

• Issue Tracker
• Repository (Sources)