foreman_user – Manage Foreman Users¶
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
aliases: name |
|
mail
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
|
|
roles
list
/ elements=string
|
List of roles assigned to the user
|
|
server_url
string
/ required
|
URL of the Foreman server
|
|
state
string
|
|
State of the entity in Foreman
|
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
|
|
validate_certs
boolean
|
|
Whether or not to verify the TLS certificates of the Foreman server
aliases: verify_ssl |
Examples¶
- name: Create a user
foreman_user:
name: test
firstname: Test
lastname: Userson
mail: test.userson@example.com
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
foreman_user:
name: test
firstname: Tester
state: present
- name: Change password
foreman_user:
name: test
user_password: newp@ss
Status¶
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]
Authors¶
Christoffer Reijer (@ephracis) Basalt AB
Hint
If you notice any issues in this documentation, you can edit this document to improve it.