dellemc.unity.storagepool module – Manage storage pool on Unity
Note
This module is part of the dellemc.unity collection (version 1.6.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 dellemc.unity.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: dellemc.unity.storagepool.
New in dellemc.unity 1.1.0
Synopsis
Managing storage pool on Unity storage system contains the operations Get details of storage pool, Create a storage pool, Modify storage pool.
Requirements
The below requirements are needed on the host that executes this module.
A Dell Unity Storage device version 5.1 or later.
Ansible-core 2.12 or later.
Python 3.9, 3.10 or 3.11.
Storops Python SDK 1.2.11.
Parameters
Parameter |
Comments |
|---|---|
Threshold at which the system will generate alerts about the free space in the pool, specified as a percentage. Minimum threshold limit is 50. Maximum threshold limit is 84. |
|
Indicates whether the fast cache is enabled for the storage pool.
Choices:
|
|
Indicates whether to enable scheduled data relocations for the pool.
Choices:
|
|
Enable/Disable automatic deletion of snapshots based on pool space usage. Choices:
|
|
Enable/Disable automatic deletion of snapshots based on pool space usage. Choices:
|
|
New name of the storage pool, unique in the storage system. |
|
The password of the Unity management server. |
|
The description of the storage pool. |
|
Max threshold for space used in pool beyond which the system automatically starts deleting snapshots in the pool. Applies when the automatic deletion of snapshots based on pool space usage is enabled for the system and pool. Minimum pool harvest high threshold value is 1. Maximum pool harvest high threshold value is 99. |
|
Min threshold for space used in pool below which the system automatically stops deletion of snapshots in the pool. Applies when the automatic deletion of snapshots based on pool space usage is enabled for the system and pool. Minimum pool harvest low threshold value is 0. Maximum pool harvest low threshold value is 98. |
|
Unique identifier of the pool instance. |
|
Name of the storage pool, unique in the storage system. |
|
Indicates storage pool type. Choices:
|
|
Port number through which communication happens with Unity management server. Default: |
|
Parameters to create RAID group from the disks and add it to the pool. |
|
Id of the disk group. |
|
Number of disks. |
|
RAID group types or RAID levels. Choices:
|
|
RAID group stripe widths, including parity or mirror disks. Choices:
|
|
Max threshold for space used in snapshot beyond which the system automatically starts deleting snapshots in the pool. Applies when the automatic deletion of snapshots based on pool space usage is enabled for the pool. Minimum snap harvest high threshold value is 1. Maximum snap harvest high threshold value is 99. |
|
Min threshold for space used in snapshot below which the system will stop automatically deleting snapshots in the pool. Applies when the automatic deletion of snapshots based on pool space usage is enabled for the pool. Minimum snap harvest low threshold value is 0. Maximum snap harvest low threshold value is 98. |
|
Define whether the storage pool should exist or not.
Choices:
|
|
IP or FQDN of the Unity management server. |
|
The username of the Unity management server. |
|
Boolean variable to specify whether or not to validate SSL certificate.
Choices:
|
Notes
Note
Deletion of storage pool is not allowed through Ansible module.
The check_mode is not supported.
The modules present in this collection named as ‘dellemc.unity’ are built to support the Dell Unity storage platform.
Examples
- name: Get Storage pool details using pool_name
dellemc.unity.storagepool:
unispherehost: "{{unispherehost}}"
username: "{{username}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
pool_name: "{{pool_name}}"
state: "present"
- name: Get Storage pool details using pool_id
dellemc.unity.storagepool:
unispherehost: "{{unispherehost}}"
username: "{{username}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
pool_id: "{{pool_id}}"
state: "present"
- name: Modify Storage pool attributes using pool_name
dellemc.unity.storagepool:
unispherehost: "{{unispherehost}}"
username: "{{username}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
pool_name: "{{pool_name}}"
new_pool_name: "{{new_pool_name}}"
pool_description: "{{pool_description}}"
fast_cache: "{{fast_cache_enabled}}"
fast_vp: "{{fast_vp_enabled}}"
state: "present"
- name: Modify Storage pool attributes using pool_id
dellemc.unity.storagepool:
unispherehost: "{{unispherehost}}"
username: "{{username}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
pool_id: "{{pool_id}}"
new_pool_name: "{{new_pool_name}}"
pool_description: "{{pool_description}}"
fast_cache: "{{fast_cache_enabled}}"
fast_vp: "{{fast_vp_enabled}}"
state: "present"
- name: Create a StoragePool
dellemc.unity.storagepool:
unispherehost: "{{unispherehost}}"
username: "{{username}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
pool_name: "Test"
pool_description: "test pool"
raid_groups:
disk_group_id : "dg_16"
disk_num : 2
raid_type : "RAID10"
stripe_width : "BEST_FIT"
alert_threshold : 50
is_harvest_enabled : True
pool_harvest_high_threshold : 60
pool_harvest_low_threshold : 40
is_snap_harvest_enabled : True
snap_harvest_high_threshold : 70
snap_harvest_low_threshold : 50
fast_vp: "enabled"
fast_cache: "enabled"
pool_type : "DYNAMIC"
state: "present"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Whether or not the storage pool has changed. Returned: always Sample: |
|
The storage pool details. Returned: When storage pool exists. Sample: |
|
Indicates information about the drives associated with the storage pool. Returned: success |
|
Indicates disk technology of the drive. Returned: success |
|
Unique identifier of the drive. Returned: success |
|
Indicates name of the drive. Returned: success |
|
Indicates size of the drive. Returned: success |
|
Indicates tier type of the drive. Returned: success |
|
Pool id, unique identifier of the pool. Returned: success |
|
Indicates whether the fast cache is enabled for the storage pool. true - FAST Cache is enabled for the pool. false - FAST Cache is disabled for the pool. Returned: success |
|
Indicates whether to enable scheduled data relocations for the storage pool. true - Enabled scheduled data relocations for the pool. false - Disabled scheduled data relocations for the pool. Returned: success |
|
Pool name, unique in the storage system. Returned: success |
|
Indicates size_free with its appropriate unit in human readable form. Returned: success |
|
Indicates size_subscribed with its appropriate unit in human readable form. Returned: success |
|
Indicates size_total with its appropriate unit in human readable form. Returned: success |
|
Indicates size_used with its appropriate unit in human readable form. Returned: success |
|
Indicates snap_size_subscribed with its appropriate unit in human readable form. Returned: success |
|
Indicates snap_size_used with its appropriate unit in human readable form. Returned: success |