purefa_volume - Manage volumes on Pure Storage FlashArrays
New in version 2.4.
Synopsis
- Create, delete or extend the capacity of a volume 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 |
|
Define whether to eradicate the volume on delete or leave in trash.
|
fa_url |
yes |
FlashArray management IPv4 address or Hostname.
|
||
name |
yes |
The name of the volume.
|
||
overwrite |
no | no |
|
Define whether to overwrite a target volume if it already exisits.
|
size |
no |
Volume size in M, G, T or P units.
|
||
state |
no | present |
|
Define whether the volume should exist or not.
|
target |
no |
The name of the target volume, if copying.
|
Examples
- name: Create new volume named foo purefa_volume: name: foo size: 1T fa_url: 10.10.10.2 api_token: e31060a7-21fc-e277-6240-25983c6c4592 state: present - name: Extend the size of an existing volume named foo purefa_volume: name: foo size: 2T fa_url: 10.10.10.2 api_token: e31060a7-21fc-e277-6240-25983c6c4592 state: present - name: Delete and eradicate volume named foo purefa_volume: name: foo eradicate: yes fa_url: 10.10.10.2 api_token: e31060a7-21fc-e277-6240-25983c6c4592 state: absent - name: Create clone of volume bar named foo purefa_volume: name: foo target: bar fa_url: 10.10.10.2 api_token: e31060a7-21fc-e277-6240-25983c6c4592 state: present - name: Overwrite volume bar with volume foo purefa_volume: name: foo target: bar overwrite: yes fa_url: 10.10.10.2 api_token: e31060a7-21fc-e277-6240-25983c6c4592 state: present
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_volume_module.html