hitachivantara.vspone_block.sds_block.hv_sds_block_control_port_facts module – Retrieves information about control ports.

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.sds_block.hv_sds_block_control_port_facts.

New in hitachivantara.vspone_block 4.1.0

Synopsis
Requirements
Parameters
Attributes
Examples
Returned Facts

Synopsis

Get control port from storage system.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/sdsb_control_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.
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). Required for the Get control port by ID task.

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
control_port 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: `"BCM57414 NetXtreme-E 10Gb/25Gb RDMA Ethernet Controller (Ethernet 25Gb 2-port 631FLR-SFP28 Adapter)"`
id string	Unique identifier for the control port. Returned: success Sample: `"667546d1-4fb3-41bb-8aad-3cef6541cc41"`
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: `"10.76.47.51"`
subnet_mask string	Subnet mask. Returned: success Sample: `"255.255.255.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: `"f4:03:43:c3:9a:f0"`
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: `"10Gbps 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: `"72ecacd0-1d4c-431c-80e8-80924a1b8f28"`
teaming any	Teaming configuration or group info, if any. Returned: success

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/sds_block.hv_sds_block_control_port_facts_module.html