dellemc.powerflex.fault_set module – Manage Fault Sets 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.fault_set.

New in dellemc.powerflex 2.2.0

Synopsis

  • Managing fault sets on PowerFlex storage system includes creating, getting details, renaming and deleting a fault set.

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

fault_set_id

string

ID of the Fault Set.

Mutually exclusive with fault_set_name.

fault_set_name

string

Name of the Fault Set.

Mutually exclusive with fault_set_id.

fault_set_new_name

string

New name of the fault set.

hostname

aliases: gateway_host

string / required

IP or FQDN of the PowerFlex host.

password

string / required

The password of the PowerFlex host.

port

integer

Port number through which communication happens with PowerFlex host.

Default: 443

protection_domain_id

string

ID of the protection domain.

Mutually exclusive with protection_domain_name.

protection_domain_name

string

Name of protection domain.

Mutually exclusive with protection_domain_id.

state

string

State of the Fault Set.

Choices:

  • "present" ← (default)

  • "absent"

timeout

integer

Time after which connection will get terminated.

It is to be mentioned in seconds.

Default: 120

username

string / required

The username of the PowerFlex host.

validate_certs

aliases: verifycert

boolean

Boolean variable to specify whether or not to validate SSL certificate.

true - Indicates that the SSL certificate should be verified.

false - Indicates that the SSL certificate should not be verified.

Choices:

  • false

  • true ← (default)

Notes

Note

  • The check_mode is supported.

  • When fault_set_name is provided, protection_domain_name or protection_domain_id must be provided.

  • The modules present in the collection named as ‘dellemc.powerflex’ are built to support the Dell PowerFlex storage platform.

Examples

- name: Create Fault Set on Protection Domain
  dellemc.powerflex.fault_set:
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: "{{ validate_certs }}"
    fault_set_name: "{{ fault_set_name }}"
    protection_domain_name: "{{ pd_name }}"
    state: present

- name: Rename Fault Set
  dellemc.powerflex.fault_set:
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: "{{ validate_certs }}"
    fault_set_name: "{{ fault_set_name }}"
    fault_set_new_name: "{{ fault_set_new_name }}"
    state: present

- name: Get details of a Fault Set
  dellemc.powerflex.fault_set:
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: "{{ validate_certs }}"
    fault_set_id: "{{ fault_set_id }}"
    state: present

- name: Delete Fault Set
  dellemc.powerflex.fault_set:
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: "{{ validate_certs }}"
    fault_set_id: "{{ fault_set_id }}"
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

changed

boolean

Whether or not the resource has changed.

Returned: always

Sample: false

fault_set_details

dictionary

Details of fault set.

Returned: always

Sample: {"id": "eb44b70500000000", "links": [], "name": "fs_001", "protectionDomainId": "da721a8300000000", "protectionDomainName": "sample-pd"}

id

string

Unique identifier of the fault set.

Returned: success

list / elements=string

Fault set links.

Returned: success

string

Fault Set instance URL.

Returned: success

string

Relationship of fault set with different entities.

Returned: success

name

string

Name of the fault set.

Returned: success

protectionDomainId

string

Unique identifier of the protection domain.

Returned: success

protectionDomainName

string

Name of the protection domain.

Returned: success

SDS

list / elements=dictionary

List of SDS associated to the fault set.

Returned: success

Authors

  • Carlos Tronco (@ctronco)

  • Trisha Datta (@trisha-dell)