ansible.builtin.purefa_volume (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

Create, delete or extend the capacity of a volume on Pure Storage FlashArray.

Requirements

• python >= 2.7
• purestorage

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create new volume named foo with a QoS limit
  purefa_volume:
    name: foo
    size: 1T
    qos: 58M
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: present

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Clear volume QoS from volume foo
  purefa_volume:
    name: foo
    qos: 0
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: present

Inputs

    
qos:
    description:
    - Bandwidth limit for volume in M or G units. M will set MB/s G will set GB/s To clear
      an existing Qos setting using 0 (zero)
    type: str
    version_added: '2.8'
    version_added_collection: ansible.builtin

name:
    description:
    - The name of the volume.
    required: true
    type: str

size:
    description:
    - Volume size in M, G, T or P units.
    type: str

state:
    choices:
    - absent
    - present
    default: present
    description:
    - Define whether the volume should exist or not.
    type: str

fa_url:
    description:
    - FlashArray management IPv4 address or Hostname.
    required: true
    type: str

target:
    description:
    - The name of the target volume, if copying.
    type: str

api_token:
    description:
    - FlashArray API token for admin privileged user.
    required: true
    type: str

eradicate:
    default: 'no'
    description:
    - Define whether to eradicate the volume on delete or leave in trash.
    type: bool

overwrite:
    default: 'no'
    description:
    - Define whether to overwrite a target volume if it already exists.
    type: bool

Outputs

volume:
  contains:
    created:
      description: Volume creation time
      sample: '2019-03-13T22:49:24Z'
      type: str
    name:
      description: Volume name
      type: str
    serial:
      description: Volume serial number
      sample: 361019ECACE43D83000120A4
      type: str
    size:
      description: Volume size in bytes
      type: int
    source:
      description: Volume name of source volume used for volume copy
      type: str
  description: A dictionary describing the changed volume.  Only some attributes below
    will be returned with various actions.
  returned: success
  type: dict