Docs4dev
Docs
ansible / 2.4 / purefa_snap_module.html

purefa_snap - Manage volume snapshots on Pure Storage FlashArrays

New in version 2.4.

Synopsis

  • Create or delete volumes and volume snapshots on Pure Storage FlashArray.

Requirements (on host that executes module)

  • python >= 2.7
  • purestorage

Options

parameter required default choices comments
api_token
 yes
FlashArray API token for admin privilaged user.
eradicate
 no no
  • yes
  • no
Define whether to eradicate the snapshot on delete or leave in trash.
fa_url
 yes
FlashArray management IPv4 address or Hostname.
name
 yes
The name of the source volume.
overwrite
 no no
  • yes
  • no
Define whether to overwrite existing volume when creating from snapshot.
state
 no present
  • absent
  • copy
  • present
Define whether the volume snapshot should exist or not.
suffix
 no
Suffix of snapshot name.
target
 no
Name of target volume if creating from snapshot.

Examples

- name: Create snapshot foo.ansible
  purefa_snap:
    name: foo
    suffix: ansible
    fa_url: 10.10.10.2
    fa_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
    fa_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
    fa_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
    fa_api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: absent

Notes

Note

  • This module requires purestorage python library
  • You must set PUREFA_URL and PUREFA_API environment variables if url and api_token arguments are not passed to the module directly

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/purefa_snap_module.html