everpure.flasharray.purefa_lds module – Manage Everpure FlashArray local directory services

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

New in everpure.flasharray 1.45.0

Synopsis

  • Create, rename, reconfigure and delete local directory services on Everpure FlashArrays.

  • A local directory service holds users and groups on the array itself, for file serving that does not authenticate against an external directory. It is attached to a file server, which is managed by everpure.flasharray.purefa_server.

  • Every local directory service is created with its own built-in users and groups - Administrator and Guest, and the Administrators, Guests, Backup Operators and Audit Operators groups. Those cannot be deleted, and their names are therefore repeated in every local directory service on the array.

  • External directory services are managed by everpure.flasharray.purefa_ds.

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

api_token

string

FlashArray API token for admin privileged user.

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.

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.flasharray 1.29.0

Disable insecure certificate warnings in debug logs

Choices:

  • false ← (default)

  • true

domain

string

Domain name the local directory service serves.

The array defaults this to the name of the local directory service when it is created without one.

Two local directory services may share a domain.

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

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

Name of the local directory service

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.

rename

string

Value to rename the specified local directory service to

Re-running a rename task reports no change, as long as the local directory service is already known by the new name.

state

string

Define whether the local directory service should exist or not.

Deleting a local directory service also deletes every user and group it holds. See the note on state=absent.

Choices:

  • "absent"

  • "present" ← (default)

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

  • Supported from Purity//FA 6.8.0 or higher.

  • Deleting a local directory service is not recoverable. The array removes every user and group inside it at the same time, including any password set on those users.

  • A local directory service that is in use by a file server cannot be deleted. Detach it with everpure.flasharray.purefa_server first.

  • 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 local directory service foo
  everpure.flasharray.purefa_lds:
    name: foo
    domain: foo.example.com
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Create local directory service bar, letting the array set the domain
  everpure.flasharray.purefa_lds:
    name: bar
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Change the domain of local directory service foo
  everpure.flasharray.purefa_lds:
    name: foo
    domain: new.example.com
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Rename local directory service foo to bar
  everpure.flasharray.purefa_lds:
    name: foo
    rename: bar
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Delete local directory service foo and everything in it
  everpure.flasharray.purefa_lds:
    name: foo
    state: absent
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Authors

  • Everpure Ansible Team (@sdodsley)