dellemc.powerflex.resource_group module – Manage resource group deployments 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.resource_group.
New in dellemc.powerflex 2.3.0
Synopsis
Managing resource group deployments on PowerFlex storage system includes deploying, editing, adding nodes and deleting a resource group deployment.
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 |
|---|---|
Resource to duplicate during scaleup, if more than one nodes are available in the resource group. |
|
The description of the resource group. |
|
The ID of the firmware repository if not using the appliance default catalog. Mutually exclusive with firmware_repository_name. |
|
The name of the firmware repository if not using the appliance default catalog. Mutually exclusive with firmware_repository_id. |
|
IP or FQDN of the PowerFlex host. |
|
New name of the resource group to rename to. |
|
Number of nodes to clone during scaleup. Default: |
|
The password of the PowerFlex host. |
|
Port number through which communication happens with PowerFlex host. Default: |
|
The ID of the resource group. Either resource_group_id or resource_group_name must be specified to perform resource group operations. Mutually exclusive with resource_group_name. |
|
The name of the resource group. This is a required field to deploy a resource group. Either resource_group_id or resource_group_name must be specified to perform resource group operations. Mutually exclusive with resource_group_id. |
|
Whether to scale up the resource group. Specify as true to add nodes to the resource group. Choices:
|
|
Scheduled date for the resource group deployment. Specify in YYYY-MM-DD HH:MM:SS.sss or YYYY-MM-DD format. |
|
The state of the resource group. Choices:
|
|
The ID of the published template. Either template_id or template_name must be specified to deploy a resource group. Mutually exclusive with template_name. |
|
The name of the published template. Either template_id or template_name must be specified to deploy a resource group. Mutually exclusive with template_id. |
|
Time after which connection will get terminated. It is to be mentioned in seconds. Default: |
|
The username of the PowerFlex host. |
|
Specify as true to validate the deployment of resource group. Choices:
|
|
Boolean variable to specify whether or not to validate SSL certificate.
Choices:
|
Notes
Note
The check_mode is supported.
Resource group scale up can be done only when deployment is complete.
The modules present in the collection named as ‘dellemc.powerflex’ are built to support the Dell PowerFlex storage platform.
Examples
- name: Validate deployment of a resource group
dellemc.powerflex.resource_group:
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
validate_certs: "{{ validate_certs }}"
port: "{{ port }}"
resource_group_name: "{{ resource_group_name_1 }}"
description: ans_rg
template_id: c65d0172-8666-48ab-935e-9a0bf69ed66d
firmware_repository_id: 8aaa80788b5755d1018b576126d51ba3
validate: true
- name: Deploy a resource group
dellemc.powerflex.resource_group:
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
validate_certs: "{{ validate_certs }}"
port: "{{ port }}"
resource_group_name: "{{ resource_group_name_1 }}"
description: ans_rg
template_id: c65d0172-8666-48ab-935e-9a0bf69ed66d
firmware_repository_id: 8aaa80788b5755d1018b576126d51ba3
- name: Add a node to a resource group
dellemc.powerflex.resource_group:
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
validate_certs: "{{ validate_certs }}"
resource_group_name: "{{ resource_group_name_1 }}"
scaleup: true
clone_node: "{{ node_1 }}"
node_count: "{{ node_count }}"
- name: Modify a resource group
dellemc.powerflex.resource_group:
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
validate_certs: "{{ validate_certs }}"
resource_group_name: "{{ resource_group_name_1 }}"
new_resource_group_name: "{{ new_resource_group_name }}"
description: "description new"
- name: Delete a resource group
dellemc.powerflex.resource_group:
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
validate_certs: "{{ validate_certs }}"
port: "{{ port }}"
resource_group_name: ans_rg
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 resource group deployment. Returned: When resource group exists. Sample: |
|
The description of the resource group deployment. Returned: success |
|
The name of the resource group deployment. Returned: success |
|
The ID of the firmware repository of the resource group. Returned: success |
|
The ID of the deployed resource group. Returned: success |
|
The service template of the resource group. Returned: success |
|
The ID of the service template. Returned: success |
|
The name of the service template. Returned: success |
|
The status of the deployment of the resource group. Returned: success |