hitachivantara.vspone_block.sds_block.hv_sds_block_storage_node module – Manages storage node on VSP One SDS Block and Cloud systems.

Note

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

New in hitachivantara.vspone_block 4.1.0

Synopsis

• This module allows block storage node for maintenance, and restore storage node from blocked state on 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/storage_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	Specification for the storage node.
id string	The UUID of the storage node.
is_capacity_balancing_enabled boolean	Enables or disables the capacity balancing. If true, capacity balancing applies to the storage node. If false, capacity balancing does not apply to the storage node. Choices: false true
name string	The name of the storage node.
state string	The desired state of the storage pool. Choices: "present" ← (default) "maintenance" "restore"

Attributes

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

Examples

- name: Block storage node for maintenance
  hitachivantara.vspone_block.sds_block.hv_sds_block_storage_node:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: "maintenance"
    spec:
      id: "3d0997ce-7065-4e4a-9095-4dc62b36f300"

- name: Restore storage node from maintenance
  hitachivantara.vspone_block.sds_block.hv_sds_block_storage_node:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: "restore"
    spec:
      id: "3d0997ce-7065-4e4a-9095-4dc62b36f300"

Return Values

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

Key	Description
storage_nodes list / elements=dictionary	List of storage nodes. Returned: always
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 (may be empty). 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"
memory_mb integer	Memory size in megabytes. 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 (may be empty). 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)