foreman_usergroup – Manage Foreman User groups

Synopsis

  • Create and delete user groups in Foreman

Requirements

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

  • apypie

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
roles
list / elements=string
List of roles assigned to the group
server_url
string / required
URL of the Foreman server
state
string
    Choices:
  • present ←
  • absent
State of the entity in Foreman
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
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

aliases: verify_ssl

Examples

- name: Create a user group
  foreman_usergroup:
    name: test
    admin: no
    roles:
      - Manager
    users:
      - myuser1
      - myuser2
    usergroups:
      - mynestedgroup
    state: present

Status

Authors

  • Baptiste Agasse (@bagasse)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.