hitachivantara.vspone_block.sds_block.hv_sds_block_storage_node_facts module – Retrieves information about Hitachi SDS block storage system storage nodes.

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

New in hitachivantara.vspone_block 4.1.0

Synopsis

• This module retrieves information about storage nodes.

• It provides details about a storage node such as ID, name and other details.

• For examples go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/storage_node_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 storage node information.
cluster_role string	The role of a storage node in a storage cluster. Choices: "Master" "Worker"
fault_domain_id string	The ID of a fault domain to which the volume belongs.
id string	Storage node ID.
name string	Storage node name.
protection_domain_id string	The ID of the protection domain to which the volume is belonging.

Attributes

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

Examples

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

- name: Retrieve information about storage node by name
  hitachivantara.vspone_block.sds_block.hv_sds_block_storage_node_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      name: "vssbesxi1"

- name: Retrieve information about storage nodes by fault domain ID
  hitachivantara.vspone_block.sds_block.hv_sds_block_storage_node_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      fault_domain_id: "c0b833cd-1fee-417d-bbf2-d25aac767ad4"

- name: Retrieve information about storage nodes by protection domain ID
  hitachivantara.vspone_block.sds_block.hv_sds_block_storage_node_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      protection_domain_id: "4090c412-edf2-4368-8175-1f60507afbb8"

- name: Retrieve information about storage nodes by cluster role
  hitachivantara.vspone_block.sds_block.hv_sds_block_storage_node_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      cluster_role: "Master"

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
storage_nodes list / elements=dictionary	A list of storage nodes. Returned: success
storage_node_info dictionary	Information about the storage node. Returned: success
bios_uuid string	The storage node UUID, which is registered in the SMBIOS. Returned: success Sample: "422c2bdc-fdcf-8d33-63b9-377776cee60d"
cluster_role string	The role of the storage node in the storage cluster. Returned: success Sample: "Master"
control_port_ipv4_address string	The IP address (IPv4) of the control port. Returned: success Sample: "172.25.58.141"
drive_data_relocation_status string	Status of drive data relocation. Returned: success Sample: "Stopped"
fault_domain_id string	The ID of a fault domain to which the volume belongs. Returned: success Sample: "c0b833cd-1fee-417d-bbf2-d25aac767ad4"
fault_domain_name string	Name of a fault domain to which the volume belongs. Returned: success Sample: "SC14-PD01-FD01"
id string	Storage node ID. Returned: success Sample: "f3dbcbcc-9cfd-426d-8696-4d23fc9a5dee"
insufficient_resources_for_rebuild_capacity dictionary	Insufficient resources for rebuild capacity. Returned: success
capacity_of_drive integer	Lacking drive capacity of rebuild capacity. Returned: success Sample: 0
number_of_drives integer	The number of lacking drives of rebuild capacity. Returned: success Sample: 0
internode_port_ipv4_address string	The IP address (IPv4) of the internode port. Returned: success Sample: "192.168.101.141"
is_capacity_balancing_enabled boolean	Capacity balancing settings of a storage node. Returned: success Sample: true
is_storage_master_node_primary boolean	Indicates whether the storage node is the cluster master node (primary). Returned: success Sample: true
memory_mb integer	The IP address (IPv4) of the internode port. Returned: success Sample: 118784
model_name string	Model name of the server on which the storage node is running. Returned: success Sample: "Advanced System HA810"
name string	Storage node name. Returned: success Sample: "vssbesxi1"
protection_domain_id string	The ID of the protection domain to which the volume is belonging. Returned: success Sample: "4090c412-edf2-4368-8175-1f60507afbb8"
rebuildable_resources dictionary	Resource for which Rebuild is possible. Returned: success
number_of_drives integer	The number of drive failures that can be tolerated. Returned: success Sample: 1
serial_number string	Serial number of the server on which the storage node is running. Returned: success Sample: "MXQ941046B"
software_version string	The version of storage software. Returned: success Sample: "01.14.00.00"
status string	The status of the storage node. Returned: success Sample: "Ready"
status_summary string	The summary of the storage node status. Returned: success Sample: "Normal"
storage_node_attributes list / elements=string	Storage node attribute. An empty array ([]) means a storage node which has no attribute. Returned: success Sample: []

Authors

• Hitachi Vantara LTD (@hitachi-vantara)

Collection links

• Issue Tracker
• Repository (Sources)