hitachivantara.vspone_block.sds_block.hv_sds_block_protection_domain_facts module – Get protection domains from storage system

Note

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

New in hitachivantara.vspone_block 4.1.0

Synopsis

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 protection domain information.

id

string

The ID of the protection domain.

Attributes

Attribute

Support

Description

check_mode

Support: full

Determines if the module should run in check mode.

Examples

- name: Retrieve information about Protection Domains
  hitachivantara.vspone_block.sds_block.hv_sds_block_protection_domain_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

- name: Retrieve information about Protection Domain by ID
  hitachivantara.vspone_block.sds_block.hv_sds_block_protection_domain_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      id: "13d017d1-5448-4c4c-8284-7ab1b53a17cd"

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 protection domain entries.

Returned: success

async_processing_resource_usage_rate

string

Usage level of asynchronous processing resources.

Returned: success

Sample: "High"

drive_data_relocation_progress_rate

integer

Progress percentage of data relocation. Null if not active.

Returned: success

drive_data_relocation_status

string

Current status of drive data relocation.

Returned: success

Sample: "Stopped"

id

string

Unique identifier for the protection domain.

Returned: success

Sample: "0778a123-42e5-43ff-8fbc-c8580b79f2cf"

memory_mode

string

Memory mode used in the protection domain.

Returned: success

Sample: "VolatileMemory"

minimum_memory_size

integer

Minimum memory size in MB.

Returned: success

Sample: 131072

name

string

Name of the protection domain.

Returned: success

Sample: "SC01-PD01"

number_of_fault_domains

integer

The total number of fault domains in the protection domain.

Returned: success

Sample: 1

rebuild_progress_rate

integer

Rebuild progress rate as a percentage. Null if not rebuilding.

Returned: success

rebuild_status

string

Current rebuild status.

Returned: success

Sample: "Stopped"

redundant_policy

string

Redundancy policy used by the protection domain.

Returned: success

Sample: "HitachiPolyphaseErasureCoding"

redundant_type

string

Redundancy type used in the protection domain (e.g., 4D+1P).

Returned: success

Sample: "4D+1P"

storage_controller_clustering_policy

string

Clustering policy of the storage controllers.

Returned: success

Sample: "OneRedundantStorageNode"

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)