dellemc.powerflex.protection_domain module – Manage Protection Domain on Dell PowerFlex
Note
This module is part of the dellemc.powerflex collection (version 2.3.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.protection_domain.
New in dellemc.powerflex 1.2.0
Synopsis
Managing Protection Domain on PowerFlex storage system includes creating, modifying attributes, deleting and getting details of Protection Domain.
Requirements
The below requirements are needed on the host that executes this module.
A Dell PowerFlex storage system version 3.6 or later.
Ansible-core 2.14 or later.
PyPowerFlex 1.10.0.
Python 3.9, 3.10 or 3.11.
Parameters
Parameter |
Comments |
|---|---|
IP or FQDN of the PowerFlex host. |
|
Used to activate or deactivate the protection domain. Choices:
|
|
Network bandwidth limit used by all SDS in protection domain. |
|
Unit for network bandwidth limits. Choices:
|
|
Limit the overall network bandwidth. |
|
Limit the network bandwidth for rebalance. |
|
Limit the network bandwidth for rebuild. |
|
Limit the network bandwidth for vtree migration. |
|
The password of the PowerFlex host. |
|
Port number through which communication happens with PowerFlex host. Default: |
|
The ID of the protection domain. Except for create operation, all other operations can be performed using protection_domain_id. Mutually exclusive with protection_domain_name. |
|
The name of the protection domain. Mandatory for create operation. It is unique across the PowerFlex array. Mutually exclusive with protection_domain_id. |
|
Used to rename the protection domain. |
|
Used to set the RFcache parameters of the protection domain. |
|
Used to enable or disable RFcache in the protection domain. Choices:
|
|
Used to set cache maximum I/O limit in KB. |
|
Used to set the cache page size in KB. |
|
Used to set the cache mode. Choices:
|
|
State of the protection domain. Choices:
|
|
Time after which connection will get terminated. It is to be mentioned in seconds. Default: |
|
The username of the PowerFlex host. |
|
Boolean variable to specify whether or not to validate SSL certificate.
Choices:
|
Notes
Note
The protection domain can only be deleted if all its related objects have been dissociated from the protection domain.
If the protection domain set to inactive, then no operation can be performed on protection domain.
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: Create protection domain
dellemc.powerflex.protection_domain:
hostname: "{{hostname}}"
username: "{{username}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
port: "{{port}}"
protection_domain_name: "domain1"
state: "present"
- name: Create protection domain with all parameters
dellemc.powerflex.protection_domain:
hostname: "{{hostname}}"
username: "{{username}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
port: "{{port}}"
protection_domain_name: "domain1"
is_active: true
network_limits:
rebuild_limit: 10
rebalance_limit: 17
vtree_migration_limit: 14
overall_limit: 20
bandwidth_unit: "MBps"
rf_cache_limits:
is_enabled: true
page_size: 16
max_io_limit: 128
pass_through_mode: "Read"
state: "present"
- name: Get protection domain details using name
dellemc.powerflex.protection_domain:
hostname: "{{hostname}}"
username: "{{username}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
port: "{{port}}"
protection_domain_name: "domain1"
state: "present"
- name: Get protection domain details using ID
dellemc.powerflex.protection_domain:
hostname: "{{hostname}}"
username: "{{username}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
port: "{{port}}"
protection_domain_id: "5718253c00000004"
state: "present"
- name: Modify protection domain attributes
dellemc.powerflex.protection_domain:
hostname: "{{hostname}}"
username: "{{username}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
port: "{{port}}"
protection_domain_name: "domain1"
protection_domain_new_name: "domain1_new"
network_limits:
rebuild_limit: 14
rebalance_limit: 20
overall_limit: 25
bandwidth_unit: "MBps"
rf_cache_limits:
page_size: 64
pass_through_mode: "WriteMiss"
state: "present"
- name: Delete protection domain using name
dellemc.powerflex.protection_domain:
hostname: "{{hostname}}"
username: "{{username}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
port: "{{port}}"
protection_domain_name: "domain1_new"
state: "absent"
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 protection domain. Returned: When protection domain exists Sample: |
|
FGL metadata cache size. Returned: success |
|
FGL concurrent writes. Returned: success |
|
Whether FGL cache enabled. Returned: success |
|
Protection domain ID. Returned: success |
|
Protection domain links. Returned: success |
|
Protection domain instance URL. Returned: success |
|
Protection domain’s relationship with different entities. Returned: success |
|
MDM’s SDS counter parameter. Returned: success |
|
Long window for Counter Parameters. Returned: success |
|
Medium window for Counter Parameters. Returned: success |
|
Short window for Counter Parameters. Returned: success |
|
Name of the protection domain. Returned: success |
|
Whether overall network throttling enabled. Returned: success |
|
Overall network throttling in KBps. Returned: success |
|
Whether protected maintenance mode network throttling enabled. Returned: success |
|
Protected maintenance mode network throttling in KBps. Returned: success |
|
State of protection domain. Returned: success |
|
Whether rebalance network throttling enabled. Returned: success |
|
Rebalance network throttling in KBps. Returned: success |
|
Whether rebuild network throttling enabled. Returned: success |
|
Rebuild network throttling in KBps. Returned: success |
|
Id of RF cache acceleration pool. Returned: success |
|
Whether RF cache is enabled or not. Returned: success |
|
RF cache maximum I/O size in KB. Returned: success |
|
RF cache operational mode. Returned: success |
|
RF cache page size in KB. Returned: success |
|
Connectivity info of SDR and SDS. Returned: success |
|
Connectivity status of client and server. Returned: success |
|
Disconnected client ID. Returned: success |
|
Disconnected client name. Returned: success |
|
Disconnected server ID. Returned: success |
|
Disconnected server IP. Returned: success |
|
Disconnected server name. Returned: success |
|
Counter parameter for SDS-SDS network. Returned: success |
|
Long window for Counter Parameters. Returned: success |
|
Medium window for Counter Parameters. Returned: success |
|
Short window for Counter Parameters. Returned: success |
|
List of storage pools. Returned: success |
|
ID of system. Returned: success |
|
Whether V-Tree migration network throttling enabled. Returned: success |
|
V-Tree migration network throttling in KBps. Returned: success |