hitachivantara.vspone_block.vsp.hv_remote_copy_group_facts module – Retrieves Remote Copy Groups information from VSP block storage systems.

Note

This module is part of the hitachivantara.vspone_block collection (version 4.9.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_remote_copy_group_facts.

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

Token used to operate on locked resources.

ca_cert

string

Path to a CA certificate file or directory on the Ansible control node used to verify the storage system SSL certificate.

Required when connection_info.validate_cert is true and the storage system uses a self-signed or privately issued certificate.

Accepts a PEM file path or a directory of hashed CA certificates.

client_cert

string

Path to client SSL certificate file or CA certificate directory for mutual TLS authentication.

Must be provided together with connection_info.client_key.

client_key

string

Path to the client private key file for mutual TLS authentication.

Must be provided together with connection_info.client_cert.

password

string

Password for authentication. This is a required field.

suppress_validate_cert_warning

boolean

Whether to suppress the SSL certificate validation warning.

When set to false (default), a warning is displayed if certificate validation is disabled.

Set to true to suppress the warning.

Choices:

  • false ← (default)

  • true

username

string

Username for authentication. This is a required field.

validate_cert

boolean

Whether to validate the storage system SSL certificate.

When set to false (default), certificate validation is disabled. A security warning will be displayed unless connection_info.suppress_validate_cert_warning is true.

Set to true to enable certificate validation. When true, provide connection_info.ca_cert if the storage system uses a self-signed certificate.

Note: Starting with major version 5.0, the default value will change to true. It is strongly recommended to enable certificate validation in production environments.

Choices:

  • false ← (default)

  • true

secondary_connection_info

dictionary / required

Information required to establish a connection to the secondary storage system.

address

string / required

IP address or hostname of storage system.

api_token

string

Value of the lock token to operate on locked resources.

ca_cert

string

Path to a CA certificate file or directory on the Ansible control node used to verify the storage system SSL certificate.

Required when connection_info.validate_cert is true and the storage system uses a self-signed or privately issued certificate.

Accepts a PEM file path or a directory of hashed CA certificates.

client_cert

string

Path to client SSL certificate file or CA certificate directory for mutual TLS authentication.

Must be provided together with connection_info.client_key.

client_key

string

Path to the client private key file for mutual TLS authentication.

Must be provided together with connection_info.client_cert.

password

string

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

suppress_validate_cert_warning

boolean

Whether to suppress the SSL certificate validation warning.

When set to false (default), a warning is displayed if certificate validation is disabled.

Set to true to suppress the warning.

Choices:

  • false ← (default)

  • true

username

string

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

validate_cert

boolean

Whether to validate the storage system SSL certificate.

When set to false (default), certificate validation is disabled. A security warning will be displayed unless connection_info.suppress_validate_cert_warning is true.

Set to true to enable certificate validation. When true, provide connection_info.ca_cert if the storage system uses a self-signed certificate.

Note: Starting with major version 5.0, the default value will change to true. It is strongly recommended to enable certificate validation in production environments.

Choices:

  • false ← (default)

  • true

spec

dictionary

Specification for the Remote Copy Group facts to be gathered.

name

string

The remote copy group name. If not provided, list of all copy groups will be returned. Required for the Get one remote copy group using copy group name /Get one remote copy group details using copy group name tasks.

should_include_remote_replication_pairs

boolean

Whether we want to get all replication pairs from a specific copy group. Should be specified along with the ‘name’ parameter in spec. Required for the Get one remote copy group details using copy group name task.

Choices:

  • false

  • true

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 Remote Copy Groups
  hitachivantara.vspone_block.vsp.hv_remote_copy_group_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"

- name: Get one Remote Copy Group
  hitachivantara.vspone_block.vsp.hv_remote_copy_group_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    spec:
      name: "copygroup1"

- name: Get one Remote Copy Group detail
  hitachivantara.vspone_block.vsp.hv_remote_copy_group_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    spec:
      name: "copygroup1"
      should_include_remote_replication_pairs: true

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

remote_copy_groups

list / elements=dictionary

A list of copy groups gathered from the storage system.

Returned: success

copy_group_name

string

The name of the copy group.

Returned: success

Sample: "copygroup1"

local_device_group_name

string

The name of the local device group.

Returned: success

Sample: "copygroup1P_"

mirror_unit_id

integer

The ID of the mirror unit.

Returned: success

Sample: 0

remote_device_group_name

string

The name of the remote device group.

Returned: success

Sample: "copygroup1S_"

remote_mirror_copy_group_id

string

The ID of the remote mirror copy group.

Returned: success

Sample: "A34000811112,copygroup1,copygroup1P_,copygroup1S_"

remote_storage_device_id

string

The ID of the remote storage device.

Returned: success

Sample: "A34000811112"

storage_serial_number

string

The serial number of the storage system.

Returned: success

Sample: "811150"

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)