purestorage.flasharray.purefa_vg module – Manage volume groups on Everpure FlashArrays
Note
This module is part of the purestorage.flasharray collection (version 1.43.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.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: purestorage.flasharray.purefa_vg.
New in purestorage.flasharray 1.0.0
Synopsis
Create, delete or modify volume groups on Everpure FlashArrays.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.3
purestorage >= 1.19
py-pure-client >= 1.26.0
netaddr
requests
pycountry
urllib3
Parameters
Parameter |
Comments |
|---|---|
FlashArray API token for admin privileged user. |
|
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) |
|
ID of the API Client that issues the identity token. Used with private_key_file. |
|
Name of fleet member on which to perform the operation. This requires the array receiving the request is a member of a fleet and the context name to be a member of the same fleet. Default: |
|
Number of volume groups to be created in a multiple volume group creation Only supported from Purity//FA v6.0.0 and higher |
|
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 Default: |
|
Disable insecure certificate warnings in debug logs Choices:
|
|
Define whether to eradicate the volume group on delete and leave in trash. Choices:
|
|
FlashArray management IPv4 address or Hostname. |
|
A pre-signed JWT to authenticate with, as an alternative to api_token. The token is exchanged by the array for a short-lived access token. Requires a matching API Client to be registered on the array (see purestorage.flasharray.purefa_apiclient). |
|
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) |
|
The API Client’s trusted identity issuer registered on the array. Used with private_key_file. |
|
Key ID of the API Client that issues the identity token. Used with private_key_file. |
|
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 |
|
DMM Priority Adjustment operator Choices:
|
|
DMM Priority Adjustment value Choices:
|
|
Path to the PEM RSA private key used to sign an identity token, as an alternative to api_token. Requires client_id, key_id, issuer and username. |
|
Password protecting private_key_file, if encrypted. |
|
Value to rename the specified volume group to |
|
Number at which to start the multiple volume group creation index Only supported from Purity//FA v6.0.0 and higher Default: |
|
Define whether the volume group should exist or not. Choices:
|
|
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 |
|
Username the issued token should be granted to. Must be a valid user on the array. Used with private_key_file. |
Notes
Note
This module requires the
purestorageandpy-pure-clientPython libraries.Additional Python libraries may be required for specific modules.
You must set
PUREFA_URLandPUREFA_APIenvironment variables if fa_url and api_token arguments are not passed to the module directly.Token-based authentication (id_token, or private_key_file with client_id, key_id, issuer and username) may be used as an alternative to api_token, and requires a matching API Client registered on the array via purestorage.flasharray.purefa_apiclient.
Examples
- name: Create new volume group
purestorage.flasharray.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 volume groups of pattern foo#bar with QoS
purestorage.flasharray.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 volume group QoS limits
purestorage.flasharray.purefa_vg:
name: foo
bw_qos: 0
iops_qos: 5555
fa_url: 10.10.10.2
api_token: e31060a7-21fc-e277-6240-25983c6c4592
- name: Update volume group DMM Priority Adjustment (Purity//FA 6.1.2+)
purestorage.flasharray.purefa_vg:
name: foo
priority_operator: '-'
priority_value: 10
fa_url: 10.10.10.2
api_token: e31060a7-21fc-e277-6240-25983c6c4592
- name: Destroy volume group
purestorage.flasharray.purefa_vg:
name: foo
fa_url: 10.10.10.2
api_token: e31060a7-21fc-e277-6240-25983c6c4592
state: absent
- name: Recover deleted volume group - no changes are made to the volume group on recovery
purestorage.flasharray.purefa_vg:
name: foo
fa_url: 10.10.10.2
api_token: e31060a7-21fc-e277-6240-25983c6c4592
- name: Destroy and Eradicate volume group
purestorage.flasharray.purefa_vg:
name: foo
eradicate: true
fa_url: 10.10.10.2
api_token: e31060a7-21fc-e277-6240-25983c6c4592
state: absent
- name: Rename volume group foo to bar
purestorage.flasharray.purefa_vg:
name: foo
rename: bar
fa_url: 10.10.10.2
api_token: e31060a7-21fc-e277-6240-25983c6c4592