/ home / community / community.general / 8.5.0 / module / udm_group

community.general.udm_group (8.5.0) — module

Manage of the posix group

Authors: Tobias Rüetschi (@keachi)

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

This module allows to manage user groups on a univention corporate server (UCS). It uses the python API of the UCS to create a new object or edit it.

Usage examples

Scanned by Steampunk Spotter

- name: Create a POSIX group
  community.general.udm_group:
    name: g123m-1A

Scanned by Steampunk Spotter

# Create a POSIX group with the exact DN
# C(cn=g123m-1A,cn=classes,cn=students,cn=groups,ou=school,dc=school,dc=example,dc=com)
- name: Create a POSIX group with a DN
  community.general.udm_group:
    name: g123m-1A
    subpath: 'cn=classes,cn=students,cn=groups'
    ou: school

Scanned by Steampunk Spotter

# or
- name: Create a POSIX group with a DN
  community.general.udm_group:
    name: g123m-1A
    position: 'cn=classes,cn=students,cn=groups,ou=school,dc=school,dc=example,dc=com'

Inputs

    
ou:
    default: ''
    description:
    - LDAP OU, e.g. school for LDAP OU C(ou=school,dc=example,dc=com).
    required: false
    type: str

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

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Whether the group is present or not.
    required: false
    type: str

subpath:
    default: cn=groups
    description:
    - Subpath inside the OU, e.g. C(cn=classes,cn=students,cn=groups).
    required: false
    type: str

position:
    default: ''
    description:
    - define the whole ldap position of the group, e.g. C(cn=g123m-1A,cn=classes,cn=schueler,cn=groups,ou=schule,dc=example,dc=com).
    required: false
    type: str

description:
    description:
    - Group description.
    required: false
    type: str