everpure.flashblade.purefb_export module – Manage filesystem exports on Everpure FlashBlade`

Note

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

To use it in a playbook, specify: everpure.flashblade.purefb_export.

New in everpure.flashblade 1.25.0

Synopsis

  • This module manages filesystem exports on Everpure FlashBlade.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.9

  • py-pure-client

  • netaddr

  • datetime

  • pytz

  • distro

  • pycountry

  • urllib3

Parameters

Parameter

Comments

api_token

string

FlashBlade API token for admin privileged user.

client_id

string

added in everpure.flashblade 1.26.0

ID of the API Client that issues the identity token.

Used with private_key_file.

client_policy

string

Name of SMB client policy to assign to the export

context

string

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.flashblade 1.18.0

Disable insecure certificate warnings

Choices:

  • false ← (default)

  • true

export_policy

string

Name of NFS export policy to assign to the export

fb_url

string

FlashBlade management IP address or Hostname.

filesystem

string / required

Filesystem to create the export for.

id_token

string

added in everpure.flashblade 1.26.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.flashblade.purefb_apiclient).

issuer

string

added in everpure.flashblade 1.26.0

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

Used with private_key_file.

key_id

string

added in everpure.flashblade 1.26.0

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

Used with private_key_file.

name

string / required

Export Name.

private_key_file

string

added in everpure.flashblade 1.26.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.flashblade 1.26.0

Password protecting private_key_file, if encrypted.

rename

string

New name for export

server

string

Name of server to assign export to

Default: "_array_server"

share_policy

string

Name of SMB share policy to assign to the export

state

string

Create, delete or modifies a filesystem export.

Choices:

  • "present" ← (default)

  • "absent"

type

string

Type of filesystem export

Choices:

  • "NFS" ← (default)

  • "SMB"

username

string

added in everpure.flashblade 1.26.0

Username the issued token should be granted to.

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

Notes

Note

  • You must set PUREFB_URL and PUREFB_API environment variables if fb_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.flashblade.purefb_apiclient

Examples

- name: Create new filesystem NFS export foo for filesystem bar
  everpure.flashblade.purefb_export:
    name: foo
    filesystem: bar
    export_policy: acme_1
    state: present
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Create new filesystem NFS export foo for filesystem bar on server test
  everpure.flashblade.purefb_export:
    name: foo
    server: test
    filesystem: bar
    export_policy: acme_1
    state: present
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Create new filesystem SMB export foo for filesystem bar
  everpure.flashblade.purefb_export:
    name: foo
    filesystem: bar
    type: SMB
    state: present
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Delete filesystem export foo on server test
  everpure.flashblade.purefb_export:
    name: foo
    server: test
    state: absent
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Attach NFS export policy to filesystem bar (replaces purefb_fs export_policy)
  everpure.flashblade.purefb_export:
    name: bar_nfs
    filesystem: bar
    type: NFS
    export_policy: nfs_pol1
    state: present
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Attach SMB share policy to filesystem bar (replaces purefb_fs share_policy)
  everpure.flashblade.purefb_export:
    name: bar_smb
    filesystem: bar
    type: SMB
    share_policy: smb_share_pol1
    state: present
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Attach SMB client policy to filesystem bar (replaces purefb_fs client_policy)
  everpure.flashblade.purefb_export:
    name: bar_smb
    filesystem: bar
    type: SMB
    client_policy: smb_client_pol1
    state: present
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

Authors

  • Everpure Ansible Team (@sdodsley)