W3cubDocs

/Ansible 2.7

purefa_pg - Manage protection groups on Pure Storage FlashArrays

New in version 2.4.

Synopsis
- Requirements
Parameters
Notes
Examples
Status
Maintenance
- Author

Synopsis

Create, delete or modify protection groups on Pure Storage FlashArrays.

Requirements

The below requirements are needed on the host that executes this module.

python >= 2.7
purestorage

Parameters

Parameter	Choices/Defaults	Comments
api_token required		FlashArray API token for admin privilaged user.
enabled bool	Choices: no yes ←	Define whether to enabled snapshots for the protection group.
eradicate bool	Choices: no ← yes	Define whether to eradicate the protection group on delete and leave in trash.
fa_url required		FlashArray management IPv4 address or Hostname.
host		List of existing hosts to add to protection group.
hostgroup		List of existing hostgroups to add to protection group.
pgroup required		The name of the protection group.
state	Choices: absent present ←	Define whether the protection group should exist or not.
volume		List of existing volumes to add to protection group.

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

Examples

- name: Create new protection group
  purefa_pg:
    pgroup: foo
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Create new protection group with snapshots disabled
  purefa_pg:
    pgroup: foo
    enabled: false
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Delete protection group
  purefa_pg:
    pgroup: foo
    eradicate: true
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: absent

- name: Create protection group for hostgroups
  purefa_pg:
    pgroup: bar
    hostgroup:
      - hg1
      - hg2
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Create protection group for hosts
  purefa_pg:
    pgroup: bar
    host:
      - host1
      - host2
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Create protection group for volumes
  purefa_pg:
    pgroup: bar
    volume:
      - vol1
      - vol2
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Status

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

Maintenance

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.

Author

Simon Dodsley (@sdodsley)

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_pg_module.html