theforeman.foreman.foreman_usergroup (0.8.1) — module

Manage Foreman User groups

Authors: Baptiste Agasse (@bagasse)

preview | supported by community

Install collection

Install with ansible-galaxy collection install theforeman.foreman:==0.8.1


Add to requirements.yml

  collections:
    - name: theforeman.foreman
      version: 0.8.1

Description

Create and delete user groups in Foreman


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create a user group
  foreman_usergroup:
    name: test
    admin: no
    roles:
      - Manager
    users:
      - myuser1
      - myuser2
    usergroups:
      - mynestedgroup
    state: present

Inputs

    
name:
    description:
    - Name of the group
    required: true
    type: str

admin:
    default: false
    description:
    - Whether or not the users in this group are administrators
    required: false
    type: bool

roles:
    description:
    - List of roles assigned to the group
    elements: str
    required: false
    type: list

state:
    choices:
    - present
    - absent
    default: present
    description:
    - State of the entity in Foreman
    type: str

users:
    description:
    - List of users assigned to the group
    elements: str
    required: false
    type: list

password:
    description: Password of the user accessing the Foreman server
    required: true
    type: str

username:
    description: Username accessing the Foreman server
    required: true
    type: str

server_url:
    description: URL of the Foreman server
    required: true
    type: str

usergroups:
    description:
    - List of other groups assigned to the group
    elements: str
    required: false
    type: list

updated_name:
    description:
    - New user group name. When this parameter is set, the module will not be idempotent.
    required: false
    type: str

validate_certs:
    aliases:
    - verify_ssl
    default: true
    description: Whether or not to verify the TLS certificates of the Foreman server
    type: bool