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_connection_facts.
New in hitachivantara.vspone_block 3.3.0
The below requirements are needed on the host that executes this module.
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. |
|
connection_type string |
Type of connection to the storage system. Choices:
|
|
password string / required |
Password for authentication. This is a required field. |
|
username string / required |
Username for authentication. This is a required field. |
spec dictionary | Specification for remote connection facts. |
|
path_group_id integer |
Path group ID. |
Attribute | Support | Description |
|---|---|---|
check_mode | Support: full | Determines if the module should run in check mode. |
Note
gateway was removed starting from version 3.4.0. Please use an earlier version if you require this connection type.- name: Get all remote connection details
hitachivantara.vspone_block.vsp.hv_remote_connection_facts:
connection_info:
address: storage1.company.com
username: "admin"
password: "password"
- name: Get remote connection details using path group id
hitachivantara.vspone_block.vsp.hv_remote_connection:
connection_info:
address: storage1.company.com
username: "admin"
password: "password"
spec:
path_group_id: 101
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_connections list / elements=dictionary | Newly created remote connection object. Returned: success |
|
cu_status string |
CU status. Returned: success Sample: |
|
cu_type string |
CU type. Returned: success Sample: |
|
min_num_of_paths integer |
Minimum number of paths. Returned: success Sample: |
|
num_of_paths integer |
Number of paths. Returned: success Sample: |
|
path_group_id integer |
Path group ID. Returned: success Sample: |
|
port_type string |
Port type. Returned: success Sample: |
|
remote_paths list / elements=dictionary |
List of remote paths. Returned: success |
|
cu_type string |
CU type. Returned: success Sample: |
|
local_port_id string |
Local port ID. Returned: success Sample: |
|
path_number integer |
Path number. Returned: success Sample: |
|
path_status string |
Path status. Returned: success Sample: |
|
port_type string |
Port type. Returned: success Sample: |
|
remote_port_id string |
Remote port ID. Returned: success Sample: |
|
remote_serial_number string |
Remote serial number. Returned: success Sample: |
|
remote_storage_device_id string |
Remote storage device ID. Returned: success Sample: |
|
remote_storage_model string |
Remote storage model. Returned: success Sample: |
|
remote_storage_type_id string |
Remote storage type ID. Returned: success Sample: |
|
remotepath_group_id string |
Remote path group ID. Returned: success Sample: |
|
round_trip_time_in_milli_seconds integer |
Round trip time in milliseconds. Returned: success Sample: |
|
timeout_value_for_remote_io_in_seconds integer |
Timeout value for remote IO in seconds. Returned: success Sample: |
© 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_connection_facts_module.html