hitachivantara.vspone_block.sds_block.hv_sds_block_remote_iscsi_port module – Manages remote iSCSI port on Hitachi SDS Block storage systems.

Note

This module is part of the hitachivantara.vspone_block collection (version 4.3.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.sds_block.hv_sds_block_remote_iscsi_port.

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

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

Specification for the remote iSCSI port.

id

string

The ID of the remote iSCSI port. Required for delete operation.

local_port

string

Port number of the local storage system in CLx-y format. Required for create operation.

remote_ip_address

string

iSCSI port IP address for the remote storage system. Required for create operation.

remote_port

string

Port number of the remote storage system in CLx-y format. Required for create operation.

remote_serial

string

Serial number of the remote storage system. Required for create operation.

remote_storage_system_type

string

ID indicating the remote storage system model. Required for create operation.

Choices:

  • "R9"

  • "M8"

remote_tcp_port

integer

TCP port number of the iSCSI target for the remote storage system. Used in create operation. If this is omitted, the TCP port number of the iSCSI target for the local storage system is set.

state

string

The desired state of the remote iSCSI port.

Choices:

  • "present" ← (default)

  • "absent"

Attributes

Attribute

Support

Description

check_mode

Support: none

Determines if the module should run in check mode.

Examples

- name: Register a remote iscsi port
  hitachivantara.vspone_block.sds_block.hv_sds_block_remote_iscsi_port:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: "present"
    spec:
      local_port: "CL1-C"
      remote_serial: "810045"
      remote_storage_system_type: "M8"
      remote_port: "CL1-C"
      remote_ip_address: "172.25.59.213"

- name: Restore storage node from maintenance
  hitachivantara.vspone_block.sds_block.hv_sds_block_remote_iscsi_port:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: "restore"
    spec:
      id: "3d0997ce-7065-4e4a-9095-4dc62b36f300"

Return Values

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

Key

Description

remote_iscsi_ports

list / elements=dictionary

A list of remote iSCSI ports.

Returned: always

id

string

The ID of a remote iSCSI port.

Returned: success

Sample: "da87655a-3958-4921-b4c0-437986397d11"

local_port_number

string

Port number of the local storage system in CLx-y format.

Returned: success

Sample: "CL1-C"

remote_ip_address

string

iSCSI port IP address (IPv4/IPv6) for the remote storage system.

Returned: success

Sample: "172.25.59.213"

remote_port_number

string

Port number of the remote storage system in CLx-y format.

Returned: success

Sample: "CL1-C"

remote_serial_number

string

Serial number of the remote storage system.

Returned: success

Sample: "810045"

remote_storage_type_id

string

ID indicating the remote storage system model.

Returned: success

Sample: "M8"

remote_tcp_port

integer

TCP port number of the iSCSI target for the remote storage system.

Returned: success

Sample: 3260

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)