theforeman.foreman.usergroup – Manage User Groups

Note

This plugin is part of the theforeman.foreman collection (version 1.5.0).

To install it use: ansible-galaxy collection install theforeman.foreman.

To use it in a playbook, specify: theforeman.foreman.usergroup.

New in version 1.0.0: of theforeman.foreman

Synopsis

  • Create, update, and delete user groups

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 users in this group are administrators
name
string / required
Name of the group
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 group
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
updated_name
string
New user group name. When this parameter is set, the module will not be idempotent.
usergroups
list / elements=string
List of other groups assigned to the group
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.
users
list / elements=string
List of users assigned to the group
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 group
  theforeman.foreman.usergroup:
    name: test
    admin: no
    roles:
      - Manager
    users:
      - myuser1
      - myuser2
    usergroups:
      - mynestedgroup
    state: present

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.
 
usergroups
list / elements=dictionary
success
List of usergroups.


Authors

  • Baptiste Agasse (@bagasse)