Docs4dev
Docs
ansible / 2.10 / collections / purestorage / flasharray / purefa_offload_module.html

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

Note

This plugin is part of the purestorage.flasharray collection (version 1.5.1).

To install it use: ansible-galaxy collection install purestorage.flasharray.

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

New in version 1.0.0: of purestorage.flasharray

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 >= 2.7
  • purestorage >= 1.19
  • py-pure-client >= 1.6.0
  • netaddr
  • requests

Parameters

Parameter Choices/Defaults 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
Default:
"offload"
Name of the blob container of the Azure target
fa_url
string
FlashArray management IPv4 address or Hostname.
initialize
boolean
    Choices:
  • no
  • yes ←
Define whether to initialize the offload bucket
name
string / required
The name of the offload target
options
string
Default:
""
Additonal mount options for the NFS share
Supported mount options include port, rsize, wsize, nfsvers, and tcp or udp
placement
string
    Choices:
  • retention-based ←
  • aws-standard-class
AWS S3 placement strategy
protocol
string
    Choices:
  • nfs ←
  • s3
  • azure
  • gcp
Define which protocol the offload engine uses
secret
string
Secret Access Key for the offload target
share
string
NFS export on the NFS server
state
string
    Choices:
  • absent
  • present ←
Define state of offload

Notes

Note

  • This module requires the purestorage Python library
  • 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
  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
  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
  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
  purefa_offload:
    name: nfs-offload
    protocol: nfs
    state: absent
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Authors

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