everpure.flashblade.purefb_local_ds module – Manage FlashBlade Local Directory Services

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

New in everpure.flashblade 1.28.0

Synopsis

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.

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

domain

string

Domain string for the LDS.

Optional at create - when omitted, the array defaults the domain to the LDS name.

Patchable, but a domain change is disruptive; the API refuses it while the LDS is attached to a server. The module warns before issuing the PATCH in that case and surfaces the API error verbatim if rejected.

When omitted from the play on an existing LDS, the module does not touch the domain field (never “reset to LDS-name-default”).

fb_url

string

FlashBlade management IP address or Hostname.

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

Name of the Local Directory Service.

Accepts the realm-qualified form realm::name for realm-scoped LDSes.

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.

state

string

Whether the LDS should exist or not.

state=absent issues a direct DELETE. The module preflight-checks /servers and refuses to delete an LDS still attached to any server; detach it via everpure.flashblade.purefb_server first.

Choices:

  • "absent"

  • "present" ← (default)

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 a local directory service with an explicit domain
  everpure.flashblade.purefb_local_ds:
    name: myserver_local
    domain: local
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Create a local directory service, letting the array default the domain
  everpure.flashblade.purefb_local_ds:
    name: myserver_local
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Change the domain on an existing LDS (must be detached from any server)
  everpure.flashblade.purefb_local_ds:
    name: myserver_local
    domain: corp.local
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Delete a local directory service (must be detached first)
  everpure.flashblade.purefb_local_ds:
    name: myserver_local
    state: absent
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Full workflow - create LDS, attach via purefb_server, add a user
  block:
    - name: Create LDS
      everpure.flashblade.purefb_local_ds:
        name: myserver_local
        domain: local
        fb_url: 10.10.10.2
        api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641
    - name: Attach LDS to server (see purefb_server for details)
      everpure.flashblade.purefb_server:
        name: myserver
        directory_service:
          - myserver_local
        fb_url: 10.10.10.2
        api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641
    - name: Create primary group for alice
      everpure.flashblade.purefb_local_group:
        fb_url: 10.10.10.2
        api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641
        name: alice
        local_directory_service: myserver_local
    - name: Create local user in the LDS
      everpure.flashblade.purefb_local_user:
        fb_url: 10.10.10.2
        api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641
        name: alice
        local_directory_service: myserver_local
        password: "s3cret!"
        primary_group: alice

Authors

  • Pure Storage Ansible Team (@avk)