Docs4dev
Docs
ansible / latest / collections / hpe / nimble / hpe_nimble_user_module.html

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

Note

This plugin is part of the hpe.nimble collection (version 1.1.3).

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.

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

New in version 1.0.0: of hpe.nimble

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 Choices/Defaults 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
    Choices:
  • no
  • yes
User is currently disabled.
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
Default:
0
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.
name
string / required
Name of the user.
password
string / required
HPE Nimble Storage password.
role
string
    Choices:
  • administrator
  • poweruser
  • operator
  • guest
Role of the user. Default is 'guest'.
state
string / required
    Choices:
  • create
  • present
  • absent
The user operation.
unlock
boolean
    Choices:
  • no
  • yes
Unlock the user.
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

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/hpe/nimble/hpe_nimble_user_module.html