dellemc.powerflex.storagepool module – Managing Dell PowerFlex storage pool
Note
This module is part of the dellemc.powerflex 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.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.
New in dellemc.powerflex 1.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 3.5 or later.
Ansible-core 2.12 or later.
PyPowerFlex 1.6.0.
Python 3.9, 3.10 or 3.11.
Parameters
Parameter |
Comments |
|---|---|
IP or FQDN of the PowerFlex host. |
|
Type of devices in the storage pool. Choices:
|
|
The password of the PowerFlex host. |
|
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. |
|
State of the storage pool. 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: |
|
Enable/Disable RFcache on a specific storage pool. Choices:
|
|
Enable/Disable RMcache on a specific storage pool. Choices:
|
|
The username of the PowerFlex host. |
|
Boolean variable to specify whether or not to validate SSL certificate.
Choices:
|
Notes
Note
TRANSITIONAL media type is supported only during modification.
The check_mode is not 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:
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:
hostname: "{{hostname}}"
username: "{{username}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
storage_pool_id: "abcd1234ab12r"
state: "present"
- name: Create a new storage pool by name
dellemc.powerflex.storagepool:
hostname: "{{hostname}}"
username: "{{username}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
storage_pool_name: "ansible_test_pool"
protection_domain_id: "1c957da800000000"
media_type: "HDD"
state: "present"
- name: Modify a storage pool by name
dellemc.powerflex.storagepool:
hostname: "{{hostname}}"
username: "{{username}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
storage_pool_name: "ansible_test_pool"
protection_domain_id: "1c957da800000000"
use_rmcache: True
use_rfcache: True
state: "present"
- name: Rename storage pool by id
dellemc.powerflex.storagepool:
hostname: "{{hostname}}"
username: "{{username}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
storage_pool_id: "abcd1234ab12r"
storage_pool_new_name: "new_ansible_pool"
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: |
|
ID of the storage pool under protection domain. Returned: success |
|
Type of devices in the storage pool. Returned: success |
|
Name of the storage pool under protection domain. Returned: success |
|
ID of the protection domain in which pool resides. Returned: success |
|
Name of the protection domain in which pool resides. 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 |
|
Enable/Disable RFcache on a specific storage pool. Returned: success |
|
Enable/Disable RMcache on a specific storage pool. Returned: success |