New in version 2.4.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
|
api_token
required |
FlashArray API token for admin privilaged user.
|
|
| eradicate |
|
Define whether to eradicate the snapshot on delete or leave in trash.
|
|
fa_url
required |
FlashArray management IPv4 address or Hostname.
|
|
|
name
required |
The name of the source volume.
|
|
| overwrite |
|
Define whether to overwrite existing volume when creating from snapshot.
|
| state |
|
Define whether the volume snapshot should exist or not.
|
| suffix |
Suffix of snapshot name.
|
|
| target |
Name of target volume if creating from snapshot.
|
Note
PUREFA_URL and PUREFA_API environment variables if url and api_token arguments are not passed to the module directly- 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
- 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
- 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
- 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
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.