W3cubDocs

/Ansible

hitachivantara.vspone_block.vsp.hv_remote_storage_registration module – Manages remote storage registration and unregistration on 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.

New in hitachivantara.vspone_block 3.2.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Return Values

Synopsis

This module manages remote storage registration and unregistration on Hitachi VSP storage systems.
For examples go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/remote_storage_registration.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.
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	This field is used to pass the value of the lock token to operate on locked resources.
password string	Password for authentication to the secondary storage system. This is a required field if api_token is not provided.
username string	Username for authentication to the secondary storage system. This is a required field if api_token is not provided.
spec dictionary	Specification for the remote storage registration and unregistration.
is_mutual_deletion boolean	Specify whether to perform a mutual deletion operation during unregistration. true means perform a mutual deletion operation. Choices: `false` `true`
is_mutual_discovery boolean	Specify whether to perform a mutual registration operation. true means perform a mutual registration operation. Choices: `false` `true`
rest_server_ip string	IP address of the rest server of the remote storage system. If not provided, secondary_connection_info.address will be used for rest_server_ip.
rest_server_port integer	Port number of the rest server of the remote storage system. If not provided, 443 will be used for rest_server_port.
state string	The desired state of the task. Choices: `"present"` ← (default) `"absent"`

Attributes

Attribute	Support	Description
check_mode	Support: none	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: Register Remote Storage
  hitachivantara.vspone_block.vsp.hv_remote_storage_registration:
    connection_info:
      address: 172.0.0.2
      username: "admin"
      password: "password"
    secondary_connection_info:
      address: 172.0.0.3
      username: "admin"
      password: "password"
    state: present
    spec:
      is_mutual_discovery: true
      rest_server_ip: 172.0.0.1

- name: Unregister Remote Storage
  hitachivantara.vspone_block.vsp.hv_remote_storage_registration:
    connection_info:
      address: 172.0.0.2
      username: "admin"
      password: "password"
    secondary_connection_info:
      address: 172.0.0.3
      username: "admin"
      password: "password"
    state: absent
    spec:
      is_mutual_deletion: true

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
remote_storage list / elements=dictionary	A list of information about the storage systems registered on the REST API server. Returned: always
storages_registered_in_local list / elements=dictionary	List of storage systems registered locally. Returned: success
communication_modes list / elements=dictionary	List of communication modes. 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 DKC (Local or Remote). 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 server. Returned: success Sample: `"172.0.0.2"`
rest_server_port integer	Port number of the REST server. Returned: success Sample: `443`
serial_number string	Serial number of the storage system. Returned: success Sample: `"710036"`
storage_device_id string	Storage device ID. Returned: success Sample: `"938000710036"`

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