hitachivantara.vspone_block.sds_block.hv_sds_block_storage_node_facts module – Retrieves information about VSP One SDS Block and Cloud systems storage nodes.

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

New in hitachivantara.vspone_block 4.1.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Returned Facts

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. Required for the Get all master storage nodes /Get all worker storage nodes /Get storage node with the following properties tasks. Choices: `"Master"` `"Worker"`
fault_domain_id string	The ID of a fault domain to which the volume belongs. Required for the Get storage nodes by fault domain ID /Get storage node with the following properties tasks.
id string	Storage node ID.
name string	Storage node name. Required for the Get storage node by name /Get storage node with the following properties tasks.
protection_domain_id string	The ID of the protection domain to which the volume is belonging. Required for the Get storage nodes by protection domain ID /Get storage node with the following properties tasks.

Attributes

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

Notes

Note

For Get all storage nodes
1. In the task output, the is_storage_master_node_primary parameter indicates whether the node is the cluster’s primary node. A value of true denotes the primary node.

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 registered in SMBIOS. Returned: success Sample: `"37383638-3430-4d32-3239-343030355153"`
cluster_role string	The role of the storage node in the storage cluster. Returned: success Sample: `"Worker"`
control_port_ipv4_address string	The IPv4 address of the control port. Returned: success Sample: `"10.76.34.105"`
drive_data_relocation_status string	Status of drive data relocation. Returned: success Sample: `"Stopped"`
fault_domain_id string	The ID of the fault domain. Returned: success Sample: `"05c3b302-9d43-448d-b0fa-3bbc64d0666d"`
fault_domain_name string	Name of the fault domain. Returned: success Sample: `"SC01-PD01-FD01"`
id string	Storage node ID. Returned: success Sample: `"e6f3c56b-dcac-4cd5-8524-112ff1273c89"`
insufficient_resources_for_rebuild_capacity dictionary	Insufficient resources for rebuild capacity. Returned: success
capacity_of_drive integer	Lacking drive capacity for rebuild. Returned: success Sample: `0`
number_of_drives integer	Number of lacking drives for rebuild. Returned: success Sample: `0`
internode_port_ipv4_address string	The IPv4 address of the internode port. Returned: success Sample: `"192.168.210.105"`
is_capacity_balancing_enabled boolean	Whether capacity balancing is enabled. Returned: success Sample: `true`
is_storage_master_node_primary boolean	Whether the storage master node is primary. Returned: success Sample: `false`
memory_mb integer	Memory size in MB. Returned: success Sample: `196608`
model_name string	Model name of the server running the storage node. Returned: success Sample: `"Hitachi Advanced Server HA820"`
name string	Storage node name. Returned: success Sample: `"SDS-NODE5"`
protection_domain_id string	The ID of the protection domain. Returned: success Sample: `"66449f50-caa4-4070-ade1-e81f29614741"`
rebuildable_resources dictionary	Resources for which rebuild is possible. Returned: success
number_of_drives integer	Number of drive failures that can be tolerated. Returned: success Sample: `1`
serial_number string	Serial number of the server running the storage node. Returned: success Sample: `"2M294005QS"`
software_version string	Storage software version. Returned: success Sample: `"01.18.02.40"`
status string	The status of the storage node. Returned: success Sample: `"Ready"`
status_summary string	Summary of the storage node status. Returned: success Sample: `"Normal"`
storage_node_attributes list / elements=string	Storage node attributes (empty list if none). Returned: success Sample: `[]`

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_storage_node_facts_module.html