hitachivantara.vspone_block.sds_block.hv_sds_block_remote_iscsi_port_facts module – Retrieves information about remote iSCSI ports.

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.sds_block.hv_sds_block_remote_iscsi_port_facts.

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.

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

Parameters for filtering or identifying remote iSCSI ports to gather facts about.

id

string

Remote iSCSI port ID. Required for the Get remote iSCSI port by ID task.

local_port_id

aliases: local_port

string

Port number of the local storage system in CLx-y format. local_port is deprecated. Use local_port_id instead.

remote_port_id

aliases: remote_port

string

Port number of the remote storage system in CLx-y format. remote_port is deprecated. Use remote_port_id instead.

remote_serial

string

Serial number of the remote storage system.

remote_storage_system_type

string

ID indicating the remote storage system model.

Choices:

  • "R9"

  • "M8"

Attributes

Attribute

Support

Description

check_mode

Support: full

Determines if the module should run in check mode.

Examples

- name: Get all remote iscsi ports
  hitachivantara.vspone_block.sds_block.hv_sds_block_remote_iscsi_port_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

- name: Get remote iscsi port by ID
  hitachivantara.vspone_block.sds_block.hv_sds_block_remote_iscsi_port_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      id: "da87655a-3958-4921-b4c0-437986397d11"

Returned Facts

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_iscsi_ports

dictionary

Container for remote iSCSI ports data.

Returned: always

data

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

string

Deprecated. Use local_port_id instead.

Returned: success

Sample: "CL1-C"

local_port_number

string

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

Returned: success

Sample: "CL1-C"

remote_ip_address

string

Deprecated. Use remote_storage_port_ip_address instead.

Returned: success

Sample: "172.25.59.213"

remote_port

string

Deprecated. Use remote_port_id instead.

Returned: success

Sample: "CL1-C"

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)