purestorage.flasharray.purefa_offload module – Create, modify and delete NFS, S3 or Azure offload targets

Note

This module is part of the purestorage.flasharray collection (version 1.19.1).

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

New in purestorage.flasharray 1.0.0

Synopsis

  • Create, modify and delete NFS, S3 or Azure offload targets.

  • Only supported on Purity v5.2.0 or higher.

  • You must have a correctly configured offload network for offload to work.

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

  • packaging

Parameters

Parameter

Comments

access_key

string

Access Key ID of the offload target

account

string

Name of the Azure blob storage account

address

string

The IP or FQDN address of the NFS server

api_token

string

FlashArray API token for admin privileged user.

bucket

string

Name of the bucket for the S3 or GCP target

container

string

Name of the blob container of the Azure target

Default: "offload"

fa_url

string

FlashArray management IPv4 address or Hostname.

initialize

boolean

Define whether to initialize the offload bucket

Choices:

  • false

  • true ← (default)

name

string / required

The name of the offload target

options

string

Additonal mount options for the NFS share

Supported mount options include port, rsize, wsize, nfsvers, and tcp or udp

Default: ""

placement

string

AWS S3 placement strategy

Choices:

  • "retention-based" ← (default)

  • "aws-standard-class"

protocol

string

Define which protocol the offload engine uses

Choices:

  • "nfs" ← (default)

  • "s3"

  • "azure"

  • "gcp"

secret

string

Secret Access Key for the offload target

share

string

NFS export on the NFS server

state

string

Define state of offload

Choices:

  • "absent"

  • "present" ← (default)

Notes

Note

  • This module requires the purestorage and py-pure-client Python libraries

  • Additional Python librarues 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 NFS offload target
  purestorage.flasharray.purefa_offload:
    name: nfs-offload
    protocol: nfs
    address: 10.21.200.4
    share: "/offload_target"
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Create S3 offload target
  purestorage.flasharray.purefa_offload:
    name: s3-offload
    protocol: s3
    access_key: "3794fb12c6204e19195f"
    bucket: offload-bucket
    secret: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
    placement: aws-standard-class
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Create Azure offload target
  purestorage.flasharray.purefa_offload:
    name: azure-offload
    protocol: azure
    secret: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
    container: offload-container
    account: user1
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Delete offload target
  purestorage.flasharray.purefa_offload:
    name: nfs-offload
    protocol: nfs
    state: absent
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Authors

  • Pure Storage Ansible Team (@sdodsley)