theforeman.foreman.user – Manage Users

Note

This plugin is part of the theforeman.foreman collection.

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
    Choices:
  • no ←
  • yes
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
    Choices:
  • ca
  • de
  • en
  • en_GB
  • es
  • fr
  • gl
  • it
  • ja
  • ko
  • nl_NL
  • pl
  • pt_BR
  • ru
  • sv_SE
  • zh_CN
  • zh_TW
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.
If the value is not specified in the task, the value of environment variable FOREMAN_PASSWORD will be used instead.
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 FOREMAN_SERVER_URL will be used instead.
state
string
    Choices:
  • present ←
  • absent
State of the entity
timezone
string
    Choices:
  • International Date Line West
  • American Samoa
  • Midway Island
  • Hawaii
  • Alaska
  • Pacific Time (US & Canada)
  • Tijuana
  • Arizona
  • Chihuahua
  • Mazatlan
  • Mountain Time (US & Canada)
  • Central America
  • Central Time (US & Canada)
  • Guadalajara
  • Mexico City
  • Monterrey
  • Saskatchewan
  • Bogota
  • Eastern Time (US & Canada)
  • Indiana (East)
  • Lima
  • Quito
  • Atlantic Time (Canada)
  • Caracas
  • Georgetown
  • La Paz
  • Puerto Rico
  • Santiago
  • Newfoundland
  • Brasilia
  • Buenos Aires
  • Greenland
  • Montevideo
  • Mid-Atlantic
  • Azores
  • Cape Verde Is.
  • Dublin
  • Edinburgh
  • Lisbon
  • London
  • Monrovia
  • UTC
  • Amsterdam
  • Belgrade
  • Berlin
  • Bern
  • Bratislava
  • Brussels
  • Budapest
  • Casablanca
  • Copenhagen
  • Ljubljana
  • Madrid
  • Paris
  • Prague
  • Rome
  • Sarajevo
  • Skopje
  • Stockholm
  • Vienna
  • Warsaw
  • West Central Africa
  • Zagreb
  • Zurich
  • Athens
  • Bucharest
  • Cairo
  • Harare
  • Helsinki
  • Jerusalem
  • Kaliningrad
  • Kyiv
  • Pretoria
  • Riga
  • Sofia
  • Tallinn
  • Vilnius
  • Baghdad
  • Istanbul
  • Kuwait
  • Minsk
  • Moscow
  • Nairobi
  • Riyadh
  • St. Petersburg
  • Tehran
  • Abu Dhabi
  • Baku
  • Muscat
  • Samara
  • Tbilisi
  • Volgograd
  • Yerevan
  • Kabul
  • Ekaterinburg
  • Islamabad
  • Karachi
  • Tashkent
  • Chennai
  • Kolkata
  • Mumbai
  • New Delhi
  • Sri Jayawardenepura
  • Kathmandu
  • Almaty
  • Astana
  • Dhaka
  • Urumqi
  • Rangoon
  • Bangkok
  • Hanoi
  • Jakarta
  • Krasnoyarsk
  • Novosibirsk
  • Beijing
  • Chongqing
  • Hong Kong
  • Irkutsk
  • Kuala Lumpur
  • Perth
  • Singapore
  • Taipei
  • Ulaanbaatar
  • Osaka
  • Sapporo
  • Seoul
  • Tokyo
  • Yakutsk
  • Adelaide
  • Darwin
  • Brisbane
  • Canberra
  • Guam
  • Hobart
  • Melbourne
  • Port Moresby
  • Sydney
  • Vladivostok
  • Magadan
  • New Caledonia
  • Solomon Is.
  • Srednekolymsk
  • Auckland
  • Fiji
  • Kamchatka
  • Marshall Is.
  • Wellington
  • Chatham Is.
  • Nuku'alofa
  • Samoa
  • Tokelau Is.
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 FOREMAN_USERNAME will be used instead.
validate_certs
boolean
    Choices:
  • no
  • yes ←
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 FOREMAN_VALIDATE_CERTS will be used instead.

Examples

- name: Create a user
  theforeman.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
  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