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

Create, modify and delete NFS or S3 offload targets

| "added in version" 2.8 of ansible.builtin"

Authors: Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

Create, modify and delete NFS or S3 offload targets.

Only supported on Purity v5.2.0 or higher.

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


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create S3 offload target
  purefa_offload:
    name: s3-offload
    protocol: s3
    access_key: "3794fb12c6204e19195f"
    bucket: offload-bucket
    secret: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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

Inputs

    
name:
    description:
    - The name of the offload target
    required: true
    type: str

share:
    description:
    - NFS export on the NFS server
    type: str

state:
    choices:
    - absent
    - present
    default: present
    description:
    - Define state of offload
    type: str

bucket:
    description:
    - Name of the bucket for the S3 target
    type: str

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

secret:
    description:
    - Secret Access Key for the S3 target
    type: str

address:
    description:
    - The IP or FQDN address of the NFS server
    type: str

options:
    default: ''
    description:
    - Additional mount options for the NFS share
    - Supported mount options include I(port), I(rsize), I(wsize), I(nfsvers), and I(tcp)
      or I(udp)
    required: false
    type: str

protocol:
    choices:
    - nfs
    - s3
    default: nfs
    description:
    - Define which protocol the offload engine uses
    type: str

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

access_key:
    description:
    - Access Key ID of the S3 target
    type: str

initialize:
    default: true
    description:
    - Define whether to initialize the S3 bucket
    type: bool