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

New in hitachivantara.vspone_block 3.2.0

Synopsis 

This module manages remote storage registration and de-registration on VSP block 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	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	This field is used to pass the 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 to the secondary storage system. 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 to the secondary storage system. 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 storage registration and de-registration.
is_mutual_deletion boolean	Specify whether to perform a mutual deletion operation during de-registration. true means perform a mutual deletion operation. Required for the Unregister Remote Storage task. Choices: `false` `true`
is_mutual_discovery boolean	Specify whether to perform a mutual registration operation. true means perform a mutual registration operation. Required for the Register Remote Storage task. 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. Required for the Register Remote Storage task.
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 dictionary	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"`
dkc_type string	Type of DKC (Local or Remote). Returned: success Sample: `"Local"`
model string	Model of the storage system. Returned: success Sample: `"VSP One B85"`
rest_server_ip string	IP address of the REST server. Returned: success Sample: `"172.23.70.59"`
rest_server_port integer	Port number of the REST server. Returned: success Sample: `443`
serial_number integer	Serial number of the storage system. Returned: success Sample: `70041`
storage_device_id string	Storage device ID. Returned: success Sample: `"A00000970041"`
storages_registered_in_remote list / elements=dictionary	List of storage systems registered remotely. Returned: success
communication_modes list / elements=dictionary	List of communication modes. Returned: success
communicationMode string	Mode of communication. Returned: success Sample: `"lanConnectionMode"`
dkc_type string	Type of DKC (Local or Remote). Returned: success Sample: `"Remote"`
model string	Model of the storage system. Returned: success Sample: `"VSP One B85"`
rest_server_ip string	IP address of the REST server. Returned: success Sample: `"172.23.70.26"`
rest_server_port integer	Port number of the REST server. Returned: success Sample: `443`
serial_number integer	Serial number of the storage system. Returned: success Sample: `70045`
storage_device_id string	Storage device ID. Returned: success Sample: `"A00000970045"`

Authors

Hitachi Vantara LTD (@hitachi-vantara)

hitachivantara.vspone_block.vsp.hv_remote_storage_registration module – Manages remote storage registration and de-registration on VSP block storage systems.

Synopsis

Requirements

Parameters

Attributes

Notes

Examples

Return Values