hitachivantara.vspone_block.vsp.hv_storage_port module – Change the storage port settings in the Hitachi VSP storage systems.

Note

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

New in hitachivantara.vspone_block 3.1.0

Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.8

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.

username

string

Username for authentication. This is a required field.

spec

dictionary

Specification for the storage port tasks.

enable_port_security

boolean

Specify whether to enable the lun security setting for the port.

Choices:

  • false

  • true

fabric_mode

boolean

Fabric mode of the port. Set when this value is true. Not set when this value is false. When specifying this attribute, be sure to also specify the port_connection attribute.

Choices:

  • false

  • true

port

string / required

The port id of the specific port to retrieve.

port_attribute

string

Specify the port attribute of the port. The specifiable values are ‘TAR’ or ‘ALL’. Use ‘TAR’ for Fibre Target port, use ‘ALL’ for Bidirectional port. This attribute cannot be specified at the same time as any other attribute.

port_connection

string

Topology setting for the port. The specifiable values are ‘FCAL’, ‘P2P’ or ‘PtoP’. When specifying this attribute, be sure to also specify the fabric_mode attribute.

port_mode

string

Specify the operating mode of the port. The specifiable values are ‘FC-NVMe’ or ‘FCP-SCSI’. This attribute cannot be specified at the same time as any other attribute.

port_speed

string

Specify the transfer speed of the port. The specifiable values are ‘AUT’ or ‘nG’, where n is a number and G can be omitted.

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: none

Determines if the module should run in check mode.

Examples

- name: Change attribute setting of the storage port by port id
  hitachivantara.vspone_block.vsp.hv_storage_port:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      port: "CL8-B"
      port_attribute: "TAR"  # Options: "TAR", "ALL"

- name: Change port mode setting of the storage port by port id
  hitachivantara.vspone_block.vsp.hv_storage_port:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      port: "CL8-B"
      port_mode: "FC-NVMe"  # Options: "FC-NVMe", "FCP-SCSI"

- name: Change port security setting of the storage port by port id
  hitachivantara.vspone_block.vsp.hv_storage_port:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      port: "CL1-A"
      enable_port_security: true

Return Values

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

Key

Description

storagePort

list / elements=dictionary

The storage port information.

Returned: always

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.

Returned: success

Sample: ""

keep_alive_timer

integer

Keep alive timer value.

Returned: success

Sample: -1

loop_id

string

Loop ID of the port.

Returned: success

Sample: "CE"

lun_security_setting

boolean

Indicates if LUN security setting 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

Type of port connection.

Returned: success

Sample: "PtoP"

port_id

string

Port ID.

Returned: success

Sample: "CL8-B"

port_mode

string

Operating 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)