hitachivantara.vspone_block.sds_block.hv_sds_block_storage_pool_facts module – Retrieves information about VSP One SDS Block and Cloud systems storage pools.

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

New in hitachivantara.vspone_block 4.1.0

Synopsis
Requirements
Parameters
Attributes
Examples
Returned Facts

Synopsis

This module retrieves information about storage pools.
It provides details about a storage pool such as ID, name and other details.
For examples go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/storage_pool_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 storage pool information.
id string	The ID of a storage pool. Required for the Get storage pool by ID task.
names list / elements=string	Storage pool names. Required for the Get storage pool by names task.

Attributes

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

Examples

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

- name: Retrieve information about storage pools by names
  hitachivantara.vspone_block.sds_block.hv_sds_block_storage_pool_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      names: ["SP01", "SP02"]

- name: Retrieve information about storage pool by ID
  hitachivantara.vspone_block.sds_block.hv_sds_block_storage_pool_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      id: "a632b0d8-0ae6-408c-ad41-555cdde9fe83"

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
storage_pools list / elements=dictionary	A list of storage pools. Returned: success
blocked_physical_capacity_mb integer	The blocked capacity in the effective physical capacity of the storage pool in MiB. Returned: success Sample: `0`
capacity_manage dictionary	Capacity management settings for the storage pool. Returned: success
maximum_reserve_rate integer	Maximum reserve rate (unit -%). -1 indicates the capacity is unlimited. Returned: success Sample: `-1`
threshold_depletion integer	The depletion threshold (unit - %). Returned: success Sample: `80`
threshold_storage_controller_depletion integer	The depletion threshold of the storage controller managing the storage pool (unit - %). Returned: success Sample: `95`
threshold_warning integer	The warning threshold (unit - %). Returned: success Sample: `70`
used_capacity_rate integer	Usage rate (unit - %). Returned: success Sample: `0`
data_redundancy integer	Redundancy of user data. Value of 0 means no redundancy, and -1 means that the user data has been lost. Returned: success Sample: `1`
encryption_status string	The state of storage pool data encryption. Returned: success Sample: `"Disabled"`
free_capacity_mb integer	The available capacity of the storage pool in MiB. Returned: success Sample: `24801000`
id string	The ID of the storage pool. Returned: success Sample: `"80d306ea-d224-4fb1-a746-5ed41994e708"`
meta_data_physical_capacity_mb integer	The capacity for control information in the total physical capacity of the storage pool in MiB. Returned: success Sample: `8552760`
name string	The name of the storage pool. Returned: success Sample: `"SP01"`
number_of_volumes integer	The number of volumes belonging to the storage pool. Returned: success Sample: `10`
other_volume_capacity_mb integer	The total capacity of other volumes that have been created on this storage controller in MiB. Returned: success Sample: `0`
protection_domain_id string	The ID of the protection domain to which the storage pool belongs. Returned: success Sample: `"66449f50-caa4-4070-ade1-e81f29614741"`
provisioned_volume_capacity_mb integer	The total capacity of provisioned volumes that have been created on this storage controller in MiB. Returned: success Sample: `72904`
rebuild_capacity_policy string	Rebuild capacity policy. Returned: success Sample: `"Fixed"`
rebuild_capacity_resource_setting dictionary	Resource type and the number of resources of rebuild capacity. Returned: success
number_of_tolerable_drive_failures integer	The number of drive failures that can be tolerated. Returned: success Sample: `1`
rebuild_capacity_status string	The status of securing rebuild capacity. Returned: success Sample: `"Sufficient"`
rebuildable_resources dictionary	Resources for which rebuild is possible. Returned: success
number_of_drives integer	The number of drives for which rebuild is possible. Returned: success Sample: `1`
redundant_policy string	User data protection method. Returned: success Sample: `"HitachiPolyphaseErasureCoding"`
redundant_type string	User data protection type. Returned: success Sample: `"4D+1P"`
reserved_physical_capacity_mb integer	The internally reserved area in the effective physical capacity of the storage pool in MiB. Returned: success Sample: `6205500`
saving_effects dictionary	Effect of the data reduction function on the storage pool. Returned: success
calculation_end_time string	Date and time the calculation ended. Returned: success Sample: `"2025-11-27T09:13:02Z"`
calculation_start_time string	Date and time the calculation started. Returned: success Sample: `"2025-11-27T09:12:16Z"`
data_reduction_without_system_data_status string	Status of the reduction effect of the data reduction function. Returned: success Sample: `"NoTargetData"`
total_efficiency_status string	Status of total efficiency. Returned: success Sample: `"Unknown"`
status string	The storage pool status. Returned: success Sample: `"Normal"`
status_summary string	The summary of the storage pool status. Returned: success Sample: `"Normal"`
storage_controller_capacities_general_status string	Summary information about the capacity status of all the storage controllers managing the storage pool. Returned: success Sample: `"Normal"`
temporary_volume_capacity_mb integer	The total capacity of temporary volumes that have been created on this storage controller in MiB. Returned: success Sample: `0`
total_capacity_mb integer	The logical capacity of the storage pool in MiB. Returned: success Sample: `24801000`
total_physical_capacity_mb integer	The total physical capacity of the storage pool in MiB. Returned: success Sample: `45785760`
total_raw_capacity_mb integer	The effective physical capacity in the total physical capacity of the storage pool in MiB. Returned: success Sample: `37233000`
total_volume_capacity_mb integer	The total capacity of volumes that have been created on this storage controller in MiB. Returned: success Sample: `72904`
usable_physical_capacity_mb integer	The capacity which can be used as the logical capacity in the effective physical capacity of the storage pool in MiB. Returned: success Sample: `31027500`
used_capacity_mb integer	The used capacity of the storage pool in MiB. 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_storage_pool_facts_module.html