W3cubDocs

/Ansible

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

Note

This module is part of the hitachivantara.vspone_block collection (version 3.5.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 Hitachi VSP 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	This field is used to pass the value of the lock token 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 if api_token is not provided.
username string	Username for authentication. This is a required field if api_token is not provided.
spec dictionary	Specification for the storage pool facts to be gathered.
pool_id integer	The pool number of the specific pool to retrieve.
pool_name string	The name of the specific pool to retrieve.
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
deduplication_enabled boolean	Indicates if deduplication is enabled. Returned: success Sample: `false`
depletion_threshold_rate integer	The depletion threshold rate. Returned: success Sample: `80`
dp_volumes list / elements=dictionary	List of DP volumes. Returned: success
logical_unit_id integer	The logical unit ID. Returned: success Sample: `0`
size string	The size of the volume. Returned: success Sample: `"21.00 GB"`
free_capacity integer	The free capacity in bytes. Returned: success Sample: `6297747456`
free_capacity_in_units string	The free capacity in human-readable units. Returned: success Sample: `"5.87 GB"`
is_encrypted boolean	Indicates if the pool is encrypted. Returned: success Sample: `true`
ldev_ids list / elements=integer	List of LDEV IDs. Returned: success Sample: `[1285]`
pool_id integer	The pool ID. Returned: success Sample: `48`
pool_name string	The name of the pool. Returned: success Sample: `"test_pool"`
pool_type string	The type of the pool. Returned: success Sample: `"HDP"`
replication_data_released_rate integer	The replication data released rate. Returned: success Sample: `-1`
replication_depletion_alert_rate integer	The replication depletion alert rate. Returned: success Sample: `-1`
replication_usage_rate integer	The replication usage rate. Returned: success Sample: `-1`
resource_group_id integer	The resource group ID. Returned: success Sample: `-1`
status string	The status of the pool. Returned: success Sample: `"NORMAL"`
subscription_limit_rate integer	The subscription limit rate. Returned: success Sample: `-1`
subscription_rate integer	The subscription rate. Returned: success Sample: `0`
subscription_warning_rate integer	The subscription warning rate. Returned: success Sample: `-1`
total_capacity integer	The total capacity in bytes. Returned: success Sample: `6297747456`
total_capacity_in_units string	The total capacity in human-readable units. Returned: success Sample: `"5.87 GB"`
utilization_rate integer	The utilization rate. Returned: success Sample: `0`
virtual_volume_count integer	The count of virtual volumes. Returned: success Sample: `0`
warning_threshold_rate integer	The warning threshold rate. 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/ansible/latest/collections/hitachivantara/vspone_block/vsp.hv_storagepool_facts_module.html