infinidat.infinibox.infini_user – Create, Delete and Modify a User on Infinibox
Note
This plugin is part of the infinidat.infinibox collection (version 1.3.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 infinidat.infinibox
.
To use it in a playbook, specify: infinidat.infinibox.infini_user
.
New in version 2.10: of infinidat.infinibox
Requirements
The below requirements are needed on the host that executes this module.
python2 >= 2.7 or python3 >= 3.6
infinisdk (https://infinisdk.readthedocs.io/en/latest/)
Parameters
Parameter |
Comments |
---|---|
Infinibox User password. |
|
Creates/Modifies user when present or removes when absent Choices:
|
|
Infinibox Hostname or IPv4 Address. |
|
Infinibox User username with sufficient priveledges ( see notes ). |
|
The new user’s Email address |
|
Specify whether to enable the user Choices:
|
|
The new user’s Name. Once a user is created, the user_name may not be changed from this module. It may be changed from the UI or from infinishell. |
|
The new user’s password |
|
Use with role==pool_admin. Specify the new user’s pool. |
|
The user’s role Choices:
|
Notes
Note
This module requires infinisdk python library
You must set INFINIBOX_USER and INFINIBOX_PASSWORD environment variables if user and password arguments are not passed to the module directly
Ansible uses the infinisdk configuration file
~/.infinidat/infinisdk.ini
if no credentials are provided. See http://infinisdk.readthedocs.io/en/latest/getting_started.htmlAll Infinidat modules support check mode (–check). However, a dryrun that creates resources may fail if the resource dependencies are not met for a task. For example, consider a task that creates a volume in a pool. If the pool does not exist, the volume creation task will fail. It will fail even if there was a previous task in the playbook that would have created the pool but did not because the pool creation was also part of the dry run.
Examples
- name: Create new user
infini_user:
user_name: foo_user
user_email: [email protected]
user_password: secret2
user_role: pool_admin
user_enabled: false
pool: foo_pool
state: present
password: secret1
system: ibox001
Authors
David Ohlemacher (@ohlemacher)