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

Note

This module is part of the purestorage.flashblade collection (version 1.24.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 purestorage.flashblade. You need further requirements to be able to use this module, see Requirements for details.

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

New in purestorage.flashblade 1.0.0

Synopsis
Requirements
Parameters
Notes
Examples

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 >= 3.9
py-pure-client
netaddr
datetime
pytz
distro
pycountry
urllib3

Parameters

Parameter	Comments
api_token string	FlashBlade API token for admin privileged user.
context string added in purestorage.flashblade 1.22.0	Name of fleet member on which to perform the operation. This requires the array receiving the request is a member of a fleet and the context name to be a member of the same fleet. Default: `""`
disable_warnings boolean added in purestorage.flashblade 1.18.0	Disable insecure certificate warnings Choices: `false` ← (default) `true`
eradicate boolean	Define whether to eradicate the snapshot on delete or leave in trash. Choices: `false` ← (default) `true`
fb_url string	FlashBlade management IP address or Hostname.
latest_replica boolean added in purestorage.flashblade 1.21.0	Used when destroying a snapshot. If false, and the snapshot is the latest replicated snapshot, then destroy will fail. If true or the snapshot is not the latest replicated snapshot, then destroy will be successful. Choices: `false` ← (default) `true`
name string / required	The name of the source filesystem.
now boolean added in purestorage.flashblade 1.7.0	Whether to initiate a snapshot replication immeadiately Choices: `false` ← (default) `true`
state string	Define whether the filesystem snapshot should exist or not. Choices: `"absent"` `"present"` ← (default) `"restore"`
suffix string	Suffix of snapshot name.
target aliases: targets string added in purestorage.flashblade 1.7.0	Name of target to replicate snapshot to. This is only applicable when now is true

Notes

Note

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
  purestorage.flashblade.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
  purestorage.flashblade.purefb_snap:
    name: foo
    suffix: ansible
    now: true
    target: bar
    fb_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: present

- name: Delete snapshot named foo.snap
  purestorage.flashblade.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
  purestorage.flashblade.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)
  purestorage.flashblade.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
  purestorage.flashblade.purefb_snap:
    name: foo
    suffix: snap
    eradicate: true
    fb_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: absent

Authors

Pure Storage Ansible Team (@sdodsley)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/purestorage/flashblade/purefb_snap_module.html