theforeman.foreman.user – Manage Users
theforeman.foreman.user – Manage Users
Note
This plugin is part of the theforeman.foreman collection (version 1.5.1).
To install it use: ansible-galaxy collection install theforeman.foreman
.
To use it in a playbook, specify: theforeman.foreman.user
.
New in version 1.0.0: of theforeman.foreman
Synopsis
- Create, update, and delete users
Requirements
The below requirements are needed on the host that executes this module.
- requests
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
admin boolean |
|
Whether or not the user is an administrator |
auth_source string |
Authentication source where the user exists | |
default_location string |
The location that the user uses by default | |
default_organization string |
The organizxation that the user uses by default | |
description string |
Description of the user | |
firstname string |
First name of the user | |
lastname string |
Last name of the user | |
locale string |
|
The language locale for the user |
locations list / elements=string |
List of locations the entity should be assigned to | |
login string / required |
Name of the user
| |
string |
Email address of the user Required when creating a new user | |
organizations list / elements=string |
List of organizations the entity should be assigned to | |
password string / required |
Password of the user accessing the Foreman server. If the value is not specified in the task, the value of environment variable | |
roles list / elements=string |
List of roles assigned to the user | |
server_url string / required |
URL of the Foreman server. If the value is not specified in the task, the value of environment variable | |
state string |
|
State of the entity |
timezone string |
|
Timezone for the user If blank it will use the browser timezone. |
user_password string |
Password for the user | |
username string / required |
Username accessing the Foreman server. If the value is not specified in the task, the value of environment variable | |
validate_certs boolean |
|
Whether or not to verify the TLS certificates of the Foreman server. If the value is not specified in the task, the value of environment variable |
Examples
- name: Create a user
theforeman.foreman.user:
name: test
firstname: Test
lastname: Userson
mail: [email protected]
description: Dr. Test Userson
admin: no
user_password: s3cret
default_location: Test Location
default_organization: Test Organization
auth_source: Internal
timezone: Stockholm
locale: sv_SE
roles:
- Manager
locations:
- Test Location
organizations:
- Test Organization
state: present
- name: Update a user
theforeman.foreman.user:
name: test
firstname: Tester
state: present
- name: Change password
theforeman.foreman.user:
name: test
user_password: newp@ss
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
entity dictionary |
success |
Final state of the affected entities grouped by their type.
| |
users list / elements=dictionary |
success |
List of users.
|
Authors
- Christoffer Reijer (@ephracis) Basalt AB
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/theforeman/foreman/user_module.html