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

New in hitachivantara.vspone_block 3.1.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Returned Facts

Synopsis

This module retrieves the TrueCopy pairs information from VSP block storage systems.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/truecopy_facts.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.
connection_type string	Type of connection to the storage system. Choices: `"direct"` ← (default)
password string	Password for authentication. This is a required field.
username string	Username for authentication. This is a required field.
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. Required for the Get TrueCopy pair by copy group name task.
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 string	ID of the primary volume to retrieve TrueCopy pair information for. Required for the Get TrueCopy pair by primary volume ID task.
remote_device_group_name string	Name of the remote device group to retrieve TrueCopy pair information for.
secondary_volume_id string	ID of the secondary volume to retrieve TrueCopy pair information for. Required for the Get TrueCopy pair by secondary volume ID task.
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.
Currently, only pairs that belong to a copy group are retrieved. Therefore, it is recommended to delete any existing pair that is not part of a copy group and re-create the replication pairs using direct connect with copy group technology.
When working with remote replication facts (GAD, HUR, TC), it’s best practice to use the task that specifies the copy group name. For example, Get TrueCopy pair by copy group name.

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 string	Consistency Group ID. Returned: success Sample: `""`
copy_group_name string	Name of the copy group. Returned: success Sample: `"cp_group_840"`
copy_pair_name string	Name of the copy pair. Returned: success Sample: `"gad_pair_840"`
copy_progress_rate integer	Deprecated. Copy progress rate. Returned: success Sample: `-1`
fence_level string	Fence level. Returned: success Sample: `"NEVER"`
local_device_group_name string	Name of the local device group to retrieve TrueCopy pair information for. Returned: success Sample: `"tc_bulk_cg_1P_"`
primary_volume_id integer	Primary volume ID. Returned: success Sample: `840`
primary_volume_id_hex string	Primary volume ID in hexadecimal format. Returned: success Sample: `"00:03:48"`
primary_volume_size string	Size of the primary volume. Display only for single TrueCopy pair query. Returned: success Sample: `"4.00GB"`
primary_volume_status string	Primary volume status. Returned: success Sample: `"PAIR"`
primary_volume_storage_serial_number string	Storage serial number of the primary volume. Returned: success Sample: `"810050"`
pvol_status string	Deprecated. Use primary_volume_status instead. Returned: success Sample: `"PAIR"`
pvol_storage_device_id string	Deprecated. PVOL storage device ID. Returned: success Sample: `"A34000810050"`
remote_device_group_name string	Name of the remote device group to retrieve TrueCopy pair information for. Returned: success Sample: `"tc_bulk_cg_1S_"`
remote_mirror_copy_pair_id string	Deprecated. Remote mirror copy pair ID. Returned: success Sample: `"A34000810050,cp_group_840,cp_group_840S_,cp_group_840P_,gad_pair_840"`
secondary_volume_id integer	Secondary volume ID. Returned: success Sample: `831`
secondary_volume_id_hex string	Secondary volume ID in hexadecimal format. Returned: success Sample: `"00:03:3F"`
secondary_volume_size string	Size of the secondary volume. Display only for single TrueCopy pair query. Returned: success Sample: `"4.00GB"`
secondary_volume_status string	Secondary volume status. Returned: success Sample: `"PAIR"`
secondary_volume_storage_serial_number string	Storage serial number of the secondary volume. Returned: success Sample: `"810045"`
storage_serial_number string	Deprecated. Use primary_volume_storage_serial_number instead. Returned: success Sample: `"810050"`
svol_status string	Deprecated. Use secondary_volume_status instead. Returned: success Sample: `"PAIR"`
svol_storage_device_id string	Deprecated. SVOL storage device ID. Returned: success Sample: `"A34000810045"`

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