theforeman.foreman.usergroup module – Manage User Groups

Note

This module is part of the theforeman.foreman collection (version 4.2.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install theforeman.foreman. You need further requirements to be able to use this module, see Requirements for details.

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

New in theforeman.foreman 1.0.0

Synopsis 

Create, update, and delete user groups

Aliases: foreman_usergroup

Requirements 

The below requirements are needed on the host that executes this module.

requests

Parameters 

Parameter	Comments
admin boolean	Whether or not the users in this group are administrators Choices: `false` ← (default) `true`
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	State of the entity Choices: `"present"` ← (default) `"absent"`
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	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. Choices: `false` `true` ← (default)

Attributes 

Attribute	Support	Description
check_mode	Support: full	Can run in check_mode and return changed status prediction without modifying the entity
diff_mode	Support: full	Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode

Examples 

- name: Create a user group
  theforeman.foreman.usergroup:
    name: test
    admin: false
    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	Description
entity dictionary	Final state of the affected entities grouped by their type. Returned: success
usergroups list / elements=dictionary	List of usergroups. Returned: success

Authors

Baptiste Agasse (@bagasse)

theforeman.foreman.usergroup module – Manage User Groups

Synopsis

Requirements

Parameters

Attributes

Examples

Return Values