purestorage.flasharray.purefa_workload module – Manage Fusion Fleet Workloads

Note

This module is part of the purestorage.flasharray collection (version 1.36.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_workload.

New in purestorage.flasharray 1.33.0

Synopsis

  • Apply/Rename/Delete Fusion fleet workloads

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

api_token

string

FlashArray API token for admin privileged user.

context

string

Name of fleet member on which to perform the workload 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: ""

disable_warnings

boolean

added in purestorage.flasharray 1.29.0

Disable insecure certificate warnings in debug logs

Choices:

  • false ← (default)
  • true

eradicate

boolean

whether to eradicate a workload

Choices:

  • false ← (default)
  • true

fa_url

string

FlashArray management IPv4 address or Hostname.

host

string

Host to connect to the workload after provisioning

Default: ""

name

string / required

Name of the workload.

placement

string

name of target on which the workload will be deployed

preset

string

name of existing preset to use as the basis of the workload

recommendation

boolean

whether to use the Fusion placement recommendation based on the workload preset definitions.

This will use the first recommended placement if more than one is available

Choices:

  • false ← (default)
  • true

rename

string

new name for a workload

state

string

Define whether to create or delete a fleet workload.

Using the expand option will add volume(s) to the workload.

If absent is specified together with a host, rather than deleting the workload, the host will be disconnected from the workload

Choices:

  • "absent"
  • "present" ← (default)
  • "expand"

volume_configuration

string

Name of the volume configuration to use for adding volumes to a workload

volume_count

integer

Number of additional volumes to add to an existing workload

Notes

Note

  • This module requires the purestorage and py-pure-client Python libraries.
  • Additional Python libraries 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 a workload using an exisitng preset on a specific placement target and connect to host myhost
  purestorage.flasharray.purefa_workload:
    name: foo
    preset: bar
    host: myhost
    placement: arrayB
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Create a workload using an exisitng preset using the recommended target and connect to host myhost
  purestorage.flasharray.purefa_workload:
    name: foo
    preset: bar
    host: myhost
    recommendation: true
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Add volumes to workload foo based on volume configuration fin and connect to host myhost
  purestorage.flasharray.purefa_workload:
    name: foo
    preset: bar
    volume_configuration: fin
    volume_count: 3
    host: myhost
    state: expand
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Rename an existing workload
  purestorage.flasharray.purefa_workload:
    name: foo
    rename: bar
    state: rename
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Disconnect an existing workload from host
  purestorage.flasharray.purefa_workload:
    name: foo
    host: myhost
    state: absent
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Delete an existing workload
  purestorage.flasharray.purefa_workload:
    name: foo
    state: absent
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Eradicate an existing workload
  purestorage.flasharray.purefa_workload:
    name: foo
    state: absent
    eradicate: true
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Recover a deleted workload
  purestorage.flasharray.purefa_workload:
    name: foo
    state: present
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Reconnect an existing workload to a host
  purestorage.flasharray.purefa_workload:
    name: foo
    host: myhost
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Authors

  • Pure Storage Ansible Team (@sdodsley)

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