hitachivantara.vspone_block.sds_block.hv_sds_block_fault_domain_facts module – Get fault domains from storage system

Note

This module is part of the hitachivantara.vspone_block collection (version 4.1.0).

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

New in hitachivantara.vspone_block 4.1.0

Synopsis 

Get fault domains from storage system.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/sdsb_fault_domain_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 CHAP user information.
id string	Filter fault domains by ID (UUID format).
name string	Filter fault domains by name.

Attributes 

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

Examples 

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

- name: Retrieve information about fault_domain by specifying id
  hitachivantara.vspone_block.sds_block.hv_sds_fault_domain_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      id: "126f360e-c79e-4e75-8f7c-7d91bfd2f0b8"

- name: Retrieve information about fault_domain by specifying name
  hitachivantara.vspone_block.sds_block.hv_sds_fault_domain_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      name: "SC01-PD01-FD01"

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
data list / elements=dictionary	List of fault domain entries. Returned: success
availabilityZoneId string	UUID of the availability zone associated with the fault domain, if any. Returned: success
freeCapacity integer	Free physical capacity of the fault domain in GB. Returned: success Sample: `0`
id string	Unique identifier for the fault domain. Returned: success Sample: `"355d32ce-c97f-4adf-9057-49d2e287974b"`
name string	Name of the fault domain. Returned: success Sample: `"SC01-PD01-FD01"`
numberOfStorageNodes integer	Number of storage nodes in the fault domain. Returned: success Sample: `3`
otherVolumeCapacity integer	Capacity used by volumes not categorized elsewhere. Returned: success Sample: `0`
provisionedVolumeCapacity integer	Total provisioned volume capacity. Returned: success Sample: `0`
status string	Current operational status of the fault domain. Returned: success Sample: `"Normal"`
statusSummary string	Summary of the fault domain’s status. Returned: success Sample: `"Normal"`
temporaryVolumeCapacity integer	Capacity used by temporary volumes. Returned: success Sample: `0`
totalCapacity integer	Total physical capacity of the fault domain in GB. Returned: success Sample: `0`
totalVolumeCapacity integer	Total logical volume capacity in the fault domain. Returned: success Sample: `0`
usedCapacity integer	Used physical capacity of the fault domain in GB. Returned: success Sample: `0`
usedCapacityRate integer	Percentage of used capacity in the fault domain. Returned: success Sample: `0`

Authors

Hitachi Vantara LTD (@hitachi-vantara)

hitachivantara.vspone_block.sds_block.hv_sds_block_fault_domain_facts module – Get fault domains from storage system

Synopsis

Requirements

Parameters

Attributes

Examples

Returned Facts