W3cubDocs

/Ansible

hitachivantara.vspone_block.vsp.hv_hur_facts module – Retrieves HUR 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_hur_facts.

New in hitachivantara.vspone_block 3.1.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Returned Facts

Synopsis

This module retrieves information about HURs from Hitachi VSP storage systems.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/hur_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	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.
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.
copy_pair_name string	The copy pair name. If not provided, it will be omitted.
local_device_group_name string	The local device group name. If not provided, it will be omitted.
mirror_unit_id integer	The mirror unit identifier. If not provided, it will be omitted. Choices: `0` `1` `2` `3`
primary_volume_id integer	The primary volume identifier. If not provided, it will be omitted.
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 integer	The secondary volume identifier. If not provided, it will be omitted.
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 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_id: 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	ID of the consistency group. Returned: success Sample: `1`
copy_pace_track_size integer	Size of the copy pace track. Returned: success Sample: `-1`
copy_rate integer	Rate of the copy process. Returned: success Sample: `0`
mirror_unit_id integer	ID of the mirror unit. Returned: success Sample: `1`
primary_hex_volume_id string	Hexadecimal ID of the primary volume. Returned: success Sample: `"00:00:01"`
primary_v_s_m_resource_group_name string	Name of the primary VSM resource group. Returned: success Sample: `""`
primary_virtual_hex_volume_id string	Hexadecimal ID of the primary virtual volume. Returned: success Sample: `"00:00:01"`
primary_virtual_storage_id string	ID of the primary virtual storage. Returned: success Sample: `""`
primary_virtual_volume_id integer	ID of the primary virtual volume. Returned: success Sample: `-1`
primary_volume_id integer	ID of the primary volume. Returned: success Sample: `1`
primary_volume_storage_id integer	Storage ID of the primary volume. Returned: success Sample: `811111`
secondary_hex_volume_id string	Hexadecimal ID of the secondary volume. Returned: success Sample: `"00:00:02"`
secondary_v_s_m_resource_group_name string	Name of the secondary VSM resource group. Returned: success Sample: `""`
secondary_virtual_hex_volume_id string	Hexadecimal ID of the secondary virtual volume. Returned: success Sample: `"-1"`
secondary_virtual_storage_id string	ID of the secondary virtual storage. Returned: success Sample: `""`
secondary_virtual_volume_id integer	ID of the secondary virtual volume. Returned: success Sample: `-1`
secondary_volume_id integer	ID of the secondary volume. Returned: success Sample: `2`
secondary_volume_storage_id integer	Storage ID of the secondary volume. Returned: success Sample: `811112`
status string	Status of the HUR. Returned: success Sample: `"PAIR"`
storage_serial_number string	Serial number of the storage system. Returned: success Sample: `"811111"`
svol_access_mode string	Access mode of the secondary volume. Returned: success Sample: `"READONLY"`
type string	Type of the HUR. Returned: success Sample: `"HUR"`

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/ansible/latest/collections/hitachivantara/vspone_block/vsp.hv_hur_facts_module.html