hitachivantara.vspone_block.sds_block.hv_sds_block_fault_domain_facts module – Retrieves information about fault domains.

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

New in hitachivantara.vspone_block 4.1.0

Synopsis
Requirements
Parameters
Attributes
Examples
Returned Facts

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). Required for the Get one fault domain by ID task.
name string	Filter fault domains by name. Required for the Get one fault domain by name task.

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
fault_domain dictionary	Fault domain information container. Returned: success
data list / elements=dictionary	List of fault domain entries. Returned: success
availability_zone_id string	UUID of the availability zone associated with the fault domain, if any. Returned: success
free_capacity integer	Free physical capacity of the fault domain in GB. Returned: success Sample: `9518712`
id string	Unique identifier for the fault domain. Returned: success Sample: `"b152a02e-47e7-4d93-a010-d90b3bfc9aa4"`
logical_zone string	Logical zone associated with the fault domain, if any. Returned: success
name string	Name of the fault domain. Returned: success Sample: `"SC01-PD01-FD01"`
number_of_storage_nodes integer	Number of storage nodes in the fault domain. Returned: success Sample: `3`
other_volume_capacity integer	Capacity used by volumes not categorized elsewhere. Returned: success Sample: `300`
physical_zone string	Physical zone associated with the fault domain, if any. Returned: success
provisioned_volume_capacity integer	Total provisioned volume capacity. Returned: success Sample: `18398`
status string	Current operational status of the fault domain. Returned: success Sample: `"Normal"`
status_summary string	Summary of the fault domain’s status. Returned: success Sample: `"Normal"`
temporary_volume_capacity integer	Capacity used by temporary volumes. Returned: success Sample: `0`
total_capacity integer	Total physical capacity of the fault domain in GB. Returned: success Sample: `9519048`
total_volume_capacity integer	Total logical volume capacity in the fault domain. Returned: success Sample: `18698`
used_capacity integer	Used physical capacity of the fault domain in GB. Returned: success Sample: `336`
used_capacity_rate integer	Percentage of used capacity in the fault domain. Returned: success Sample: `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_fault_domain_facts_module.html