hitachivantara.vspone_block.vsp.hv_vsp_one_port_facts module – Retrieves port information from VSP E series, VSP One Block 20 series, and VSP One Block 80 series storage systems.

Note

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

New in hitachivantara.vspone_block 4.3.0

Synopsis
Requirements
Parameters
Attributes
Examples
Returned Facts

Synopsis

This module retrieves port information from VSP E series, VSP One Block 20 series, and VSP One Block 80 series storage systems.
Utilizes the Hitachi Virtual Storage Platform One Simple API for port facts retrieval across VSP One B20 series, VSP One B80 series, and VSP E series models.
For usage examples, visit https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/vsp_one_port_facts.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.
api_token string	Token used to operate on locked resources.
password string	Password for authentication. This is a required field.
username string	Username for authentication. This is a required field.
spec dictionary	Query parameters for retrieving port information.
port_id string	Port identifier to filter ports. Required for the Get port information by port ID task.
protocol string	Protocol type to filter ports. Valid values are like `NVME_TCP`, `FC`, and `iSCSI`. This is case insensitive. Required for the Get ports information using protocol filter task.

Attributes

Attribute	Support	Description
check_mode	Support: full	Specifies whether the module operates in check mode.

Examples

- name: Get port information by port ID
  hitachivantara.vspone_block.hv_vsp_one_port_facts:
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      port_id: "CL1-C"

- name: Get all port information
  hitachivantara.vspone_block.hv_vsp_one_port_facts:
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
- name: Get port information by protocol
  hitachivantara.vspone_block.hv_vsp_one_port_facts:
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      protocol: "fc"

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
port dictionary	Port information retrieved from the storage system. Returned: always
actual_port_speed string	Current actual speed of the port. Returned: success Sample: `"LINK_DOWN"`
fc_information dictionary	Fibre Channel information for the port. Returned: success
al_pa string	Arbitrated Loop Physical Address. Returned: success Sample: `"EF"`
connection_type string	Fibre Channel connection type. Returned: success Sample: `"FC_AL"`
fabric_switch_setting boolean	Whether fabric switch setting is enabled. Returned: success Sample: `false`
port_mode string	Port mode setting. Returned: success Sample: `"SCSI"`
sfp_data_transfer_rate string	SFP data transfer rate. Returned: success Sample: `"NUMBER_16"`
id string	Port identifier. Returned: success Sample: `"CL4-D"`
iscsi_information dictionary	iSCSI information for the port. Returned: success
delayed_ack boolean	Delayed ACK setting. Returned: success Sample: `true`
ip_mode string	IP mode (ipv4 or ipv6). Returned: success Sample: `"ipv4"`
ipv4_information dictionary	IPv4 configuration details. Returned: success
address string	IPv4 address. Returned: success Sample: `"192.168.0.74"`
default_gateway string	Default gateway address. Returned: success Sample: `"0.0.0.0"`
subnet_mask string	Subnet mask. Returned: success Sample: `"255.255.255.0"`
ipv6_information dictionary	IPv6 configuration details. Returned: success
default_gateway string	Default gateway for IPv6. Returned: success Sample: `"::"`
global string	Global IPv6 configuration mode. Returned: success Sample: `"Auto"`
global_address string	Global IPv6 address. Returned: success Sample: `"::"`
global_address_status string	Status of global IPv6 address. Returned: success Sample: `"INVALID"`
linklocal string	Link-local IPv6 configuration mode. Returned: success Sample: `"Auto"`
linklocal_address string	Link-local IPv6 address. Returned: success Sample: `"fe80::"`
linklocal_address_status string	Status of link-local IPv6 address. Returned: success Sample: `"INVALID"`
is_ipv6_updating boolean	Whether IPv6 is currently updating. Returned: success Sample: `false`
isns_server_ip_address string	iSNS server IP address. Returned: success Sample: `"0.0.0.0"`
isns_server_mode boolean	Whether iSNS server mode is enabled. Returned: success Sample: `false`
isns_server_port integer	iSNS server port number. Returned: success Sample: `3205`
keep_alive_timer integer	Keep alive timer value in seconds. Returned: success Sample: `60`
link_mtu_size string	Link MTU size. Returned: success Sample: `"NUMBER_1500"`
mtu_size string	MTU size. Returned: success Sample: `"NUMBER_1500"`
selective_ack boolean	Selective ACK setting. Returned: success Sample: `true`
tcp_port integer	TCP port number. Returned: success Sample: `3260`
virtual_port_enabled boolean	Whether virtual port is enabled. Returned: success Sample: `false`
vlan_use boolean	Whether VLAN is in use. Returned: success Sample: `false`
window_size string	TCP window size. Returned: success Sample: `"NUMBER_64K"`
nvme_tcp_information dictionary	NVMe over TCP information for the port. Returned: success
delayed_ack boolean	Delayed ACK setting. Returned: success Sample: `true`
ip_mode string	IP mode (ipv4 or ipv6). Returned: success Sample: `"ipv4"`
ipv4_information dictionary	IPv4 configuration details. Returned: success
address string	IPv4 address. Returned: success Sample: `"192.168.0.78"`
default_gateway string	Default gateway address. Returned: success Sample: `"0.0.0.0"`
subnet_mask string	Subnet mask. Returned: success Sample: `"255.255.255.0"`
ipv6_information dictionary	IPv6 configuration details. Returned: success
is_ipv6_updating boolean	Whether IPv6 is currently updating. Returned: success Sample: `false`
link_mtu_size string	Link MTU size. Returned: success Sample: `"NUMBER_1500"`
mtu_size string	MTU size. Returned: success Sample: `"NUMBER_1500"`
tcp_port integer	TCP port number. Returned: success Sample: `4420`
virtual_port_enabled boolean	Whether virtual port is enabled. Returned: success Sample: `false`
port_iscsi_name string	iSCSI name for the port. Returned: success Sample: `""`
port_security boolean	Whether port security is enabled. Returned: success Sample: `false`
port_speed string	Configured port speed. Returned: success Sample: `"NUMBER_100"`
port_wwn string	Port WWN address. Returned: success Sample: `""`
protocol string	Protocol used by the port. Returned: success Sample: `"NVME_TCP"`

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/projects/ansible/latest/collections/hitachivantara/vspone_block/vsp.hv_vsp_one_port_facts_module.html