community.general.manageiq_user module – Management of users in ManageIQ
Note
This module is part of the community.general collection (version 9.5.1).
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 community.general
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.general.manageiq_user
.
Synopsis
The manageiq_user module supports adding, updating and deleting users in ManageIQ.
Requirements
The below requirements are needed on the host that executes this module.
manageiq-client https://github.com/ManageIQ/manageiq-api-client-python/
Parameters
Parameter |
Comments |
---|---|
The users’ E-mail address. |
|
The name of the group to which the user belongs. |
|
ManageIQ connection configuration information. |
|
The path to a CA bundle file or directory with certificates. |
|
ManageIQ password. |
|
ManageIQ token. |
|
ManageIQ environment URL. |
|
ManageIQ username. |
|
Whether SSL certificates should be verified for HTTPS requests. Choices:
|
|
The users’ full name. |
|
The users’ password. |
|
absent - user should not exist, present - user should be. Choices:
|
|
Choices:
|
|
The unique userid in manageiq, often mentioned as username. |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: none |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Examples
- name: Create a new user in ManageIQ
community.general.manageiq_user:
userid: 'jdoe'
name: 'Jane Doe'
password: 'VerySecret'
group: 'EvmGroup-user'
email: '[email protected]'
manageiq_connection:
url: 'http://127.0.0.1:3000'
username: 'admin'
password: 'smartvm'
validate_certs: false # only do this when you trust the network!
- name: Create a new user in ManageIQ using a token
community.general.manageiq_user:
userid: 'jdoe'
name: 'Jane Doe'
password: 'VerySecret'
group: 'EvmGroup-user'
email: '[email protected]'
manageiq_connection:
url: 'http://127.0.0.1:3000'
token: 'sometoken'
validate_certs: false # only do this when you trust the network!
- name: Delete a user in ManageIQ
community.general.manageiq_user:
state: 'absent'
userid: 'jdoe'
manageiq_connection:
url: 'http://127.0.0.1:3000'
username: 'admin'
password: 'smartvm'
validate_certs: false # only do this when you trust the network!
- name: Delete a user in ManageIQ using a token
community.general.manageiq_user:
state: 'absent'
userid: 'jdoe'
manageiq_connection:
url: 'http://127.0.0.1:3000'
token: 'sometoken'
validate_certs: false # only do this when you trust the network!
- name: Update email of user in ManageIQ
community.general.manageiq_user:
userid: 'jdoe'
email: '[email protected]'
manageiq_connection:
url: 'http://127.0.0.1:3000'
username: 'admin'
password: 'smartvm'
validate_certs: false # only do this when you trust the network!
- name: Update email of user in ManageIQ using a token
community.general.manageiq_user:
userid: 'jdoe'
email: '[email protected]'
manageiq_connection:
url: 'http://127.0.0.1:3000'
token: 'sometoken'
validate_certs: false # only do this when you trust the network!