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.20.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
.
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 |
---|---|
Create secret access key. Key can be exposed using the debug module If enabled this will override imported_key Choices:
|
|
The name of object store account associated with user |
|
FlashBlade API token for admin privileged user. |
|
Disable insecure certificate warnings Choices:
|
|
Is the access key enabled? Choices:
|
|
FlashBlade management IP address or Hostname. |
|
Access key of imported credentials |
|
Access key secret for access key to import |
|
Access key to be modified |
|
Allow multiple access keys to be created for the user. Choices:
|
|
The name of object store user |
|
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 |
|
Create or delete object store account user Remove a specified access key for a user Choices:
|
Notes
Note
This module requires the
purity_fb
Python libraryYou must set
PUREFB_URL
andPUREFB_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