New in version 2.6.
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 bool |
| 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 protection group. | |
restore (added in 2.7) | Restore a specific volume from a protection group snapshot. This implies overwrite of the current full volume. USE WITH CARE!! | |
state |
| Define whether the protection group snapshot should exist or not. Copy (added in 2.7) will force an overwrite of an exisitng volume from a snapshot. |
suffix | Suffix of snapshot name. |
Note
PUREFA_URL
and PUREFA_API
environment variables if url and api_token arguments are not passed to the module directly- name: Create protection group snapshot foo.ansible purefa_pgsnap: name: foo suffix: ansible fa_url: 10.10.10.2 api_token: e31060a7-21fc-e277-6240-25983c6c4592 state: present - name: Delete and eradicate protection group snapshot named foo.snap purefa_pgsnap: name: foo suffix: snap eradicate: true fa_url: 10.10.10.2 api_token: e31060a7-21fc-e277-6240-25983c6c4592 state: absent - name: Restore volume data from protection group snapshot named foo.snap USE WITH CARE! This will overwrite your existing volume purefa_pgsnap: name: foo suffix: snap restore: data fa_url: 10.10.10.2 api_token: e31060a7-21fc-e277-6240-25983c6c4592 state: copy
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/purefa_pgsnap_module.html