purefa_volume – Manage volumes on Pure Storage FlashArrays

From Get docs
Ansible/docs/2.7/modules/purefa volume module


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

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.

eradicate

boolean

  • no

  • yes

Define whether to eradicate the volume on delete or leave in trash.

fa_url

- / required

FlashArray management IPv4 address or Hostname.

name

- / required

The name of the volume.

overwrite

boolean

  • no

  • yes

Define whether to overwrite a target volume if it already exisits.

size

-

Volume size in M, G, T or P units.

state

-

  • absent
  • present

Define whether the volume should exist or not.

target

-

The name of the target volume, if copying.



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 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

Status

Authors

  • 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/purefa_volume_module.html