hitachivantara.vspone_block.sds_block.hv_sds_block_spare_node_facts module – Get spare node information from VSP One SDS Block and Cloud systems.

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

New in hitachivantara.vspone_block 4.4.0

Synopsis
Requirements
Parameters
Attributes
Examples
Returned Facts

Synopsis

This module retrieves spare node information and configuration details from VSP One SDS Block and Cloud systems.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/spare_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	Configuration specifications for spare node management.
id string	Unique identifier for the spare node.

Attributes

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

Examples

- name: Retrieve all spare node information
  hitachivantara.vspone_block.hv_sds_block_spare_node_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

- name: Retrieve specific spare node information by ID
  hitachivantara.vspone_block.hv_sds_block_spare_node_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      id: "spare-node-001"

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
spare_nodes list / elements=dictionary	List of spare node configurations. Returned: success
bios_uuid string	BIOS UUID of the spare node. Returned: success Sample: `"12345678-1234-1234-1234-123456789abc"`
bmc_name string	Name of the Baseboard Management Controller (BMC). Returned: success Sample: `"spare-bmc-01"`
bmc_user string	Username for BMC authentication. Returned: success Sample: `"admin"`
control_port_ipv4_address string	IPv4 address for the control port of the spare node. Returned: success Sample: `"192.168.1.100"`
fault_domain_id string	Identifier for the fault domain where the spare node belongs. Returned: success Sample: `"fd-001"`
fault_domain_name string	Name of the fault domain where the spare node belongs. Returned: success Sample: `"fault-domain-001"`
id string	Unique identifier for the spare node. Returned: success Sample: `"spare-node-01"`
model_name string	Model name of the spare node. Returned: success Sample: `"HV-SDSB-001"`
name string	Name of the spare node. Returned: success Sample: `"spare-node-01"`
serial_number string	Serial number of the spare node. Returned: success Sample: `"SN123456789"`
software_version string	Software version of the spare node. Returned: success Sample: `"1.0.0"`

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