hitachivantara.vspone_block.vsp.hv_shadow_image_group module – Manages Remote Copy Group on VSP block 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_shadow_image_group.

New in hitachivantara.vspone_block 3.2.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Return Values

Synopsis

- This module allows for the splitting, re-syncing, restore, deletion and migration of Shadow Image Group on VSP block 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.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.
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. Required for the Split ShadowImage Group /Resync ShadowImage Group /Restore ShadowImage Group /Delete ShadowImage Group /Migrate ShadowImage Group /Cancel Migration of ShadowImage Group tasks.
copy_pace integer	Specify the copy pace. Optional for the Split ShadowImage Group /Resync ShadowImage Group /Restore ShadowImage Group tasks.
force_delete boolean	Specify whether force delete. Required for the Delete ShadowImage Group task. Choices: `false` `true`
force_suspend boolean	Specify whether force suspend. Optional for the Split ShadowImage Group task. Choices: `false` `true`
primary_volume_device_group_name string	Specify the P-VOL device group name .
quick_mode boolean	Specify whether quick mode. Optional for the Split ShadowImage Group /Resync ShadowImage Group /Restore ShadowImage Group tasks. Choices: `false` `true`
secondary_volume_device_group_name string	Specify the S-VOL device group name .
should_force_split boolean	Specify whether to force split. Optional for the Cancel Migration of ShadowImage Group task. Choices: `false` `true`
state string	The level of the Shadow Image Group pairs task. Choices are `present`, `absent`, `split`, `sync`, `restore`, `migrate`. Choices: `"present"` ← (default) `"absent"` `"split"` `"resync"` `"sync"` `"restore"` `"migrate"`

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

- name: Migrate local copy group
  hitachivantara.vspone_block.vsp.hv_shadow_image_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: migrate
    spec:
      copy_group_name: remote_copy_group_copy_group_name_1

- name: Cancel migration of 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
      should_force_split: true

Return Values

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

Key	Description
local_copy_group_info dictionary	Details of the Shadow Image Group. Returned: success
copy_group_name string	Copy group name. Returned: success Sample: `"SI172"`
copy_pairs list / elements=dictionary	List of copy pairs in the copy group. Returned: success
consistency_group_id string	Consistency group ID. Returned: success Sample: `""`
copy_group_name string	Copy group name. Returned: success Sample: `"SI172"`
copy_mode string	Copy mode. Returned: success Sample: `"NotSnapshot"`
copy_pair_name string	Copy pair name. Returned: success Sample: `"CPTest"`
copy_progress_rate integer	Copy progress rate. Returned: success Sample: `100`
local_clone_copypair_id string	Local clone copy pair ID. Returned: success Sample: `"SI172,SI172P_,SI172S_,CPTest"`
mirror_unit_number integer	Mirror unit number. Returned: success Sample: `0`
primary_volume_id integer	Primary volume ID. Returned: success Sample: `172`
primary_volume_status string	Primary volume status. Returned: success Sample: `"PSUS"`
pvol_difference_data_management string	Deprecated. PVOL difference data management. Returned: success Sample: `"S"`
pvol_ldev_id integer	Deprecated. Use primary_volume_id instead. Returned: success Sample: `172`
pvol_mu_number integer	Deprecated. Use mirror_unit_number instead. Returned: success Sample: `0`
pvol_processing_status string	Deprecated. PVOL processing status. Returned: success Sample: `"N"`
pvol_status string	Deprecated. Use primary_volume_status instead. Returned: success Sample: `"PSUS"`
replication_type string	Replication type. Returned: success Sample: `"SI"`
secondary_volume_id integer	Secondary volume ID. Returned: success Sample: `173`
secondary_volume_status string	Secondary volume status. Returned: success Sample: `"SSUS"`
svol_difference_data_management string	Deprecated. SVOL difference data management. Returned: success Sample: `"S"`
svol_ldev_id integer	Deprecated. Use secondary_volume_id instead. Returned: success Sample: `173`
svol_processing_status string	Deprecated. SVOL processing status. Returned: success Sample: `"N"`
svol_status string	Deprecated. Use secondary_volume_status instead. Returned: success Sample: `"SSUS"`
local_clone_copygroup_id string	Local clone copy group ID. Returned: success Sample: `"SI172,SI172P_,SI172S_"`
primary_volume_device_group_name string	Primary volume device group name. Returned: success Sample: `"SI172P_"`
pvol_device_group_name string	Deprecated. Use primary_volume_device_group_name instead. Returned: success Sample: `"SI172P_"`
secondary_volume_device_group_name string	Secondary volume device group name. Returned: success Sample: `"SI172S_"`
svol_device_group_name string	Deprecated. Use secondary_volume_device_group_name instead. Returned: success Sample: `"SI172S_"`

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