purefa_pg - Manage protection groups on Pure Storage FlashArrays
New in version 2.4.
Synopsis
- Create, delete or modify protection groups on Pure Storage FlashArrays.
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.
|
||
enabled |
no | yes |
|
Define whether to enabled snapshots for the protection group.
|
eradicate |
no | no |
|
Define whether to eradicate the protection group on delete and leave in trash.
|
fa_url |
yes |
FlashArray management IPv4 address or Hostname.
|
||
host |
no |
List of existing hosts to add to protection group.
|
||
hostgroup |
no |
List of existing hostgroups to add to protection group.
|
||
pgroup |
yes |
The name of the protection group.
|
||
state |
no | present |
|
Define whether the protection group should exist or not.
|
volume |
no |
List of existing volumes to add to protection group.
|
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
Notes
Note
- This module requires purestorage python library
- You must set
PUREFA_URL
andPUREFA_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_pg_module.html