theforeman.foreman.external_usergroup module – Manage External User Groups
Note
This module is part of the theforeman.foreman collection (version 4.2.0).
You might already have this collection installed if you are using the ansible
package.
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.external_usergroup
.
New in theforeman.foreman 1.0.0
Synopsis
Create, update, and delete external user groups
Aliases: foreman_external_usergroup
Requirements
The below requirements are needed on the host that executes this module.
requests
Parameters
Parameter |
Comments |
---|---|
Name of the authentication source to be used for this group |
|
Name of the group |
|
Password of the user accessing the Foreman server. If the value is not specified in the task, the value of environment variable |
|
URL of the Foreman server. If the value is not specified in the task, the value of environment variable |
|
State of the entity Choices:
|
|
Name of the linked usergroup |
|
Username accessing the Foreman server. If the value is not specified in the task, the value of environment variable |
|
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 Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in check_mode and return changed status prediction without modifying the entity |
|
Support: full |
Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode |
Examples
- name: Create an external user group
theforeman.foreman.external_usergroup:
name: test
auth_source: "My LDAP server"
usergroup: "Internal Usergroup"
state: present
- name: Link a group from FreeIPA
theforeman.foreman.external_usergroup:
name: ipa_users
auth_source: "External"
usergroup: "Internal Usergroup"
state: present
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Final state of the affected entities grouped by their type. Returned: success |
|
List of external usergroups. Returned: success |