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 4.4.0).

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

• 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	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.
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. 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_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 / required	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.
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
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.
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"
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
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

• Issue Tracker
• Repository (Sources)