hitachivantara.vspone_block.vsp.hv_storagepool_facts module – Retrieves storage pool information from VSP block storage systems.

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.vsp.hv_storagepool_facts.

New in hitachivantara.vspone_block 3.0.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Returned Facts

Synopsis

This module retrieves information about storage pools from VSP block storage systems.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/storagepool_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.
api_token string	Token used to operate on locked resources.
connection_type string	Type of connection to the storage system. Choices: `"direct"` ← (default)
password string	Password for authentication. This is a required field.
username string	Username for authentication. This is a required field.
spec dictionary	Specification for the storage pool facts to be gathered.
include_cache_info boolean	Specify whether to include cache information about the storage pools. Choices: `false` `true`
include_details boolean	Specify whether to include extended details about the storage pools. Choices: `false` `true`
is_mainframe boolean	Specify whether the pool is for mainframe. Choices: `false` `true`
pool_id integer	The pool number of the specific pool to retrieve. Required for the Get one storage pool task.
pool_name string	The name of the specific pool to retrieve. Required for the Get one storage pool using pool name task.
storage_system_info dictionary	Information about the storage system. This field is an optional field.
serial string	The serial number of the storage system.

Attributes

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

Notes

Note

The output parameters subscriber_id and partner_id were removed in version 3.4.0. They were also deprecated due to internal API simplification and are no longer supported.
Connection type gateway was removed starting from version 3.4.0. Please use an earlier version if you require this connection type.

Examples

- name: Get all pools
  hitachivantara.vspone_block.vsp.hv_storagepool_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"

- name: Get a specific pool
  hitachivantara.vspone_block.vsp.hv_storagepool_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      pool_id: 0

- name: Get a specific pool using pool name
  hitachivantara.vspone_block.vsp.hv_storagepool_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      pool_name: "PoolName"

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_pool list / elements=dictionary	The storage pool information. Returned: success
auto_add_pool_vol string	The auto add pool volume setting. Returned: success Sample: `""`
available_physical_volume_capacity_mb integer	The available physical volume capacity in MB. Returned: success Sample: `14591094`
available_volume_capacity_mb integer	The available volume capacity in MB. Returned: success Sample: `14591094`
blocking_mode string	The blocking mode of the pool. Returned: success Sample: `"NB"`
capacities_excluding_system_data dictionary	Capacity information excluding system data. Returned: success
compressed_capacity integer	The compressed capacity. Returned: success Sample: `0`
deduped_capacity integer	The deduplicated capacity. Returned: success Sample: `0`
pre_compressed_capacity integer	The pre-compressed capacity. Returned: success Sample: `0`
pre_dedupred_capacity integer	The pre-deduplicated capacity. Returned: success Sample: `0`
pre_used_capacity integer	The pre-used capacity. Returned: success Sample: `0`
reclaimed_capacity integer	The reclaimed capacity. Returned: success Sample: `0`
system_data_capacity integer	The system data capacity. Returned: success Sample: `1118208`
used_virtual_volume_capacity integer	The used virtual volume capacity. Returned: success Sample: `258048`
compression_rate integer	The compression rate. Returned: success Sample: `0`
dat string	The DAT information. Returned: success Sample: `""`
data_reduction_accelerate_comp_capacity_mb integer	The data reduction accelerate compression capacity in MB. Returned: success Sample: `0`
data_reduction_accelerate_comp_including_system_data dictionary	Data reduction accelerate compression including system data. Returned: success
is_reduction_capacity_available boolean	Whether reduction capacity is available. Returned: success Sample: `false`
is_reduction_rate_available boolean	Whether reduction rate is available. Returned: success Sample: `false`
reduction_capacity integer	The reduction capacity. Returned: success Sample: `-1`
reduction_rate integer	The reduction rate. Returned: success Sample: `-1`
data_reduction_accelerate_comp_rate integer	The data reduction accelerate compression rate. Returned: success Sample: `0`
data_reduction_before_capacity_mb integer	The data reduction before capacity in MB. Returned: success Sample: `0`
data_reduction_capacity_mb integer	The data reduction capacity in MB. Returned: success Sample: `0`
data_reduction_including_system_data dictionary	Data reduction including system data. Returned: success
is_reduction_capacity_available boolean	Whether reduction capacity is available. Returned: success Sample: `false`
is_reduction_rate_available boolean	Whether reduction rate is available. Returned: success Sample: `false`
reduction_capacity integer	The reduction capacity. Returned: success Sample: `-1`
reduction_rate integer	The reduction rate. Returned: success Sample: `-1`
data_reduction_rate integer	The data reduction rate. Returned: success Sample: `0`
depletion_threshold integer	The depletion threshold. Returned: success Sample: `80`
duplication_ldev_ids list / elements=integer	List of duplication LDEV IDs. Returned: success Sample: `[32731, 32730, 32729, 32728]`
duplication_ldev_ids_hex list / elements=string	List of duplication LDEV IDs in hexadecimal format. Returned: success Sample: `["00:7F:DB", "00:7F:DA", "00:7F:D9", "00:7F:D8"]`
duplication_number integer	The number of duplications. Returned: success Sample: `8`
duplication_rate integer	The duplication rate. Returned: success Sample: `0`
effective_capacity_mb integer	The effective capacity in MB. Returned: success Sample: `14591766`
efficiency integer	The efficiency value. Returned: success
first_ldev_id integer	The first LDEV ID. Returned: success Sample: `32754`
formatted_capacity integer	The formatted capacity. Returned: success Sample: `-1`
has_blocked_pool_volume boolean	Whether the pool has blocked pool volume. Returned: success
is_mainframe boolean	Whether the pool is for mainframe. Returned: success Sample: `false`
is_shrinking boolean	Whether the pool is shrinking. Returned: success Sample: `false`
located_volume_count integer	The count of located volumes. Returned: success Sample: `29`
monitoring_mode string	The monitoring mode. Returned: success Sample: `""`
num_of_ldevs integer	The number of LDEVs. Returned: success Sample: `12`
pool_action_mode string	The pool action mode. Returned: success Sample: `""`
pool_id integer	The pool ID. Returned: success Sample: `0`
pool_name string	The name of the pool. Returned: success Sample: `"test-ddp-pool_1"`
pool_status string	The status of the pool. Returned: success Sample: `"NORMAL"`
pool_type string	The type of the pool. Returned: success Sample: `"HDP"`
reserved_volume_count integer	The count of reserved volumes. Returned: success Sample: `0`
snapshot_count integer	The count of snapshots. Returned: success Sample: `1`
snapshot_used_capacity_mb integer	The snapshot used capacity in MB. Returned: success Sample: `0`
suspend_snapshot boolean	Whether snapshot is suspended. Returned: success Sample: `true`
tier_operation_status string	The tier operation status. Returned: success Sample: `""`
tiers list / elements=dictionary	List of tiers. Returned: success Sample: `[]`
total_located_capacity_mb integer	The total located capacity in MB. Returned: success Sample: `33597984`
total_physical_capacity_mb integer	The total physical capacity in MB. Returned: success Sample: `14591766`
total_pool_capacity_mb integer	The total pool capacity in MB. Returned: success Sample: `14591766`
total_reserved_capacity_mb integer	The total reserved capacity in MB. Returned: success Sample: `0`
used_capacity_rate integer	The used capacity rate. Returned: success Sample: `1`
used_physical_capacity integer	The used physical capacity. Returned: success Sample: `-1`
used_physical_capacity_rate integer	The used physical capacity rate. Returned: success Sample: `1`
virtual_volume_capacity_rate integer	The virtual volume capacity rate. Returned: success Sample: `-1`
warning_threshold integer	The warning threshold. Returned: success Sample: `70`

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/vsp.hv_storagepool_facts_module.html