purestorage.flasharray.purefa_user module – Create, modify or delete FlashArray local user account

Note

This module is part of the purestorage.flasharray collection (version 1.42.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.flasharray. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: purestorage.flasharray.purefa_user.

New in purestorage.flasharray 1.0.0

Synopsis
Requirements
Parameters
Notes
Examples

Synopsis

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

Requirements

The below requirements are needed on the host that executes this module.

python >= 3.3
purestorage >= 1.19
py-pure-client >= 1.26.0
netaddr
requests
pycountry
urllib3

Parameters

Parameter	Comments
ad_user boolean added in purestorage.flasharray 1.37.0	Whether the user is in the AD system Not required for local users Choices: `false` ← (default) `true`
api boolean	Define whether to create an API token for this user Token can be exposed using the debug module Choices: `false` ← (default) `true`
api_token string	FlashArray API token for admin privileged user.
disable_warnings boolean added in purestorage.flasharray 1.29.0	Disable insecure certificate warnings in debug logs Choices: `false` ← (default) `true`
fa_url string	FlashArray management IPv4 address or Hostname.
name string / required	The name of the local user account
old_password string	If changing an existing password, you must provide the old password for security
password string	Password for the local user.
public_key string added in purestorage.flasharray 1.34.0	Public key for SSH access. To remove existing key use an empty string
role string	Sets the local user’s access level to the array Choices: `"readonly"` ← (default) `"ops_admin"` `"storage_admin"` `"array_admin"`
state string	Create, delete or update local user account Choices: `"absent"` `"present"` ← (default)
timeout string added in purestorage.flasharray 1.34.0	The duration of API token validity. Valid values are weeks (w), days(d), hours(h), minutes(m) and seconds(s). Default: `"0"`

Notes

Note

This module requires the purestorage and py-pure-client Python libraries.
Additional Python libraries may be required for specific modules.
You must set PUREFA_URL and PUREFA_API environment variables if fa_url and api_token arguments are not passed to the module directly.

Examples

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

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

- name: Overwrite/add SSH public key for existing user
  purestorage.flasharray.purefa_user:
    name: ansible
    role: array_admin
    public_key: "{{lookup('file', 'id_rsa.pub') }}"
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Remove existing SSH public key from user
  purestorage.flasharray.purefa_user:
    name: ansible
    role: array_admin
    public_key: ""
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

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

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

- name: Create an API token (TTL of 2 days) and assign a public key to an AD user
  purestorage.flasharray.purefa_user:
    name: ansible-ad
    ad_user: true
    public_key: "{{lookup('file', 'id_rsa.pub') }}"
    api: true
    timeout: 2d
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Change API token and token timeout for existing user
  purestorage.flasharray.purefa_user:
    name: ansible
    api: true
    role: array_admin
    timeout: 1d
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
  register: result

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

Authors

Pure Storage Ansible Team (@sdodsley)

Collection links

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