dellemc.powerflex.storagepool_v2 module – Managing storage pool on Dell PowerFlex 5.x
Note
This module is part of the dellemc.powerflex collection (version 3.0.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.powerflex.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: dellemc.powerflex.storagepool_v2.
New in dellemc.powerflex 3.0.0
Synopsis
Dell PowerFlex storage pool module includes getting the details of storage pool, creating a new storage pool, and modifying the attribute of a storage pool.
Requirements
The below requirements are needed on the host that executes this module.
A Dell PowerFlex storage system version 5.0 or later.
PyPowerFlex 2.0.0
Parameters
Parameter |
Comments |
|---|---|
The capacity alert thresholds. |
|
The critical threshold. |
|
The high threshold. |
|
The compression method. Choices:
|
|
The ID of the device group. |
|
The name of the device group. |
|
IP or FQDN of the PowerFlex host. |
|
The over-provisioning factor. |
|
The password of the PowerFlex host. |
|
The physical size in GB. If ‘use_all_available_capacity’ is set to true, this parameter cannot be specified. If ‘use_all_available_capacity’ is set to false, this parameter is required. |
|
Port number through which communication happens with PowerFlex host. Default: |
|
The id of the protection domain. During creation of a pool, either protection domain name or id must be mentioned. Mutually exclusive with protection_domain_name. |
|
The name of the protection domain. During creation of a pool, either protection domain name or id must be mentioned. Mutually exclusive with protection_domain_id. |
|
The protection scheme. Choices:
|
|
The state of the storage pool. Can be ‘present’ or ‘absent’. Choices:
|
|
The id of the storage pool. It is auto generated, hence should not be provided during creation of a storage pool. Mutually exclusive with storage_pool_name. |
|
The name of the storage pool. If more than one storage pool is found with the same name then protection domain id/name is required to perform the task. Mutually exclusive with storage_pool_id. |
|
New name for the storage pool can be provided. This parameter is used for renaming the storage pool. |
|
Time after which connection will get terminated. It is to be mentioned in seconds. Default: |
|
Whether to use all available capacity for storage pool. When set to true, the ‘physical_size_gb’ parameter cannot be specified. When set to false, the ‘physical_size_gb’ parameter is required. Choices:
|
|
The username of the PowerFlex host. |
|
Boolean variable to specify whether or not to validate SSL certificate.
Choices:
|
Notes
Note
This module is supported on Dell PowerFlex 5.x and later versions.
The check_mode is supported.
The modules present in the collection named as ‘dellemc.powerflex’ are built to support the Dell PowerFlex storage platform.
Examples
- name: Get the details of storage pool by name
dellemc.powerflex.storagepool_v2:
hostname: "{{hostname}}"
username: "{{username}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
storage_pool_name: "sample_pool_name"
protection_domain_name: "sample_protection_domain"
state: "present"
- name: Get the details of storage pool by id
dellemc.powerflex.storagepool_v2:
hostname: "{{hostname}}"
username: "{{username}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
storage_pool_id: "abcd1234ab12r"
state: "present"
- name: Create a new Storage pool
dellemc.powerflex.storagepool_v2:
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
validate_certs: "{{ validate_certs }}"
storage_pool_name: "{{ pool_name }}"
protection_domain_name: "{{ protection_domain_name }}"
device_group_name: "{{ device_group_name }}"
cap_alert_thresholds:
high_threshold: 80
critical_threshold: 90
compression_method: Normal
over_provisioning_factor: 2
physical_size_gb: 100
protection_scheme: TwoPlusTwo
state: "present"
- name: Modify a Storage pool by name
dellemc.powerflex.storagepool_v2:
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
validate_certs: "{{ validate_certs }}"
storage_pool_name: "{{ pool_name }}"
protection_domain_name: "{{ protection_domain_name }}"
storage_pool_new_name: "pool_name_new"
cap_alert_thresholds:
high_threshold: 85
critical_threshold: 95
compression_method: None
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 resource has changed. Returned: always Sample: |
|
Details of the storage pool. Returned: When storage pool exists Sample: |
|
Current address space usage state. Returned: success |
|
Type of address space usage limit. Returned: success |
|
Critical threshold for capacity alert (percentage). Returned: success |
|
High threshold for capacity alert (percentage). Returned: success |
|
Current capacity usage state of the storage pool. Returned: success |
|
Type of capacity usage being monitored. Returned: success |
|
Compression method used in the storage pool. Returned: success |
|
ID of the device group associated with the storage pool. Returned: success |
|
Indicates whether fragmentation is enabled for the storage pool. Returned: success |
|
Data protection generation type of the storage pool. Returned: success |
|
ID of the storage pool. Returned: success |
|
In-flight bandwidth factor for performance tuning. Returned: success |
|
In-flight requests factor for performance tuning. Returned: success |
|
Name of the storage pool. Returned: success |
|
Number of data slices used in erasure coding. Returned: success |
|
Number of protection slices used in erasure coding. Returned: success |
|
Over-provisioning factor for the storage pool. Returned: success |
|
Physical size of the storage pool in GB. Returned: success |
|
ID of the protection domain in which the storage pool resides. Returned: success |
|
Data protection scheme used in the storage pool. Returned: success |
|
Raw size of the storage pool in GB. Returned: success |
|
Class of the storage pool. Returned: success |
|
Health state of the storage pool. Returned: success |
|
Statistics details of the storage pool. Returned: success |
|
Total capacity of the storage pool. Returned: success |
|
Device Ids of the storage pool. Returned: success |
|
Unused capacity of the storage pool. Returned: success |
|
ID of the WRC device group. Returned: success |
|
Indicates whether zero padding is enabled for the storage pool. Returned: success |