purestorage.flashblade.purefb_s3user module – Create or delete FlashBlade Object Store account users

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

New in purestorage.flashblade 1.0.0

Synopsis

  • Create or delete object store account users 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

access_key

boolean

Create secret access key.

Key can be exposed using the debug module

If enabled this will override imported_key

Choices:

  • false ← (default)

  • true

account

string / required

The name of object store account associated with user

api_token

string

FlashBlade API token for admin privileged user.

disable_warnings

boolean

added in purestorage.flashblade 1.18.0

Disable insecure certificate warnings

Choices:

  • false ← (default)

  • true

enable_key

boolean

added in purestorage.flashblade 1.20.0

Is the access key enabled?

Choices:

  • false

  • true ← (default)

fb_url

string

FlashBlade management IP address or Hostname.

imported_key

string

added in purestorage.flashblade 1.4.0

Access key of imported credentials

imported_secret

string

added in purestorage.flashblade 1.4.0

Access key secret for access key to import

key_name

aliases: remove_key

string

added in purestorage.flashblade 1.5.0

Access key to be modified

multiple_keys

boolean

added in purestorage.flashblade 1.12.0

Allow multiple access keys to be created for the user.

Choices:

  • false ← (default)

  • true

name

string / required

The name of object store user

policy

list / elements=string

added in purestorage.flashblade 1.6.0

User Access Policies to be assigned to user on creation

To amend policies use the purestorage.flashblade.purefb_userpolicy module

If not specified, pure\:policy/full-access will be added

state

string

Create or delete object store account user

Remove a specified access key for a user

Choices:

  • "absent"

  • "present" ← (default)

  • "remove_key"

  • "keystate"

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: Create object store user (with access ID and key) foo in account bar
  purestorage.flashblade.purefb_s3user:
    name: foo
    account: bar
    access_key: true
    fb_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
  register: result

- debug:
    msg: "S3 User: {{ result['s3user_info'] }}"

- name: Create object store user (with access ID and key) foo in account bar with access policy
  purestorage.flashblade.purefb_s3user:
    name: foo
    account: bar
    access_key: true
    policy:
      - pure:policy/object-write
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Create object store user foo using imported key/secret in account bar
  purestorage.flashblade.purefb_s3user:
    name: foo
    account: bar
    imported_key: "PSABSSZRHPMEDKHMAAJPJBONPJGGDDAOFABDGLBJLHO"
    imported_secret: "BAG61F63105e0d3669/e066+5C5DFBE2c127d395LBGG"
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Delete object store user foo in account bar
  purestorage.flashblade.purefb_s3user:
    name: foo
    account: bar
    state: absent
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Change state of object store access key to disabled
  purestorage.flashblade.purefb_s3user:
    name: foo
    account: bar
    key_name: PSFBSAZRDHFKAMIEGIBLIEDDOFLHGEEEEFCBPBFCLJ
    state: keystate
    enable_key: false
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Delete object store access key
  purestorage.flashblade.purefb_s3user:
    name: foo
    account: bar
    key_name: PSFBSAZRDHFKAMIEGIBLIEDDOFLHGEEEEFCBPBFCLJ
    state: remove_key
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

Authors

  • Pure Storage Ansible Team (@sdodsley)