purestorage.flashblade.purefb_snap module – Manage filesystem snapshots on Pure Storage FlashBlades
Note
This module is part of the purestorage.flashblade collection (version 1.19.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
.
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
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
purity_fb >= 1.12.2
netaddr
datetime
pytz
distro
pycountry
urllib3
Parameters
Parameter |
Comments |
---|---|
FlashBlade API token for admin privileged user. |
|
Disable insecure certificate warnings Choices:
|
|
Define whether to eradicate the snapshot on delete or leave in trash. Choices:
|
|
FlashBlade management IP address or Hostname. |
|
The name of the source filesystem. |
|
Whether to initiate a snapshot replication immeadiately Choices:
|
|
Define whether the filesystem snapshot should exist or not. Choices:
|
|
Suffix of snapshot name. |
|
Name of target to replicate snapshot to. This is only applicable when now is true |
Notes
Note
This module requires the
purity_fb
Python libraryYou must set
PUREFB_URL
andPUREFB_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