hitachivantara.vspone_block.sds_block.hv_sds_block_spare_node module – Manages spare nodes on 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.

New in hitachivantara.vspone_block 4.4.0

Synopsis
Requirements
Parameters
Attributes
Examples
Return Values

Synopsis

This module manages spare node configuration including node identification, fault domain assignment, network configuration, and BMC settings on Hitachi SDS Block storage systems.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/spare_node.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 / required	Configuration specifications for spare node management.
bmc_name string	Name of the Baseboard Management Controller (BMC).
bmc_password string	Password for BMC authentication.
bmc_user string	Username for BMC authentication.
control_port_ipv4_address string	IPv4 address for the control port of the spare node.
fault_domain_id string	Identifier for the fault domain where the spare node belongs.
id string	Unique identifier for the spare node.
setup_user_password string	Password for the setup user account.
state string	The desired state of the spare node. Choices: `"present"` ← (default) `"absent"`

Attributes

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

Examples

- name: Add a spare node to the SDS Block storage system
  hitachivantara.vspone_block.hv_sds_block_spare_node:
    connection_info:
      address: "{{ storage_system_ip }}"
      username: "{{ username }}"
      password: "{{ password }}"
    state: present
    spec:
      id: "spare-node-01"
      fault_domain_id: "fd-001"
      control_port_ipv4_address: "192.168.1.100"
      setup_user_password: "{{ setup_password }}"
      bmc_name: "spare-bmc-01"
      bmc_user: "admin"
      bmc_password: "{{ bmc_password }}"

- name: Remove a spare node from the SDS Block storage system
  hitachivantara.vspone_block.hv_sds_block_spare_node:
    connection_info:
      address: "{{ storage_system_ip }}"
      username: "{{ username }}"
      password: "{{ password }}"
    state: absent
    spec:
      id: "spare-node-01"

- name: Configure spare node with minimal settings
  hitachivantara.vspone_block.hv_sds_block_spare_node:
    connection_info:
      address: "{{ storage_system_ip }}"
      username: "{{ username }}"
      password: "{{ password }}"
    spec:
      id: "spare-node-02"
      fault_domain_id: "fd-002"
      control_port_ipv4_address: "192.168.1.101"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
spare_node dictionary	The spare node configuration. Returned: always
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_module.html