community.general.manageiq_user – Management of users in ManageIQ.
community.general.manageiq_user – Management of users in ManageIQ.
Note
This plugin is part of the community.general collection (version 2.0.1).
To install it use: ansible-galaxy collection install community.general
.
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 | Choices/Defaults | Comments | |
---|---|---|---|
string |
The users' E-mail address. | ||
group string |
The name of the group to which the user belongs. | ||
manageiq_connection dictionary |
ManageIQ connection configuration information. | ||
ca_cert string |
The path to a CA bundle file or directory with certificates. defaults to None.
| ||
password string |
ManageIQ password. | ||
token string |
ManageIQ token. | ||
url string |
ManageIQ environment url. | ||
username string |
ManageIQ username. | ||
validate_certs boolean |
|
Whether SSL certificates should be verified for HTTPS requests. defaults to True.
| |
name string |
The users' full name. | ||
password string |
The users' password. | ||
state string |
|
absent - user should not exist, present - user should be. | |
update_password string |
|
| |
userid string / required |
The unique userid in manageiq, often mentioned as username. |
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
- 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
- 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
- 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
- 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
- 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
Authors
- Daniel Korn (@dkorn)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/manageiq_user_module.html