dellemc.powerflex.resource_group (2.3.0) — module

Manage resource group deployments on Dell PowerFlex.

| "added in version" 2.3.0 of dellemc.powerflex"

Authors: Jennifer John (@johnj9) <ansible.team@dell.com>, Trisha Datta (@trisha-dell) <ansible.team@dell.com>

Install collection

Install with ansible-galaxy collection install dellemc.powerflex:==2.3.0


Add to requirements.yml

  collections:
    - name: dellemc.powerflex
      version: 2.3.0

Description

Managing resource group deployments on PowerFlex storage system includes deploying, editing, adding nodes and deleting a resource group deployment.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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 }}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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"

Inputs

    
port:
    default: 443
    description:
    - Port number through which communication happens with PowerFlex host.
    type: int

state:
    choices:
    - absent
    - present
    default: present
    description:
    - The state of the resource group.
    type: str

scaleup:
    default: false
    description:
    - Whether to scale up the resource group. Specify as true to add nodes to the resource
      group.
    type: bool

timeout:
    default: 120
    description:
    - Time after which connection will get terminated.
    - It is to be mentioned in seconds.
    required: false
    type: int

hostname:
    aliases:
    - gateway_host
    description:
    - IP or FQDN of the PowerFlex host.
    required: true
    type: str

password:
    description:
    - The password of the PowerFlex host.
    required: true
    type: str

username:
    description:
    - The username of the PowerFlex host.
    required: true
    type: str

validate:
    default: false
    description:
    - Specify as true to validate the deployment of resource group.
    type: bool

clone_node:
    description:
    - Resource to duplicate during scaleup, if more than one nodes are available in the
      resource group.
    type: str

node_count:
    default: 1
    description:
    - Number of nodes to clone during scaleup.
    type: int

description:
    description:
    - The description of the resource group.
    type: str

template_id:
    description:
    - The ID of the published template.
    - Either I(template_id) or I(template_name) must be specified to deploy a resource
      group.
    - Mutually exclusive with I(template_name).
    type: str

schedule_date:
    description:
    - Scheduled date for the resource group deployment.
    - Specify in YYYY-MM-DD HH:MM:SS.sss or YYYY-MM-DD format.
    type: str

template_name:
    description:
    - The name of the published template.
    - Either I(template_id) or I(template_name) must be specified to deploy a resource
      group.
    - Mutually exclusive with I(template_id).
    type: str

validate_certs:
    aliases:
    - verifycert
    default: true
    description:
    - Boolean variable to specify whether or not to validate SSL certificate.
    - C(true) - Indicates that the SSL certificate should be verified.
    - C(false) - Indicates that the SSL certificate should not be verified.
    type: bool

resource_group_id:
    description:
    - The ID of the resource group.
    - Either I(resource_group_id) or I(resource_group_name) must be specified to perform
      resource group operations.
    - Mutually exclusive with I(resource_group_name).
    type: str

resource_group_name:
    description:
    - The name of the resource group.
    - This is a required field to deploy a resource group.
    - Either I(resource_group_id) or I(resource_group_name) must be specified to perform
      resource group operations.
    - Mutually exclusive with I(resource_group_id).
    type: str

firmware_repository_id:
    description:
    - The ID of the firmware repository if not using the appliance default catalog.
    - Mutually exclusive with I(firmware_repository_name).
    type: str

new_resource_group_name:
    description:
    - New name of the resource group to rename to.
    type: str

firmware_repository_name:
    description:
    - The name of the firmware repository if not using the appliance default catalog.
    - Mutually exclusive with I(firmware_repository_id).
    type: str

Outputs

changed:
  description: Whether or not the resource has changed.
  returned: always
  sample: 'false'
  type: bool
resource_group_details:
  contains:
    deploymentDescription:
      description: The description of the resource group deployment.
      type: str
    deploymentName:
      description: The name of the resource group deployment.
      type: str
    firmwareRepositoryId:
      description: The ID of the firmware repository of the resource group.
      type: str
    id:
      description: The ID of the deployed resource group.
      type: str
    serviceTemplate:
      contains:
        id:
          description: The ID of the service template.
          type: str
        templateName:
          description: The name of the service template.
          type: str
      description: The service template of the resource group.
      type: dict
    status:
      description: The status of the deployment of the resource group.
      type: str
  description: Details of the resource group deployment.
  returned: When resource group exists.
  sample:
    allUsersAllowed: false
    brownfield: false
    compliant: true
    configurationChange: false
    deploymentDescription: ans test rg
    deploymentDevice:
    - brownfield: false
      compliantState: COMPLIANT
      componentId: 910bf934-d45a-4fe3-8ea2-dc481e063a81
      currentIpAddress: 1.3.9.2
      deviceHealth: GREEN
      deviceType: scaleio
      model: PowerFlex Gateway
      refId: scaleio-block-legacy-gateway
      refType: SCALEIO
      statusMessage: The processing of PowerFlex is unsuccessful.
    deploymentHealthStatusType: red
    deploymentName: dep-ans-test-rg1
    firmwareRepository:
      id: 8aaa80788b5755d1018b576126d51ba3
      name: PowerFlex 4.5.0.0
      rcmapproved: false
    firmwareRepositoryId: 8aaa80788b5755d1018b576126d51ba3
    id: 8aaa03a88de961fa018de96a88d80008
    lifecycleMode: false
    numberOfDeployments: 0
    owner: admin
    retry: true
    scaleUp: false
    scheduleDate: null
    serviceTemplate:
      id: 8aaa03a88de961fa018de96a88d80008
      templateName: update-template (8aaa03a88de961fa018de96a88d80008)
    status: error
    teardown: false
    templateValid: true
    updateServerFirmware: true
    useDefaultCatalog: true
    vds: false
  type: dict