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

New in hitachivantara.vspone_block 3.3.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.

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.

connection_type

string

Type of connection to the storage system.

Choices:

  • "direct" ← (default)

password

string / required

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

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

spec

dictionary / required

Specification for iSCSI remote connection tasks.

local_port

string / required

Port number of the local storage system Required for the Create a new remote connection using iSCSI ports /Delete an iSCSI-based remote connection tasks.

remote_port

string / required

Port number of the remote storage system Required for the Create a new remote connection using iSCSI ports /Delete an iSCSI-based remote connection tasks.

remote_storage_ip_address

string

IP address of the remote storage system. Required for the Create a new remote connection using iSCSI ports task.

remote_storage_serial_number

string / required

Serial number of the remote storage system. Required for the Create a new remote connection using iSCSI ports /Delete an iSCSI-based remote connection tasks.

remote_tcp_port

integer

TCP port of the remote storage system. Optional for the Create a new remote connection using iSCSI ports task.

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.

  • To manage remote connections, register the remote storage system with the storage system you want to manage.

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)