W3cubDocs

/Ansible

hitachivantara.vspone_block.sds_block.hv_sds_block_port_facts module – Retrieves information about Hitachi SDS block storage system compute ports.

Note

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

New in hitachivantara.vspone_block 3.0.0

Synopsis
Requirements
Parameters
Attributes
Examples
Returned Facts

Synopsis

This module retrieves information about compute ports.
It provides details about a compute port such as ID, lun and other details.
For examples go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/compute_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.
username string / required	Username for authentication.
spec dictionary	Specification for retrieving compute port information.
names list / elements=string	The names of the compute ports.
nicknames list / elements=string	The nicknames of the compute ports.

Attributes

Attribute	Support	Description
check_mode	Support: full	Determines if the module should run in check mode.

Examples

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

- name: Retrieve information about compute ports by compute node name
  hitachivantara.vspone_block.sds_block.hv_sds_block_port_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

    spec:
      nicknames: ["000-iSCSI-000"]

- name: Retrieve information about compute ports by names
  hitachivantara.vspone_block.sds_block.hv_sds_block_port_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

    spec:
      names: ["p1-compute-node", "RD-compute-node-111"]

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
chap_users_info list / elements=dictionary	List of CHAP users information. Returned: success
id string	Unique identifier for the CHAP user. Returned: success Sample: `"464e1fd1-9892-4134-866c-6964ce786676"`
initiator_chap_user_name string	Initiator CHAP user name. Returned: success Sample: `""`
target_chap_user_name string	Target CHAP user name. Returned: success Sample: `"test"`
port_auth_info dictionary	Port authentication information. Returned: success
auth_mode string	Authentication mode. Returned: success Sample: `"CHAP"`
id string	Unique identifier for the port authentication info. Returned: success Sample: `"932962b5-ab61-429f-ba06-cd976e1a8f97"`
is_discovery_chap_auth boolean	Indicates if discovery CHAP authentication is enabled. Returned: success Sample: `false`
is_mutual_chap_auth boolean	Indicates if mutual CHAP authentication is enabled. Returned: success Sample: `true`
port_info dictionary	Detailed information about the port. Returned: success
configured_port_speed string	Configured port speed. Returned: success Sample: `"Auto"`
fc_information dictionary	Fibre Channel information. Returned: success
id string	Unique identifier for the port. Returned: success Sample: `"932962b5-ab61-429f-ba06-cd976e1a8f97"`
interface_name string	Name of the interface. Returned: success Sample: `"eth2"`
iscsi_information dictionary	iSCSI information. Returned: success
delayed_ack boolean	Indicates if delayed ACK is enabled. Returned: success Sample: `true`
ip_mode string	IP mode. Returned: success Sample: `"ipv4"`
ipv4_information dictionary	IPv4 information. Returned: success
address string	IPv4 address. Returned: success Sample: `"10.76.34.51"`
default_gateway string	Default gateway. Returned: success Sample: `"10.76.34.1"`
subnet_mask string	Subnet mask. Returned: success Sample: `"255.255.255.0"`
ipv6_information dictionary	IPv6 information. Returned: success
default_gateway string	Default gateway. Returned: success Sample: `""`
global_address1 string	Global address 1. Returned: success Sample: `""`
global_address_mode string	Global address mode. Returned: success Sample: `"Manual"`
linklocal_address string	Link-local address. Returned: success Sample: `""`
linklocal_address_mode string	Link-local address mode. Returned: success Sample: `"Auto"`
subnet_prefix_length1 integer	Subnet prefix length 1. Returned: success Sample: `0`
is_isns_client_enabled boolean	Indicates if iSNS client is enabled. Returned: success Sample: `false`
isns_servers list / elements=dictionary	List of iSNS servers. Returned: success
index integer	Index of the iSNS server. Returned: success Sample: `1`
port integer	Port of the iSNS server. Returned: success Sample: `3205`
server_name string	Name of the iSNS server. Returned: success Sample: `""`
mac_address string	MAC address. Returned: success Sample: `"b4:96:91:c8:75:bc"`
mtu_size integer	MTU size. Returned: success Sample: `9000`
name string	Name of the port. Returned: success Sample: `"iqn.1994-04.jp.co.hitachi:rsd.sph.t.0a85a.000"`
nickname string	Nickname of the port. Returned: success Sample: `"000-iSCSI-000"`
nvme_tcp_information dictionary	NVMe over TCP information. Returned: success
port_speed string	Port speed. Returned: success Sample: `"25G"`
port_speed_duplex string	Port speed duplex. Returned: success Sample: `"25Gbps Full"`
protection_domain_id string	Protection domain ID. Returned: success Sample: `"645c36b6-da9e-44bb-b711-430e06c7ad2b"`
protocol string	Protocol used by the port. Returned: success Sample: `"iSCSI"`
status string	Status of the port. Returned: success Sample: `"Normal"`
status_summary string	Summary of the port status. Returned: success Sample: `"Normal"`
storage_node_id string	Storage node ID. Returned: success Sample: `"01f598b8-dc1c-45fc-b821-5ea108d42593"`
type string	Type of the port. Returned: success Sample: `"Universal"`

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/ansible/latest/collections/hitachivantara/vspone_block/sds_block.hv_sds_block_port_facts_module.html