W3cubDocs

/Ansible

hitachivantara.vspone_block.vsp.hv_iscsi_remote_connection module – Manages Remote connections through iSCSI ports 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_iscsi_remote_connection.

New in hitachivantara.vspone_block 3.3.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Return Values

Synopsis

- This module allows settings of remote connections through iSCSI ports used for remote copy operations. - Remote connections are used to connect storage systems used in remote copy operations for TrueCopy, Universal Replicator, and global-active device. - For examples go to URL
https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/remote_iscsi_connection.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.
connection_type string	Type of connection to the storage system. Choices: `"direct"` ← (default)
password string / required	Password for authentication. This is a required field.
username string / required	Username for authentication. This is a required field.
spec dictionary / required	Specification for iSCSI remote connection tasks.
local_port string / required	Port number of the local storage system
remote_port string / required	Port number of the remote storage system
remote_storage_ip_address string	IP address of the remote storage system.
remote_storage_serial_number string / required	Serial number of the remote storage system.
remote_tcp_port integer	TCP port of the remote storage system.
state string	The level of the Remote connection task. Choices are `present`, `absent`. 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: Create a new remote connection through iSCSI ports
  hitachivantara.vspone_block.vsp.hv_remote_connection:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: present
    spec:
      remote_storage_serial_number: "40014"
      local_port: "CL7-D"
      remote_port: "CL7-D"
      remote_storage_ip_address: "10.120.10.120"
      remote_tcp_port: 3260

- name: Delete a iSCSI remote connection
  hitachivantara.vspone_block.vsp.hv_remote_connection:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: absent
    spec:
      remote_storage_serial_number: "40014"
      local_port: "CL7-D"
      remote_port: "CL7-D"

Return Values

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

Key	Description
remote_connection dictionary	Newly created remote connection object. Returned: success
local_port_id string	Local port ID. Returned: success Sample: `"CL1-C"`
remote_ip_address string	Remote IP address. Returned: success Sample: `"10.12.10.120"`
remote_iscsi_port_id string	Remote iSCSI port ID. Returned: success Sample: `"CL1-C,810045,M8,CL1-C"`
remote_port_id string	Remote port ID. Returned: success Sample: `"CL1-C"`
remote_serial_number string	Remote serial number. Returned: success Sample: `"810045"`
remote_storage_device_id string	Remote storage device ID. Returned: success Sample: `"A34000810045"`
remote_storage_model string	Remote storage model. Returned: success Sample: `"VSP One B26"`
remote_storage_type_id string	Remote storage type ID. Returned: success Sample: `"M8"`
remote_tcp_port integer	Remote TCP port. Returned: success Sample: `3260`

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