ansible.builtin.purefa_pg (v2.7.10) — module

Manage protection groups on Pure Storage FlashArrays

| "added in version" 2.4 of ansible.builtin"

Authors: Simon Dodsley (@sdodsley)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.7.10

Description

Create, delete or modify protection groups on Pure Storage FlashArrays.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create new protection group
  purefa_pg:
    pgroup: foo
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create new protection group with snapshots disabled
  purefa_pg:
    pgroup: foo
    enabled: false
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete protection group
  purefa_pg:
    pgroup: foo
    eradicate: true
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create protection group for hostgroups
  purefa_pg:
    pgroup: bar
    hostgroup:
      - hg1
      - hg2
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create protection group for hosts
  purefa_pg:
    pgroup: bar
    host:
      - host1
      - host2
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create protection group for volumes
  purefa_pg:
    pgroup: bar
    volume:
      - vol1
      - vol2
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Inputs

    
host:
    description:
    - List of existing hosts to add to protection group.

state:
    choices:
    - absent
    - present
    default: present
    description:
    - Define whether the protection group should exist or not.

fa_url:
    description:
    - FlashArray management IPv4 address or Hostname.
    required: true
    type: str

pgroup:
    description:
    - The name of the protection group.
    required: true

volume:
    description:
    - List of existing volumes to add to protection group.

enabled:
    default: 'yes'
    description:
    - Define whether to enabled snapshots for the protection group.
    type: bool

api_token:
    description:
    - FlashArray API token for admin privileged user.
    required: true
    type: str

eradicate:
    default: 'no'
    description:
    - Define whether to eradicate the protection group on delete and leave in trash.
    type: bool

hostgroup:
    description:
    - List of existing hostgroups to add to protection group.