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

Note

This module is part of the everpure.flasharray collection (version 1.46.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 everpure.flasharray. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: everpure.flasharray.purefa_offload.

New in everpure.flasharray 1.0.0

Synopsis

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

  • You must have a correctly configured offload app installed and 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.88.0

  • netaddr

  • requests

  • pycountry

  • urllib3

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.

auth_region

string

added in everpure.flasharray 1.32.0

The region that will be used for initial authentication request.

This parameter is optional and should be used only when region autodetection fails.

bucket

string

Name of the bucket for the S3 or GCP target

client_id

string

added in everpure.flasharray 1.43.0

ID of the API Client that issues the identity token.

Used with private_key_file.

container

string

Name of the blob container of the Azure target

Default: "offload"

context

string

added in everpure.flasharray 1.39.0

Name of fleet member on which to perform the 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 everpure.flasharray 1.29.0

Disable insecure certificate warnings in debug logs

Choices:

  • false ← (default)

  • true

fa_url

string

FlashArray management IPv4 address or Hostname.

id_token

string

added in everpure.flasharray 1.43.0

A pre-signed JWT to authenticate with, as an alternative to api_token.

The token is exchanged by the array for a short-lived access token.

Requires a matching API Client to be registered on the array (see everpure.flasharray.purefa_apiclient).

initialize

boolean

Define whether to initialize the offload bucket

Choices:

  • false

  • true ← (default)

issuer

string

added in everpure.flasharray 1.43.0

The API Client’s trusted identity issuer registered on the array.

Used with private_key_file.

key_id

string

added in everpure.flasharray 1.43.0

Key ID of the API Client that issues the identity token.

Used with private_key_file.

name

string / required

The name of the offload target

options

string

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

  • "aws-intelligent-tiering"

private_key_file

string

added in everpure.flasharray 1.43.0

Path to the PEM RSA private key used to sign an identity token, as an alternative to api_token.

Requires client_id, key_id, issuer and username.

private_key_password

string

added in everpure.flasharray 1.43.0

Password protecting private_key_file, if encrypted.

profile

string

added in everpure.flasharray 1.21.0

The Offload target profile that will be selected for this target.

This option allows more granular configuration for the target on top of the protocol parameter

Choices:

  • "azure"

  • "gcp"

  • "nfs"

  • "nfs-flashblade"

  • "s3-aws"

  • "s3-flashblade"

  • "s3-scality-ring"

  • "s3-wasabi-pay-as-you-go"

  • "s3-wasabi-rcs"

  • "s3-other"

protocol

string

Define which protocol the offload engine uses

NFS is not a supported protocol from Purity//FA 6.6.0 and higher

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)

uri

string

added in everpure.flasharray 1.32.0

The URI used to create a connection between the array and a non-AWS S3 offload target.

Storage placement strategies are not supported for non-AWS S3 offload targets.

Both the HTTP and HTTPS protocols are allowed.

username

string

added in everpure.flasharray 1.43.0

Username the issued token should be granted to.

Must be a valid user on the array. Used with private_key_file.

Notes

Note

  • This module requires the py-pure-client Python library.

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

  • Token-based authentication (id_token, or private_key_file with client_id, key_id, issuer and username) may be used as an alternative to api_token, and requires a matching API Client registered on the array via everpure.flasharray.purefa_apiclient.

Examples

- name: Create NFS offload target
  everpure.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
  everpure.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
  everpure.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
  everpure.flasharray.purefa_offload:
    name: nfs-offload
    protocol: nfs
    state: absent
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Authors

  • Everpure Ansible Team (@sdodsley)