hitachivantara.vspone_block.vsp.hv_hur_facts module – Retrieves HUR information from VSP block storage systems.

Note

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

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 secondary storage system.

api_token

string

Value of the lock token to operate on locked resources.

password

string

Password for authentication for the secondary storage system if api_token is not provided.

username

string

Username for authentication for the secondary storage system if api_token is not provided.

spec

dictionary

Specification for the HUR facts to be gathered.

copy_group_name

string

The copy group name. If not provided, it will be omitted. Required for the Get HUR pair using copy group /Get HUR pair using copy group and copy pair name tasks.

copy_pair_name

string

The copy pair name. If not provided, it will be omitted. Required for the Get HUR pair using copy group and copy pair name task.

local_device_group_name

string

The local device group name. If not provided, it will be omitted.

mirror_unit_number

aliases: mirror_unit_id

integer

The mirror unit number. If not provided, it will be omitted.

Choices:

  • 0

  • 1

  • 2

  • 3

primary_volume_id

string

The primary volume identifier. If not provided, it will be omitted. Required for the Get HUR pair using primary volume ID task.

remote_device_group_name

string

The remote device group name. If not provided, it will be omitted.

secondary_storage_serial_number

integer

The secondary storage serial number. If not provided, it will be omitted.

secondary_volume_id

string

The secondary volume identifier. If not provided, it will be omitted. Optional for the Get HUR pair using 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 HUR pair using copy group.

Examples

- name: Get all HUR 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: Gather HUR facts with primary volume and mirror unit ID
  hitachivantara.vspone_block.vsp.hv_hur_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: 111
      mirror_unit_number: 10

- name: Gather HUR facts for a specific primary volume
  hitachivantara.vspone_block.vsp.hv_hur_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: 111

- name: Gather HUR facts for a specific secondary volume
  hitachivantara.vspone_block.vsp.hv_hur_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    secondary_connection_info:
      address: storage2.company.com
      username: "admin"
      password: "secret"
    spec:
      secondary_volume_id: 111

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

hurs

list / elements=dictionary

A list of HURs gathered from the storage system.

Returned: success

consistency_group_id

integer

Consistency Group ID.

Returned: success

Sample: 39

copy_group_name

string

Name of the copy group.

Returned: success

Sample: "spcA34000810045A34000810050"

copy_pair_name

string

Name of the copy pair.

Returned: success

Sample: "spc-7331-6442"

copy_rate

integer

Deprecated. Copy rate.

Returned: success

Sample: -1

fence_level

string

Fence level.

Returned: success

Sample: "ASYNC"

local_device_group_name

string

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

Returned: success

Sample: "hur_bulk_cg_1P_"

mirror_unit_id

integer

Deprecated. Use mirror_unit_number instead

Returned: success

Sample: 1

mirror_unit_number

integer

Mirror unit number.

Returned: success

Sample: 1

primary_journal_id

integer

Primary journal Id.

Returned: success

Sample: 25

primary_journal_pool

integer

Deprecated. Use primary_journal_id instead.

Returned: success

Sample: 25

primary_volume_id

integer

Primary volume ID.

Returned: success

Sample: 6442

primary_volume_id_hex

string

Hexadecimal representation of the primary volume ID.

Returned: success

Sample: "00:19:2A"

primary_volume_status

string

Primary volume status.

Returned: success

Sample: "PAIR"

primary_volume_storage_id

string

Deprecated. Use primary_volume_storage_serial_number instead.

Returned: success

Sample: "810050"

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: "hur_bulk_cg_1S_"

remote_mirror_copy_pair_id

string

Deprecated. Remote mirror copy pair ID.

Returned: success

Sample: "A34000810050,spcA34000810045A34000810050,spcA34000810045A34000810050,spcA34000810050A34000810045,spc-7331-6442"

secondary_journal_id

integer

Secondary journal ID.

Returned: success

Sample: 25

secondary_journal_pool

integer

Deprecated. Use secondary_journal_id instead.

Returned: success

Sample: 25

secondary_volume_id

integer

Secondary volume ID.

Returned: success

Sample: 7331

secondary_volume_id_hex

string

Hexadecimal representation of the secondary volume ID.

Returned: success

Sample: "00:1C:A3"

secondary_volume_storage_id

string

Deprecated. Use secondary_volume_storage_serial_number instead.

Returned: success

Sample: "810045"

secondary_volume_storage_serial_number

string

Storage serial number of the secondary volume.

Returned: success

Sample: "810045"

svol_status

string

SVOL status.

Returned: success

Sample: "PAIR"

svol_storage_device_id

string

Deprecated. SVOL storage device ID.

Returned: success

Sample: "A34000810045"

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)