dellemc.powerflex.fault_set (2.3.0) — module

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 fault sets on PowerFlex storage system includes creating, getting details, renaming and deleting a fault set.

Requirements

• 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.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

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

state:
    choices:
    - present
    - absent
    default: present
    description:
    - State of the Fault Set.
    type: str

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

fault_set_id:
    description:
    - ID of the Fault Set.
    - Mutually exclusive with I(fault_set_name).
    type: str

fault_set_name:
    description:
    - Name of the Fault Set.
    - Mutually exclusive with I(fault_set_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

fault_set_new_name:
    description:
    - New name of the fault set.
    type: str

protection_domain_id:
    description:
    - ID of the protection domain.
    - Mutually exclusive with I(protection_domain_name).
    type: str

protection_domain_name:
    description:
    - Name of protection domain.
    - Mutually exclusive with I(protection_domain_id).
    type: str

Outputs

changed:
  description: Whether or not the resource has changed.
  returned: always
  sample: 'false'
  type: bool
fault_set_details:
  contains:
    SDS:
      description: List of SDS associated to the fault set.
      elements: dict
      type: list
    id:
      description: Unique identifier of the fault set.
      type: str
    links:
      contains:
        href:
          description: Fault Set instance URL.
          type: str
        rel:
          description: Relationship of fault set with different entities.
          type: str
      description: Fault set links.
      type: list
    name:
      description: Name of the fault set.
      type: str
    protectionDomainId:
      description: Unique identifier of the protection domain.
      type: str
    protectionDomainName:
      description: Name of the protection domain.
      type: str
  description: Details of fault set.
  returned: always
  sample:
    id: eb44b70500000000
    links: []
    name: fs_001
    protectionDomainId: da721a8300000000
    protectionDomainName: sample-pd
  type: dict