purestorage.flashblade.purefb_s3user (1.17.0) — module

Create or delete FlashBlade Object Store account users

| "added in version" 1.0.0 of purestorage.flashblade"

Authors: Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>

preview | supported by community

Install collection

Install with ansible-galaxy collection install purestorage.flashblade:==1.17.0


Add to requirements.yml

  collections:
    - name: purestorage.flashblade
      version: 1.17.0

Description

Create or delete object store account users on a Pure Stoage FlashBlade.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- debug:
    msg: "S3 User: {{ result['s3user_info'] }}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create object store user (with access ID and key) foo in account bar with access policy (Purity 3.2 and higher)
  purestorage.flashblade.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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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: e31060a7-21fc-e277-6240-25983c6c4592
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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: e31060a7-21fc-e277-6240-25983c6c4592

Inputs

    
name:
    description:
    - The name of object store user
    required: true
    type: str

state:
    choices:
    - absent
    - present
    - remove_key
    default: present
    description:
    - Create or delete object store account user
    - Remove a specified access key for a user
    type: str

fb_url:
    description:
    - FlashBlade management IP address or Hostname.
    type: str

policy:
    description:
    - User Access Policies to be assigned to user on creation
    - To amend policies use the I(purestorage.flashblade.purefb_userpolicy) module
    - If not specified, I(pure\:policy/full-access) will be added
    elements: str
    type: list
    version_added: 1.6.0
    version_added_collection: purestorage.flashblade

account:
    description:
    - The name of object store account associated with user
    required: true
    type: str

api_token:
    description:
    - FlashBlade API token for admin privileged user.
    type: str

access_key:
    default: false
    description:
    - Create secret access key.
    - Key can be exposed using the I(debug) module
    - If enabled this will override I(imported_key)
    type: bool

remove_key:
    description:
    - Access key to be removed from user
    type: str
    version_added: 1.5.0
    version_added_collection: purestorage.flashblade

imported_key:
    description:
    - Access key of imported credentials
    type: str
    version_added: 1.4.0
    version_added_collection: purestorage.flashblade

multiple_keys:
    default: false
    description:
    - Allow multiple access keys to be created for the user.
    type: bool
    version_added: 1.12.0
    version_added_collection: purestorage.flashblade

imported_secret:
    description:
    - Access key secret for access key to import
    type: str
    version_added: 1.4.0
    version_added_collection: purestorage.flashblade