W3cubDocs

/Ansible

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

Note

This plugin is part of the purestorage.flashblade collection (version 1.7.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 purestorage.flashblade.

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

New in version 1.0.0: of purestorage.flashblade

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 >= 2.7
  • purity_fb >= 1.9
  • netaddr
  • pytz

Parameters

Parameter Choices/Defaults Comments
access_key
boolean
    Choices:
  • no ←
  • yes
Create secret access key.
Key can be exposed using the debug module
If enabled this will override imported_key
account
string / required
The name of object store account associated with user
api_token
string
FlashBlade API token for admin privileged user.
fb_url
string
FlashBlade management IP address or Hostname.
imported_key
string
added in 1.4.0 of purestorage.flashblade
Access key of imported credentials
imported_secret
string
added in 1.4.0 of purestorage.flashblade
Access key secret for access key to import
name
string / required
The name of object store user
policy
list / elements=string
added in 1.6.0 of purestorage.flashblade
User Access Policies to be assigned to user on creation
To amend policies use the purefb_userpolicy module
If not specified, pure\:policy/full-access will be added
remove_key
string
added in 1.5.0 of purestorage.flashblade
Access key to be removed from user
state
string
    Choices:
  • absent
  • present ←
  • remove_key
Create or delete object store account user
Remove a specified access key for a user

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
  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 (Purity 3.2 and higher)
  purefb_s3user:
    name: foo
    account: bar
    access_key: true
    policy:
      - pure:policy/safemode-configure
    fb_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Create object store user foo using imported key/secret in account bar
  purefb_s3user:
    name: foo
    account: bar
    imported_key: "PSABSSZRHPMEDKHMAAJPJBONPJGGDDAOFABDGLBJLHO"
    imported_secret: "BAG61F63105e0d3669/e066+5C5DFBE2c127d395LBGG"
    fb_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Delete object store user foo in account bar
  purefb_s3user:
    name: foo
    account: bar
    state: absent
    fb_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Authors

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/purestorage/flashblade/purefb_s3user_module.html