hitachivantara.vspone_block.sds_block.hv_sds_block_storage_controller_facts module – Get storage_controllers from storage system

Note

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

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_controller_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

Parameters for filtering or identifying snapshots to gather facts about.

id

string

Filter storage_controllers by ID (UUID format).

primary_fault_domain_id

string

Filter storage_controllers by primary fault domain id.

primary_fault_domain_name

string

Filter storage_controllers by primary fault domain name.

Attributes

Attribute

Support

Description

check_mode

Support: full

Determines if the module should run in check mode.

Examples

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

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

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 storage controller entries.

Returned: success

active_storage_node_id

string

UUID of the active storage node.

Returned: success

Sample: "7eb3f987-804f-4bc5-9d40-aff9392d507d"

allocatable_capacity

integer

Total allocatable capacity in GB.

Returned: success

Sample: 0

allocatable_capacity_usage_rate

integer

Percentage of allocatable capacity used.

Returned: success

Sample: 0

capacities_excluding_system_data

dictionary

Capacity details excluding system data.

Returned: success

compressed_capacity

integer

Compressed capacity excluding system data.

Returned: success

Sample: 0

pre_compressed_capacity

integer

Pre-compressed capacity before optimization.

Returned: success

Sample: 0

pre_used_capacity

integer

Pre-used capacity before compression.

Returned: success

Sample: 0

reclaimed_capacity

integer

Reclaimed capacity excluding system data.

Returned: success

Sample: 0

system_data_capacity

integer

Capacity used by system data.

Returned: success

Sample: 0

used_volume_capacity

integer

Used volume capacity excluding system data.

Returned: success

Sample: 0

capacity_status

string

Status of capacity health.

Returned: success

Sample: "Normal"

currently_allocatable_capacity

integer

Currently allocatable capacity in GB.

Returned: success

Sample: 0

currently_allocatable_capacity_usage_rate

integer

Percentage of currently allocatable capacity used.

Returned: success

Sample: 0

data_rebalance_progress_rate

integer

Progress rate of data rebalance in percentage.

Returned: success

data_rebalance_status

string

Current status of data rebalance operation.

Returned: success

Sample: "Stopped"

free_capacity

integer

Free capacity available in GB.

Returned: success

Sample: 0

id

string

Unique identifier for the storage controller.

Returned: success

Sample: "25244614-4af4-4922-839a-8528c9e4fd7f"

is_detailed_logging_mode

boolean

Indicates if detailed logging mode is enabled.

Returned: success

Sample: false

logical_limit

integer

Logical limit of capacity usage.

Returned: success

Sample: 0

meta_data_redundancy_of_cache_protection

integer

Redundancy level for cache protection.

Returned: success

Sample: 1

other_volume_capacity

integer

Capacity used by other volume types.

Returned: success

Sample: 0

pin_information

any

Additional pin-related configuration or state.

Returned: success

primary_fault_domain_id

string

UUID of the primary fault domain.

Returned: success

Sample: "355d32ce-c97f-4adf-9057-49d2e287974b"

provisioned_volume_capacity

integer

Provisioned volume capacity.

Returned: success

Sample: 0

secondary_standby_storage_node_id

string

UUID of the secondary standby node, if any.

Returned: success

standby_storage_node_id

string

UUID of the standby storage node.

Returned: success

Sample: "a8056f21-e4ee-4e3a-a139-bee4de98d8c7"

status

string

Operational status of the storage controller.

Returned: success

Sample: "Normal"

temporary_volume_capacity

integer

Capacity used by temporary volumes.

Returned: success

Sample: 0

total_volume_capacity

integer

Total volume capacity.

Returned: success

Sample: 0

used_capacity

integer

Used capacity in GB.

Returned: success

Sample: 0

volume_maximum_capacity

integer

Maximum volume capacity.

Returned: success

Sample: 0

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)