W3cubDocs

/Ansible

hitachivantara.vspone_block.vsp.hv_remote_storage_registration_facts module – Retrieves remote storage registration 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_remote_storage_registration_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

This field is used to pass the value of the lock token to operate on locked resources.

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 / 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.

password

string

Password for authentication.

username

string

Username for authentication.

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: Remote Storage Registration Facts
  hitachivantara.vspone_block.vsp.hv_remote_storage_registration_facts:
    connection_info:
      address: 172.0.0.2
      username: "admin"
      password: "password"
    secondary_connection_info:
      address: 172.0.0.3
      username: "admin"
      password: "password"

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_storage

list / elements=dictionary

A list of information about the storage systems registered on the REST API server.

Returned: success

communication_modes

list / elements=dictionary

List of communication modes for the storage system.

Returned: success

communicationMode

string

Mode of communication.

Returned: success

Sample: "lanConnectionMode"

ctl1_ip

string

IP address of controller 1.

Returned: success

Sample: "172.0.0.127"

ctl2_ip

string

IP address of controller 2.

Returned: success

Sample: "172.0.0.128"

dkc_type

string

Type of the storage system.

Returned: success

Sample: "Local"

model

string

Model of the storage system.

Returned: success

Sample: "VSP E1090H"

rest_server_ip

string

IP address of the REST API server.

Returned: success

Sample: "172.0.0.2"

rest_server_port

integer

Port of the REST API server.

Returned: success

Sample: 443

serial_number

string

Serial number of the storage system.

Returned: success

Sample: "710036"

storage_device_id

string

Unique identifier for the storage device.

Returned: success

Sample: "938000710036"

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