ansible.builtin.purefa_user (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

Create, modify or delete local users on a Pure Storage FlashArray.

Requirements

• python >= 2.7
• purestorage

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create new user ansible with API token
  purefa_user:
    name: ansible
    password: apassword
    role: storage_admin
    api: true
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
  register: result

  debug:
    msg: "API Token: {{ result['user_info']['user_api'] }}"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Change role type for existing user
  purefa_user:
    name: ansible
    role: array_admin
    state: update
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Change password type for existing user (NOT IDEMPOTENT)
  purefa_user:
    name: ansible
    password: anewpassword
    old_password: apassword
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Change API token for existing user
  purefa_user:
    name: ansible
    api: true
    state: update
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
  register: result

  debug:
    msg: "API Token: {{ result['user_info']['user_api'] }}"

Inputs

    
api:
    default: false
    description:
    - Define whether to create an API token for this user
    - Token can be exposed using the I(debug) module
    type: bool

name:
    description:
    - The name of the local user account
    type: str

role:
    choices:
    - readonly
    - storage_admin
    - array_admin
    description:
    - Sets the local user's access level to the array
    type: str

state:
    choices:
    - absent
    - present
    default: present
    description:
    - Create, delete or update local user account
    type: str

fa_url:
    description:
    - FlashArray management IPv4 address or Hostname.
    required: true
    type: str

password:
    description:
    - Password for the local user.
    type: str

api_token:
    description:
    - FlashArray API token for admin privileged user.
    required: true
    type: str

old_password:
    description:
    - If changing an existing password, you must provide the old password for security
    type: str