purestorage.flasharray.purefa_vg – Manage volume groups on Pure Storage FlashArrays

Note

This plugin is part of the purestorage.flasharray collection (version 1.11.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install purestorage.flasharray.

To use it in a playbook, specify: purestorage.flasharray.purefa_vg.

New in version 1.0.0: of purestorage.flasharray

Synopsis

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

Requirements

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

python >= 2.7
purestorage >= 1.19
py-pure-client >= 1.6.0
netaddr
requests

Parameters

Parameter	Choices/Defaults	Comments
api_token string		FlashArray API token for admin privileged user.
bw_qos string		Bandwidth limit for vgroup in M or G units. M will set MB/s G will set GB/s To clear an existing QoS setting use 0 (zero)
count integer		Number of volume groups to be created in a multiple volume group creation Only supported from Purity//FA v6.0.0 and higher
digits integer	Default: 1	Number of digits to use for multiple volume group count. This will pad the index number with zeros where necessary Only supported from Purity//FA v6.0.0 and higher Range is between 1 and 10
eradicate boolean	Choices: no ← yes	Define whether to eradicate the volume group on delete and leave in trash.
fa_url string		FlashArray management IPv4 address or Hostname.
iops_qos string		IOPs limit for vgroup - use value or K or M K will mean 1000 M will mean 1000000 To clear an existing IOPs setting use 0 (zero)
name string / required		The name of the volume group. Multi-volume-group support available from Purity//FA 6.0.0 *NOTE* Manual deletion or eradication of individual volume groups created using multi-volume-group will cause idempotency to fail Multi-volume-group support only exists for volume group creation
start integer	Default: 0	Number at which to start the multiple volume group creation index Only supported from Purity//FA v6.0.0 and higher
state string	Choices: absent present ←	Define whether the volume group should exist or not.
suffix string		Suffix string, if required, for multiple volume group create Volume group names will be formed as <name>#I<suffix>, where # is a placeholder for the volume index See associated descriptions Only supported from Purity//FA v6.0.0 and higher

Notes

Note

This module requires the purestorage and py-pure-client Python libraries
Additional Python librarues may be required for specific modules.
You must set PUREFA_URL and PUREFA_API environment variables if fa_url and api_token arguments are not passed to the module directly

Examples

- name: Create new volune group
  purefa_vg:
    name: foo
    bw_qos: 50M
    iops_qos: 100
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Create 10 volune groups of pattern foo#bar with QoS
  purefa_vg:
    name: foo
    suffix: bar
    count: 10
    start: 10
    digits: 3
    bw_qos: 50M
    iops_qos: 100
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Update volune group QoS limits
  purefa_vg:
    name: foo
    bw_qos: 0
    iops_qos: 5555
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Destroy volume group
  purefa_vg:
    name: foo
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: absent

- name: Recover deleted volune group
  purefa_vg:
    name: foo
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Destroy and Eradicate volume group
  purefa_vg:
    name: foo
    eradicate: true
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: absent

Authors

Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/purestorage/flasharray/purefa_vg_module.html

Docs

Docs4dev

Title here