hpe.nimble.hpe_nimble_user module – Manage the HPE Nimble Storage users

Note

This module is part of the hpe.nimble collection (version 1.1.4).

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 hpe.nimble. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: hpe.nimble.hpe_nimble_user.

Note

The hpe.nimble collection is considered unmaintained and will be removed from Ansible 10. See the discussion thread for more information.

New in hpe.nimble 1.0.0

Synopsis

  • Manage the users on an HPE Nimble Storage group.

Requirements

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

  • Ansible 2.9 or later

  • Python 3.6 or later

  • HPE Nimble Storage SDK for Python

  • HPE Nimble Storage arrays running NimbleOS 5.0 or later

Parameters

Parameter

Comments

auth_password

string

Authorization password for changing password.

change_name

string

Change name of the existing user.

description

string

Description of the user.

disabled

boolean

User is currently disabled.

Choices:

  • false

  • true

email_addr

string

Email address of the user.

full_name

string

Fully qualified name of the user.

host

string / required

HPE Nimble Storage IP address.

inactivity_timeout

integer

The amount of time that the user session is inactive before timing out. A value of 0 indicates that the timeout is taken from the group setting.

Default: 0

name

string / required

Name of the user.

password

string / required

HPE Nimble Storage password.

role

string

Role of the user. Default is ‘guest’.

Choices:

  • "administrator"

  • "poweruser"

  • "operator"

  • "guest"

state

string / required

The user operation.

Choices:

  • "create"

  • "present"

  • "absent"

unlock

boolean

Unlock the user.

Choices:

  • false

  • true

user_password

string

User’s login password.

username

string / required

HPE Nimble Storage user name.

Notes

Note

  • This module does not support check_mode.

Examples

# if state is create, then create user, fails if it exist or cannot create
# if state is present, then create user if not present, else success
- name: Create user
  hpe.nimble.hpe_nimble_user:
    host: "{{ host }}"
    username: "{{ username }}"
    password: "{{ password }}"
    name: "{{ name }}"
    description: "{{ description }}"
    state: "{{ state | default('present') }}"

- name: Delete user
  hpe.nimble.hpe_nimble_user:
    host: "{{ host }}"
    username: "{{ username }}"
    password: "{{ password }}"
    name: "{{ name }}"
    state: "absent"

- name: Unlock user
  hpe.nimble.hpe_nimble_user:
    host: "{{ host }}"
    username: "{{ username }}"
    password: "{{ password }}"
    name: "{{ name }}"
    state: "present"
    unlock: true

Authors

  • HPE Nimble Storage Ansible Team (@ar-india)