ansible.builtin.purefa_snap (v2.9.27) — module

Manage volume snapshots on Pure Storage FlashArrays

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

Authors: Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

Create or delete volumes and volume snapshots on Pure Storage FlashArray.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create snapshot foo.ansible
  purefa_snap:
    name: foo
    suffix: ansible
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: present
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create R/W clone foo_clone from snapshot foo.snap
  purefa_snap:
    name: foo
    suffix: snap
    target: foo_clone
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: copy
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Overwrite existing volume foo_clone with snapshot foo.snap
  purefa_snap:
    name: foo
    suffix: snap
    target: foo_clone
    overwrite: true
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: copy
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete and eradicate snapshot named foo.snap
  purefa_snap:
    name: foo
    suffix: snap
    eradicate: true
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: absent

Inputs

    
name:
    description:
    - The name of the source volume.
    required: true
    type: str

state:
    choices:
    - absent
    - copy
    - present
    default: present
    description:
    - Define whether the volume snapshot should exist or not.
    type: str

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

suffix:
    description:
    - Suffix of snapshot name.
    type: str

target:
    description:
    - Name of target volume if creating from snapshot.
    type: str

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

eradicate:
    default: 'no'
    description:
    - Define whether to eradicate the snapshot on delete or leave in trash.
    type: bool

overwrite:
    default: 'no'
    description:
    - Define whether to overwrite existing volume when creating from snapshot.
    type: bool