purestorage.flashblade.purefb_snap – Manage filesystem snapshots on Pure Storage FlashBlades

Note

This plugin is part of the purestorage.flashblade collection (version 1.8.1).

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 purestorage.flashblade.

To use it in a playbook, specify: purestorage.flashblade.purefb_snap.

New in version 1.0.0: of purestorage.flashblade

Synopsis

  • Create or delete volumes and filesystem snapshots on Pure Storage FlashBlades.

  • Restoring a filesystem from a snapshot is only supported using the latest snapshot.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7

  • purity_fb >= 1.9

  • netaddr

  • pytz

Parameters

Parameter Choices/Defaults Comments
api_token
string
FlashBlade API token for admin privileged user.
eradicate
boolean
    Choices:
  • no ←
  • yes
Define whether to eradicate the snapshot on delete or leave in trash.
fb_url
string
FlashBlade management IP address or Hostname.
name
string / required
The name of the source filesystem.
now
boolean
added in 1.7.0 of purestorage.flashblade
    Choices:
  • no ←
  • yes
Whether to initiate a snapshot replication immeadiately
state
string
    Choices:
  • absent
  • present ←
  • restore
Define whether the filesystem snapshot should exist or not.
suffix
string
Suffix of snapshot name.
targets
list / elements=string
added in 1.7.0 of purestorage.flashblade
Name of target to replicate snapshot to.
This is only applicable when now is True

Notes

Note

  • This module requires the purity_fb Python library

  • You must set PUREFB_URL and PUREFB_API environment variables if fb_url and api_token arguments are not passed to the module directly

Examples

- name: Create snapshot foo.ansible
  purefb_snap:
    name: foo
    suffix: ansible
    fb_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: present

- name: Create immeadiate snapshot foo.ansible to connected FB bar
  purefb_snap:
    name: foo
    suffix: ansible
    now: True
    targets:
    - bar
    fb_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: present

- name: Delete snapshot named foo.snap
  purefb_snap:
    name: foo
    suffix: snap
    fb_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: absent

- name: Recover deleted snapshot foo.ansible
  purefb_snap:
    name: foo
    suffix: ansible
    fb_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: present

- name: Restore filesystem foo (uses latest snapshot)
  purefb_snap:
    name: foo
    fb_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: restore

- name: Eradicate snapshot named foo.snap
  purefb_snap:
    name: foo
    suffix: snap
    eradicate: true
    fb_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: absent

Authors