W3cubDocs

/Ansible

hitachivantara.vspone_block.vsp.hv_truecopy_facts module – Retrieves TrueCopy pairs information from 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_truecopy_facts.

New in hitachivantara.vspone_block 3.1.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 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.

secondary_connection_info

dictionary

Information required to establish a connection to the secondary 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 of the secondary storage to operate on locked resources.

password

string

Password for authentication. This field is a required field if api_token is not provided.

username

string

Username for authentication. This field is a required field if api_token is not provided.

spec

dictionary

Specification for retrieving TrueCopy pair information.

copy_group_name

string

Name of the copy group to retrieve TrueCopy pair information for.

copy_pair_name

string

Name of the copy pair to retrieve TrueCopy pair information for.

local_device_group_name

string

Name of the local device group to retrieve TrueCopy pair information for.

primary_volume_id

integer

ID of the primary volume to retrieve TrueCopy pair information for.

remote_device_group_name

string

Name of the remote device group to retrieve TrueCopy pair information for.

secondary_volume_id

integer

ID of the secondary volume to retrieve TrueCopy pair information for.

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

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: Get all TrueCopy pairs
  hitachivantara.vspone_block.vsp.hv_truecopy_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    secondary_connection_info:
      address: storage2.company.com
      username: "admin"
      password: "secret"

- name: Retrieve TrueCopy pair information for a specific volume
  hitachivantara.vspone_block.vsp.hv_truecopy_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    secondary_connection_info:
      address: storage2.company.com
      username: "admin"
      password: "secret"
    spec:
      primary_volume_id: 123

Returned Facts

Facts returned by this module are added/updated in the hostvars host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them.

Key

Description

truecopy_pairs

list / elements=dictionary

A list of TrueCopy pairs information.

Returned: success

consistency_group_id

integer

ID of the consistency group.

Returned: success

Sample: -1

copy_rate

integer

Copy rate of the TrueCopy pair.

Returned: success

Sample: 100

mirror_unit_id

integer

ID of the mirror unit.

Returned: success

Sample: 0

pair_name

string

Name of the TrueCopy pair.

Returned: success

Sample: ""

primary_hex_volume_id

string

Hexadecimal ID of the primary volume.

Returned: success

Sample: "00:05:01"

primary_volume_id

integer

ID of the primary volume.

Returned: success

Sample: 1281

primary_volume_storage_id

integer

Storage ID of the primary volume.

Returned: success

Sample: 810050

resource_id

string

Resource ID of the TrueCopy pair.

Returned: success

Sample: "replpair-037f68f4f56351b2de6a68ff5dc0cdeb"

secondary_hex_volume_id

string

Hexadecimal ID of the secondary volume.

Returned: success

Sample: "00:00:82"

secondary_volume_id

integer

ID of the secondary volume.

Returned: success

Sample: 130

secondary_volume_storage_id

integer

Storage ID of the secondary volume.

Returned: success

Sample: 810045

status

string

Status of the TrueCopy pair.

Returned: success

Sample: "PSUS"

storage_id

string

Storage ID of the TrueCopy pair.

Returned: success

Sample: "storage-b2c93d5e8fadb70b208341b0e19c6527"

storage_serial_number

string

Serial number of the storage.

Returned: success

Sample: "810050"

svol_access_mode

string

Access mode of the secondary volume.

Returned: success

Sample: "READWRITE"

type

string

Type of the TrueCopy pair.

Returned: success

Sample: "truecopypair"

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