theforeman.foreman.external_usergroup – Manage External User Groups
theforeman.foreman.external_usergroup – Manage External User Groups
Note
This plugin is part of the theforeman.foreman collection (version 1.5.1).
To install it use: ansible-galaxy collection install theforeman.foreman
.
To use it in a playbook, specify: theforeman.foreman.external_usergroup
.
New in version 1.0.0: of theforeman.foreman
Synopsis
- Create, update, and delete external user groups
Requirements
The below requirements are needed on the host that executes this module.
- requests
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
auth_source string / required |
Name of the authentication source to be used for this group
| |
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 | |
server_url string / required |
URL of the Foreman server. If the value is not specified in the task, the value of environment variable | |
state string |
|
State of the entity |
usergroup string / required |
Name of the linked usergroup | |
username string / required |
Username accessing the Foreman server. If the value is not specified in the task, the value of environment variable | |
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 |
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 | Returned | Description | |
---|---|---|---|
entity dictionary |
success |
Final state of the affected entities grouped by their type.
| |
external_usergroups list / elements=dictionary |
success |
List of external usergroups.
|
Authors
- Kirill Shirinkin (@Fodoj)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/theforeman/foreman/external_usergroup_module.html