hitachivantara.vspone_block.vsp.hv_storage_port_facts module – Retrieves storage port information from Hitachi VSP storage systems.

Note

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

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

api_token

string

This field is used to pass the value of the lock token to operate on locked resources.

connection_type

string

Type of connection to the storage system.

Choices:

  • "direct" ← (default)

password

string

Password for authentication. This is a required field if api_token is not provided.

username

string

Username for authentication. This is a required field if api_token is not provided.

spec

dictionary

Specification for the storage port facts to be gathered.

external_iscsi_ip_address

string

IP address of the iSCSI target on the external storage system.

external_iscsi_name

string

iSCSI name of the target on the external storage system.

external_tcp_port

integer

TCP port number of the iSCSI target on the external storage system. If this attribute is omitted, the TCP port number of the port on the local storage system is assumed.

external_wwn

string

This field is used to pass the value of the external WWN to operate on external storage systems. This field is used to query for getting information about a port on an external storage system.

ports

list / elements=string

The id of the specific ports to retrieve.

query

list / elements=string

This field allows to query for getting information about a port on an external storage system. query parameter is one of external_iscsi_targets, registered_external_iscsi_targets, external_storage_ports, external_luns.

storage_system_info

dictionary

Information about the storage system. This field is an optional field.

serial

string

The serial number of the storage system.

Attributes

Attribute

Support

Description

check_mode

Support: full

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: Get all ports
  hitachivantara.vspone_block.vsp.hv_storage_port_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"

- name: Get information about specific ports
  hitachivantara.vspone_block.vsp.hv_storage_port_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      ports: ["CLA-1", "CLA-2"]

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

storageport

list / elements=dictionary

The storage port information.

Returned: success

fabric_mode

boolean

Indicates if the port is in fabric mode.

Returned: success

Sample: true

ipv4_address

string

IPv4 address of the port.

Returned: success

Sample: ""

ipv4_gateway_address

string

IPv4 gateway address of the port.

Returned: success

Sample: ""

ipv4_subnetmask

string

IPv4 subnet mask of the port.

Returned: success

Sample: ""

iscsi_window_size

string

iSCSI window size of the port.

Returned: success

Sample: ""

keep_alive_timer

integer

Keep alive timer value of the port.

Returned: success

Sample: -1

loop_id

string

Loop ID of the port.

Returned: success

Sample: "CE"

lun_security_setting

boolean

Indicates if LUN security is enabled.

Returned: success

Sample: false

mac_address

string

MAC address of the port.

Returned: success

Sample: ""

port_attributes

list / elements=string

List of port attributes.

Returned: success

Sample: ["TAR", "MCU", "RCU", "ELUN"]

port_connection

string

Connection type of the port.

Returned: success

Sample: "PtoP"

port_id

string

ID of the port.

Returned: success

Sample: "CL8-B"

port_mode

string

Mode of the port.

Returned: success

Sample: "FCP-SCSI"

port_speed

string

Speed of the port.

Returned: success

Sample: "AUT"

port_type

string

Type of the port.

Returned: success

Sample: "FIBRE"

storage_serial_number

string

Serial number of the storage system.

Returned: success

Sample: "715035"

tcp_port

string

TCP port number.

Returned: success

Sample: ""

wwn

string

World Wide Name of the port.

Returned: success

Sample: "50060e8028274271"

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)