W3cubDocs

/Ansible

hitachivantara.vspone_block.vsp.hv_storagepool module – Manage storage pool information on 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.

New in hitachivantara.vspone_block 3.1.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Return Values

Synopsis

Create, update, or delete storage pool information on Hitachi VSP storage systems.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/storagepool.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.
depletion_threshold_rate integer	Depletion threshold rate for the pool (not applicable for Thin Image pool).
end_ldev_id integer	The last LDEV number in the range of consecutive LDEV numbers, if such a range is specified.
id integer	Pool ID.
ldev_ids list / elements=integer	LDEV numbers.
name string	Name of the pool.
pool_volumes list / elements=dictionary	Details about the volumes in the pool.
capacity string / required	Capacity of the pool volume.
parity_group_id string / required	ID of the parity group the volume belongs to.
resource_group_id integer	ID of the resource group the pool belongs to.
should_enable_deduplication boolean	Whether to enable deduplication for the pool. This feature is applicable to the following models VSP G200 VSP G400 VSP F400 VSP G600 VSP F600 VSP G800 VSP F800 VSP G400 with NAS module VSP G600 with NAS module VSP G800 with NAS module VSP G1000 VSP G1500 VSP F1500 VSP N400 VSP N600 VSP N800 Choices: `false` `true`
start_ldev_id integer	The first LDEV number in the range of consecutive LDEV numbers, if such a range is specified.
type string	Type of the pool. Supported types are `HDT`, `HDP`, `HRT`, `HTI`. Choices: `"HDT"` `"HDP"` `"HRT"` `"HTI"`
warning_threshold_rate integer	Warning threshold rate for the pool.
state string	The level of the storage pool task. Choices are `present`, `absent` . Choices: `"present"` ← (default) `"absent"`
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: none	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: Create a Storage Pool
  hitachivantara.vspone_block.vsp.hv_storagepool:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: "present"
    spec:
      name: "test_pool"
      type: "HDP"
      should_enable_deduplication: true
      depletion_threshold_rate: 80
      warning_threshold_rate: 70
      resource_group_id: 0
      pool_volumes:
        - capacity: "21.00 GB"
          parity_group_id: "1-2"

- name: Delete a Storage Pool by pool name
  hitachivantara.vspone_block.vsp.hv_storagepool:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: "absent"
    spec:
      name: "test_pool"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
storage_pool list / elements=dictionary	The storage pool information. Returned: always
deduplication_enabled boolean	Indicates if deduplication is enabled. Returned: success Sample: `false`
depletion_threshold_rate integer	Depletion threshold rate for the pool. Returned: success Sample: `80`
dp_volumes list / elements=dictionary	List of DP volumes in the pool. Returned: success
logical_unit_id integer	Logical unit ID of the volume. Returned: success Sample: `0`
size string	Size of the volume. Returned: success Sample: `"21.00 GB"`
free_capacity integer	Free capacity of the pool in bytes. Returned: success Sample: `6297747456`
free_capacity_in_units string	Free capacity of the pool 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 in the pool. Returned: success Sample: `[1285]`
pool_id integer	ID of the pool. Returned: success Sample: `48`
pool_name string	Name of the pool. Returned: success Sample: `"test_pool"`
pool_type string	Type of the pool. Returned: success Sample: `"HDP"`
replication_data_released_rate integer	Replication data released rate. Returned: success Sample: `-1`
replication_depletion_alert_rate integer	Replication depletion alert rate. Returned: success Sample: `-1`
replication_usage_rate integer	Replication usage rate. Returned: success Sample: `-1`
resource_group_id integer	ID of the resource group the pool belongs to. Returned: success Sample: `-1`
status string	Status of the pool. Returned: success Sample: `"NORMAL"`
subscription_limit_rate integer	Subscription limit rate. Returned: success Sample: `-1`
subscription_rate integer	Subscription rate. Returned: success Sample: `0`
subscription_warning_rate integer	Subscription warning rate. Returned: success Sample: `-1`
total_capacity integer	Total capacity of the pool in bytes. Returned: success Sample: `6297747456`
total_capacity_in_units string	Total capacity of the pool in human-readable units. Returned: success Sample: `"5.87 GB"`
utilization_rate integer	Utilization rate of the pool. Returned: success Sample: `0`
virtual_volume_count integer	Number of virtual volumes in the pool. Returned: success Sample: `0`
warning_threshold_rate integer	Warning threshold rate for the pool. 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_module.html