hitachivantara.vspone_block.vsp.hv_vsp_one_port module – Manages port configuration on Hitachi VSP One 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.vsp.hv_vsp_one_port.

New in hitachivantara.vspone_block 4.3.0

Synopsis

• This module manages port configuration on Hitachi VSP One storage systems.

• Utilizes the Hitachi Vantara VSP One Simple API for port management across VSP one B2x 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.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 / required	Configuration parameters for managing port settings.
enable_port_security boolean	Whether to enable port security. Choices: false true
fc_settings dictionary	Fibre Channel specific settings.
al_pa string	Arbitrated Loop Physical Address.
connection_type string	FC connection type. Choices: "Point_To_Point" "FC_AL"
should_enable_fabric_switch_setting boolean	Whether to enable fabric switch setting. Choices: false true
iscsi_settings dictionary	iSCSI specific settings.
add_vlan_id integer	VLAN ID to add.
delete_vlan_id integer	VLAN ID to delete.
enable_delayed_ack boolean	Whether to enable delayed ACK. Choices: false true
enable_isns_server_mode boolean	Whether to enable iSNS server mode. Choices: false true
enable_selective_ack boolean	Whether to enable selective ACK. Choices: false true
enable_virtual_port boolean	Whether to enable virtual port. Choices: false true
enable_vlan_use boolean	Whether to enable VLAN use. Choices: false true
ip_mode string	IP mode configuration. Choices: "ipv4" "ipv4v6"
ipv4_configuration dictionary	IPv4 configuration settings.
address string	IPv4 address.
default_gateway string	IPv4 default gateway.
subnet_mask string	IPv4 subnet mask.
ipv6_configuration dictionary	IPv6 configuration settings.
default_gateway string	IPv6 default gateway.
global string	IPv6 global address.
linklocal string	IPv6 link-local address.
isns_server_ip_address string	iSNS server IP address.
isns_server_port integer	iSNS server port.
keep_alive_timer integer	Keep alive timer value.
mtu_size string	MTU size. Choices: "NUMBER_1500" "NUMBER_4500" "NUMBER_9000"
tcp_port integer	TCP port number.
window_size string	TCP window size. Choices: "NUMBER_16K" "NUMBER_32K" "NUMBER_64K" "NUMBER_128K" "NUMBER_256K" "NUMBER_512K" "NUMBER_1024K"
nvme_tcp_settings dictionary	NVMe over TCP specific settings.
add_vlan_id integer	VLAN ID to add.
delete_vlan_id integer	VLAN ID to delete.
discovery_tcp_port integer	Discovery TCP port number.
enable_delayed_ack boolean	Whether to enable delayed ACK. Choices: false true
enable_selective_ack boolean	Whether to enable selective ACK. Choices: false true
enable_vlan_use boolean	Whether to enable VLAN use. Choices: false true
ip_mode string	IP mode configuration. Choices: "ipv4" "ipv4v6"
ipv4_configuration dictionary	IPv4 settings.
address string	IPv4 address.
default_gateway string	IPv4 default gateway.
subnet_mask string	IPv4 subnet mask.
ipv6_configuration dictionary	IPv6 settings.
default_gateway string	IPv6 default gateway.
global_ string	IPv6 global address.
linklocal string	IPv6 link-local address.
mtu_size string	MTU size. Choices: "NUMBER_1500" "NUMBER_4500" "NUMBER_9000"
tcp_port integer	TCP port number.
window_size string	TCP window size. Choices: "NUMBER_64K" "NUMBER_128K" "NUMBER_256K" "NUMBER_512K" "NUMBER_1024K"
port_id string / required	Port identifier to configure.
port_speed_in_gbps integer	Port speed in Gbps. Choices: 0 1 4 8 10 16 25 32 64 100

Attributes

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

Examples

- name: Configure basic port settings (port security and speed)
  hitachivantara.vspone_block.hv_vsp_one_port:
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      port_id: "CL1-C"
      port_speed_in_gbps: 32
      enable_port_security: true

- name: Configure FC port with all settings
  hitachivantara.vspone_block.hv_vsp_one_port:
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      port_id: "CL2-A"
      port_speed_in_gbps: 16
      enable_port_security: false
      fc_settings:
        al_pa: "0x01"
        should_enable_fabric_switch_setting: true
        connection_type: "Point_To_Point"

- name: Configure iSCSI port with comprehensive settings
  hitachivantara.vspone_block.hv_vsp_one_port:
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      port_id: "CL3-B"
      port_speed_in_gbps: 25
      enable_port_security: true
      iscsi_settings:
        enable_vlan_use: true
        add_vlan_id: 100
        ip_mode: "ipv4v6"
        ipv4_configuration:
          address: "192.168.1.100"
          subnet_mask: "255.255.255.0"
          default_gateway: "192.168.1.1"
        ipv6_configuration:
          linklocal: "fe80::1"
          global: "2001:db8::100"
          default_gateway: "2001:db8::1"
        tcp_port: 3260
        enable_selective_ack: true
        enable_delayed_ack: false
        window_size: "NUMBER_256K"
        mtu_size: "NUMBER_9000"
        keep_alive_timer: 300
        enable_isns_server_mode: true
        isns_server_ip_address: "192.168.1.200"
        isns_server_port: 3205
        enable_virtual_port: false

- name: Configure NVMe over TCP port with all parameters
  hitachivantara.vspone_block.hv_vsp_one_port:
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      port_id: "CL4-D"
      port_speed_in_gbps: 100
      enable_port_security: false
      nvme_tcp_settings:
        enable_vlan_use: true
        add_vlan_id: 200
        ip_mode: "ipv4"
        ipv4_settings:
          address: "10.0.1.50"
          subnet_mask: "255.255.255.0"
          default_gateway: "10.0.1.1"
        ipv6_settings:
          linklocal: "fe80::2"
          global_: "2001:db8:1::50"
          default_gateway: "2001:db8:1::1"
        tcp_port: 4420
        discovery_tcp_port: 8009
        enable_selective_ack: false
        enable_delayed_ack: true
        window_size: "NUMBER_512K"
        mtu_size: "NUMBER_4500"

- name: Remove VLAN from iSCSI port
  hitachivantara.vspone_block.hv_vsp_one_port:
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      port_id: "CL3-B"
      iscsi_settings:
        delete_vlan_id: 100

- name: Configure port with minimal settings
  hitachivantara.vspone_block.hv_vsp_one_port:
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      port_id: "CL1-A"
      port_speed_in_gbps: 0  # Auto speed

Return Values

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

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

• Issue Tracker
• Repository (Sources)