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

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 VSP block 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	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.
blocking_mode string	Setting the protection function for a virtual volume. Required for the Change Pool settings by pool Name with new parameters task. Optional for the Change Pool settings by pool ID with new parameters task. Choices: `"PF"` `"PB"` `"FB"` `"NB"`
depletion_threshold_rate integer	Depletion threshold rate for the pool (not applicable for Thin Image pool). Required for the Create a storage pool using more details /Change Pool settings by pool Name with new parameters tasks. Optional for the Create a Thin Image pool /Change Pool settings by pool ID with new parameters tasks.
end_ldev_id string	The last LDEV number in the range of consecutive LDEV numbers, if such a range is specified. Required for the Create a storage pool with a specific pool ID and start and end LDEV numbers task. Can be decimal or hexadecimal.
end_pool_volume_id string	The last pool volume ID in the range of consecutive pool volume IDs to be removed from the pool. Required for the Shrink pool task.
id integer	Pool ID. Required for the Create a storage pool with a specific pool ID and LDEV numbers /Create a storage pool with a specific pool ID and start and end LDEV numbers /Expand pool by pool ID /Delete pool by pool ID /Performing performance monitoring of a pool /Performing tier relocation of a pool /Restoring a pool /Initializing the capacity saving function for a pool /Change Pool settings by pool ID with new parameters tasks.
ldev_ids list / elements=string	LDEV numbers. Can be decimal or hexadecimal. Required for the Create a storage pool with a specific pool ID and LDEV numbers task.
monitoring_mode string	Execution mode for performance monitoring (monitor mode) for HDT type. Required for the Change Pool settings by pool Name with new parameters task. Optional for the Change Pool settings by pool ID with new parameters task. Choices: `"PM"` `"CM"`
name string	Name of the pool. Required for the Create a storage pool using required details /Create a storage pool using more details /Create a storage pool with a specific pool ID and LDEV numbers /Create a storage pool with a specific pool ID and start and end LDEV numbers /Create a Thin Image pool /Expand pool by pool name /Delete pool by pool name /Delete a pool including pool volumes /Change Pool settings by pool Name with new parameters tasks. Optional for the Change Pool settings by pool ID with new parameters task.
operation_type string	Specify the operation of tier relocation and performance monitoring. Required for the Performing performance monitoring of a pool /Performing tier relocation of a pool tasks. Choices: `"start"` `"stop"`
pool_volume_ids list / elements=string	List of pool volume IDs to be removed from the pool. Required for the Shrink pool task.
pool_volumes list / elements=dictionary	Details about the volumes in the pool. Required for the Create a storage pool using required details /Create a storage pool using more details /Create a Thin Image pool /Expand pool by pool name /Expand pool by pool ID tasks.
capacity string	Capacity of the pool volume. Required for the Create a storage pool using required details /Create a storage pool using more details /Create a Thin Image pool /Expand pool by pool name /Expand pool by pool ID tasks.
cylinder integer	Cylinder size of the pool volume.
parity_group_id string / required	ID of the parity group the volume belongs to. Required for the Create a storage pool using required details /Create a storage pool using more details /Create a Thin Image pool /Expand pool by pool name /Expand pool by pool ID tasks.
resource_group_id integer	ID of the resource group the pool belongs to. Optional for the Create a storage pool using more details /Create a Thin Image pool tasks.
should_delete_pool_volumes boolean	Whether to delete pool volumes when the pool is deleted. Required for the Delete a pool including pool volumes task. Choices: `false` `true`
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 Optional for the Create a storage pool using more details/Create a Thin Image pool tasks. Choices: `false` `true`
should_stop_shrinking boolean	Whether to stop shrinking the pool. Required for the Shrink pool task. Choices: `false` `true`
start_ldev_id string	The first LDEV number in the range of consecutive LDEV numbers, if such a range is specified. Required for the Create a storage pool with a specific pool ID and start and end LDEV numbers task. Can be decimal or hexadecimal.
start_pool_volume_id string	The first pool volume ID in the range of consecutive pool volume IDs to be removed from the pool. Required for the Shrink pool task.
suspend_snapshot boolean	Whether to suspend Thin Image pairs when the depletion threshold is exceeded. Required for the Change Pool settings by pool Name with new parameters task. Optional for the Change Pool settings by pool ID with new parameters task. Choices: `false` `true`
tier dictionary	HDT pool tier attribute. Required for the Change Pool settings by pool Name with new parameters task. Optional for the Change Pool settings by pool ID with new parameters task.
buffer_rate integer	Ratio of buffer areas for reallocation (in percentage) Required for the Change Pool settings by pool Name with new parameters /Change Pool settings by pool ID with new parameters tasks.
table_space_rate integer	Ratio of free space for new tiering (in percentage) Required for the Change Pool settings by pool Name with new parameters /Change Pool settings by pool ID with new parameters tasks.
tier_number integer	Tier number for the pool. Required for the Change Pool settings by pool Name with new parameters /Change Pool settings by pool ID with new parameters tasks.
type string	Type of the pool. Supported types are `HDT`, `HDP`, `HRT`, `HTI`. Required for the Create a storage pool using required details /Create a storage pool using more details /Create a storage pool with a specific pool ID and LDEV numbers /Create a storage pool with a specific pool ID and start and end LDEV numbers /Create a Thin Image pool tasks. Optional for the Change Pool settings by pool ID with new parameters task. Choices: `"HDT"` `"HDP"` `"HRT"` `"HTI"`
virtual_volume_capacity_rate integer	The subscription limit of a virtual volume to pool capacity (%). Required for the Change Pool settings by pool Name with new parameters task. Optional for the Change Pool settings by pool ID with new parameters task.
warning_threshold_rate integer	Warning threshold rate for the pool. Required for the Create a storage pool using more details /Create a Thin Image pool /Change Pool settings by pool Name with new parameters tasks. Optional for the Change Pool settings by pool ID with new parameters task.
state string	The level of the storage pool task. Choices are `present`, `absent`, `restore`, `tier_relocate`, `monitor_performance`, `init_capacity_saving`. In the case you need to execute `restore` pool, you need the operation when the pool is blocked due to Shared memory volatilization. Choices: `"present"` ← (default) `"absent"` `"restore"` `"tier_relocate"` `"monitor_performance"` `"init_capacity_saving"` `"shrunk"`
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"

- name: Delete a Storage Pool including its volumes
  hitachivantara.vspone_block.vsp.hv_storagepool:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: "absent"
    spec:
      name: "test_pool"
      should_delete_pool_volumes: true

- name: Performing performance monitoring of a pool
  hitachivantara.vspone_block.vsp.hv_storagepool:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: "monitor_performance"
    spec:
      id: 48
      operation_type: "start"

- name: Performing tier relocation of a pool
  hitachivantara.vspone_block.vsp.hv_storagepool:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: "relocate"
    spec:
      id: 48
      operation_type: "start"

- name: Restoring a pool
  hitachivantara.vspone_block.vsp.hv_storagepool:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: "restore"
    spec:
      id: 48

- name: Initializing the capacity saving function for a pool
  hitachivantara.vspone_block.vsp.hv_storagepool:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: "init_capacity_saving"
    spec:
      id: 48

- name: Update an existing Storage Pool
  hitachivantara.vspone_block.vsp.hv_storagepool:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: "present"
    spec:
      name: "test_pool"
      warning_threshold_rate: 75
      depletion_threshold_rate: 85

- name: Update Storage Pool with new parameters
  hitachivantara.vspone_block.vsp.hv_storagepool:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: "present"
    spec:
      name: "test_pool"
      warning_threshold_rate: 78
      depletion_threshold_rate: 88
      virtual_volume_capacity_rate: 90
      monitoring_mode: "PF"
      blocking_mode: "PM"
      suspend_snapshot: true
      tier:
        tier_number: 1
        tablespace_rate: 60
        buffer_rate: 20

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
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_compression_acceleration_available boolean	Indicates if compression acceleration is available. Returned: success Sample: `true`
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_module.html