purestorage.flashblade.purefb_user module – Create, modify or delete FlashBlade user accounts

Note

This module is part of the purestorage.flashblade collection (version 1.21.2).

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 purestorage.flashblade. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: purestorage.flashblade.purefb_user.

New in purestorage.flashblade 1.0.0

Synopsis

  • Modify user on a Pure Stoage FlashBlade.

Requirements

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

  • python >= 3.9

  • py-pure-client

  • purity_fb >= 1.12.2

  • netaddr

  • datetime

  • pytz

  • distro

  • pycountry

  • urllib3

Parameters

Parameter

Comments

ad_user

boolean

added in purestorage.flashblade 1.21.0

Whether the user is in the AD system

Not required for local users

Choices:

  • false ← (default)

  • true

api

boolean

added in purestorage.flashblade 1.21.0

Define whether to create an API token for this user

Token can be exposed using the debug module

Choices:

  • false ← (default)

  • true

api_token

string

FlashBlade API token for admin privileged user.

clear_lock

boolean

added in purestorage.flashblade 1.8.0

Clear user lockout flag

Choices:

  • false ← (default)

  • true

disable_warnings

boolean

added in purestorage.flashblade 1.18.0

Disable insecure certificate warnings

Choices:

  • false ← (default)

  • true

fb_url

string

FlashBlade management IP address or Hostname.

name

string / required

The name of the user account

old_password

string

If changing an existing password, you must provide the old password for security

password

string

Password for the local user.

public_key

string

added in purestorage.flashblade 1.8.0

The API clients PEM formatted (Base64 encoded) RSA public key.

Include the —–BEGIN PUBLIC KEY—– and —–END PUBLIC KEY—– lines

role

string

added in purestorage.flashblade 1.21.0

Sets the local user’s access level to the system

Choices:

  • "readonly" ← (default)

  • "ops_admin"

  • "storage_admin"

  • "array_admin"

state

string

added in purestorage.flashblade 1.21.0

Create, delete or update local user account

Choices:

  • "absent"

  • "present" ← (default)

timeout

string

added in purestorage.flashblade 1.21.0

The duration of API token validity.

Valid values are weeks (w), days(d), hours(h), minutes(m) and seconds(s).

Default: "0"

Notes

Note

  • This module requires the purity_fb Python library

  • You must set PUREFB_URL and PUREFB_API environment variables if fb_url and api_token arguments are not passed to the module directly

Examples

- name: Change password for local user (NOT IDEMPOTENT)
  purestorage.flashblade.purefb_user:
    name: pureuser
    password: anewpassword
    old_password: apassword
    fb_url: 10.10.10.2
    api_token: T-9f276a18-50ab-446e-8a0c-666a3529a1b6

- name: Set public key for user
  purestorage.flashblade.purefb_user:
    name: fred
    public_key: "{{lookup('file', 'public_pem_file') }}"
    fb_url: 10.10.10.2
    api_token: T-9f276a18-50ab-446e-8a0c-666a3529a1b6

- name: Clear user lockout
  purestorage.flashblade.purefb_user:
    name: fred
    clear_lock: true
    fb_url: 10.10.10.2
    api_token: T-9f276a18-50ab-446e-8a0c-666a3529a1b6

- name: Create an API token (TTL of 2 days) and assign a public key to an AD user
  purestorage.flashblade.purefb_user:
    name: ansible-ad
    ad_user: true
    public_key: "{{lookup('file', 'id_rsa.pub') }}"
    api: true
    timeout: 2d
    fb_url: 10.10.10.2
    api_token: T-9f276a18-50ab-446e-8a0c-666a3529a1b6

Authors

  • Pure Storage Ansible Team (@sdodsley)