hitachivantara.vspone_block.sds_block.hv_sds_block_control_port_facts module – Get control port from storage system

Note

This module is part of the hitachivantara.vspone_block collection (version 4.4.2).

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_control_port_facts.

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

connection_type

string

Type of connection to the storage system.

Choices:

  • "direct" ← (default)

password

string / required

Password for authentication. This is a required field.

username

string / required

Username for authentication. This is a required field.

spec

dictionary

Specification for retrieving control port information.

id

string

Filter control port by ID (UUID format).

Attributes

Attribute

Support

Description

check_mode

Support: full

Determines if the module should run in check mode.

Examples

- name: Retrieve information about all control_port
  hitachivantara.vspone_block.sds_block.hv_sds_block_control_port_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

- name: Retrieve information about control_port by specifying id
  hitachivantara.vspone_block.sds_block.hv_sds_block_control_port_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      id: "126f360e-c79e-4e75-8f7c-7d91bfd2f0b8"

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

data

list / elements=dictionary

List of control port entries.

Returned: success

configured_port_speed

string

Configured speed setting of the port.

Returned: success

Sample: "Auto"

device_name

string

Name of the physical device.

Returned: success

Sample: "NetXtreme BCM5719 Gigabit Ethernet PCIe (Ethernet 1Gb 4-port 331i Adapter)"

id

string

Unique identifier for the control port.

Returned: success

Sample: "1d7fa4ae-9bc6-446c-8cf1-09de0ea01dcd"

interface_name

string

Interface name of the network device.

Returned: success

Sample: "eth0"

ipv4_information

dictionary

IPv4 network configuration.

Returned: success

address

string

IPv4 address.

Returned: success

Sample: "192.168.24.242"

subnet_mask

string

Subnet mask.

Returned: success

Sample: "255.255.192.0"

is_teaming_enabled

string

Whether NIC teaming is enabled.

Returned: success

Sample: "false"

mac_address

string

MAC address of the network interface.

Returned: success

Sample: "80:30:e0:39:b7:a5"

mtu_size

integer

Maximum Transmission Unit size.

Returned: success

Sample: 1500

port_speed_duplex

string

Actual speed and duplex setting of the port.

Returned: success

Sample: "1Gbps Full"

redundancy

integer

Redundancy level for the port (e.g., 0 for none).

Returned: success

Sample: 0

status

string

Current operational status of the control port.

Returned: success

Sample: "Normal"

status_summary

string

Summary of the control port’s status.

Returned: success

Sample: "Normal"

storage_node_id

string

UUID of the storage node associated with this control port.

Returned: success

Sample: "ad36eab7-20c3-41cd-acac-d334ff5347d7"

teaming

any

Teaming configuration or group info, if any.

Returned: success

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)