redhat.satellite.usergroup – Manage User Groups

Note

This plugin is part of the redhat.satellite collection (version 3.1.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 redhat.satellite.

To use it in a playbook, specify: redhat.satellite.usergroup.

New in version 1.0.0: of redhat.satellite

Synopsis

• Create, update, and delete user groups

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: no ← (default) yes
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 SATELLITE_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 SATELLITE_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 SATELLITE_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 SATELLITE_VALIDATE_CERTS will be used instead. Choices: no yes ← (default)

Examples

- name: Create a user group
  redhat.satellite.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	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)