/ home / theforeman / theforeman.foreman / 0.8.1 / module / foreman_user

theforeman.foreman.foreman_user (0.8.1) — module

Manage Foreman Users

Authors: Christoffer Reijer (@ephracis) Basalt AB

preview | supported by community

Install collection

Install with ansible-galaxy collection install theforeman.foreman:==0.8.1

Add to requirements.yml

  collections:
    - name: theforeman.foreman
      version: 0.8.1

Description

Create and delete users in Foreman

Requirements

apypie

Usage examples

Scanned by Steampunk Spotter

- 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

Scanned by Steampunk Spotter

- name: Update a user
  foreman_user:
    name: test
    firstname: Tester
    state: present

Scanned by Steampunk Spotter

- name: Change password
  foreman_user:
    name: test
    user_password: newp@ss

Inputs

    
mail:
    description:
    - Email address of the user
    - Required when creating a new user
    required: false
    type: str

admin:
    default: false
    description:
    - Whether or not the user is an administrator
    required: false
    type: bool

login:
    aliases:
    - name
    description:
    - Name of the user
    required: true
    type: str

roles:
    description:
    - List of roles assigned to the user
    elements: str
    required: false
    type: list

state:
    choices:
    - present
    - absent
    default: present
    description:
    - State of the entity in Foreman
    type: str

locale:
    choices:
    - ca
    - de
    - en
    - en_GB
    - es
    - fr
    - gl
    - it
    - ja
    - ko
    - nl_NL
    - pl
    - pt_BR
    - ru
    - sv_SE
    - zh_CN
    - zh_TW
    description:
    - The language locale for the user
    required: false
    type: str

lastname:
    description:
    - Last name of the user
    required: false
    type: str

password:
    description: Password of the user accessing the Foreman server
    required: true
    type: str

timezone:
    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.
    description:
    - Timezone for the user
    - If blank it will use the browser timezone.
    required: false
    type: str

username:
    description: Username accessing the Foreman server
    required: true
    type: str

firstname:
    description:
    - First name of the user
    required: false
    type: str

locations:
    description: List of locations the entity should be assigned to
    elements: str
    type: list

server_url:
    description: URL of the Foreman server
    required: true
    type: str

auth_source:
    description:
    - Authentication source where the user exists
    required: false
    type: str

description:
    description:
    - Description of the user
    required: false
    type: str

organizations:
    description: List of organizations the entity should be assigned to
    elements: str
    type: list

user_password:
    description:
    - Password for the user
    required: false
    type: str

validate_certs:
    aliases:
    - verify_ssl
    default: true
    description: Whether or not to verify the TLS certificates of the Foreman server
    type: bool

default_location:
    description:
    - The location that the user uses by default
    required: false
    type: str

default_organization:
    description:
    - The organizxation that the user uses by default
    required: false
    type: str