W3cubDocs

/Ansible

hitachivantara.vspone_block.vsp.hv_shadow_image_pair module – Manages shadow image 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_shadow_image_pair.

New in hitachivantara.vspone_block 3.0.0

Synopsis

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.

spec

dictionary / required

Specification for the shadow image pairs task.

allocate_new_consistency_group

boolean

New consistency group.

Choices:

  • false
  • true

auto_split

boolean

Auto split.

Choices:

  • false
  • true

consistency_group_id

integer

Consistency group id.

copy_group_name

string

Copy group name.

copy_pace_track_size

string

Copy pace track size.

Choices:

  • "SLOW"
  • "MEDIUM"
  • "FAST"

copy_pair_name

string

Copy pair name.

create_for_migration

boolean

Specify to create shadow image pair for migration.

Choices:

  • false
  • true

enable_quick_mode

boolean

Enable quick mode.

Choices:

  • false
  • true

enable_read_write

boolean

Enable read write.

Choices:

  • false
  • true

is_data_reduction_force_copy

boolean

Enable data reduction force copy.

Choices:

  • false
  • true

pair_id

string

Pair Id.

primary_volume_device_group_name

string

Primary volume device name.

primary_volume_id

integer

Primary volume id.

secondary_pool_id

integer

Secondary storage pool id.

secondary_volume_device_group_name

string

Secondary volume device name.

secondary_volume_id

integer

Secondary volume id.

should_delete_svol

boolean

Specify to delete SVOL from hostgroup, iSCSI Target, and NVM Subsystem.

Choices:

  • false
  • true

should_force_split

boolean

Specify to force split.

Choices:

  • false
  • true

state

string

The level of the shadow image pairs task. Choices are present, absent, split, restore, sync, migrate.

Choices:

  • "present" ← (default)
  • "absent"
  • "split"
  • "restore"
  • "sync"
  • "migrate"

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

  • The output parameters entitlement_status, subscriber_id and partner_id were removed in version 3.4.0. They were also deprecated due to internal API simplification and are no longer supported.
  • Connection type gateway was removed starting from version 3.4.0. Please use an earlier version if you require this connection type.

Examples

- name: Create shadow image pair for non-existing secondary volume
  hitachivantara.vspone_block.vsp.hv_shadow_image_pair:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: "present"
    spec:
      primary_volume_id: 274
      secondary_pool_id: 1
      allocate_new_consistency_group: true
      copy_pace_track_size: "MEDIUM"
      enable_quick_mode: false
      auto_split: true
      copy_group_name: "CGTest"
      copy_pair_name: "CPTest"
      primary_volume_device_group_name: "CPTestP"
      secondary_volume_device_group_name: "CPTestS"

Return Values

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

Key

Description

data

dictionary

Newly created shadow image pair object.

Returned: success

consistency_group_id

integer

Consistency group id.

Returned: success

Sample: -1

copy_pace_track_size

string

Copy pace track size.

Returned: success

Sample: "MEDIUM"

copy_rate

integer

Copy rate.

Returned: success

Sample: 100

mirror_unit_id

integer

Mirror unit id.

Returned: success

Sample: -1

primary_hex_volume_id

string

Primary hex volume id.

Returned: success

Sample: "00:01:12"

primary_volume_id

integer

Primary volume id.

Returned: success

Sample: 274

pvol_nvm_subsystem_name

string

Primary volume’s nvm subsystem name.

Returned: success

Sample: "smrha-3950276934"

resource_id

string

Resource id.

Returned: success

Sample: "localpair-2749fed78e8d23a61ed17a8af71c85f8"

secondary_hex_volume_id

string

Secondary hex volume id.

Returned: success

Sample: "00:01:17"

secondary_volume_id

integer

Secondary volume id.

Returned: success

Sample: 279

status

string

Status.

Returned: success

Sample: "PAIR"

storage_serial_number

string

Storage serial number.

Returned: success

Sample: "811150"

svol_access_mode

string

Svol access mode.

Returned: success

Sample: "READONLY"

svol_nvm_subsystem_name

string

Secondary volume’s nvm subsystem name.

Returned: success

Sample: "smrha-3950276934"

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)

© 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_shadow_image_pair_module.html