You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

udm_group - Manage of the posix group¶

New in version 2.2.

Synopsis
Requirements (on host that executes module)
Options
Examples
- Status

Synopsis ¶

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.

Requirements (on host that executes module)¶

Python >= 2.6

Options ¶

parameter	required	default	choices	comments
description	no			Group description.
name	yes			Name of the posix group.
ou	no			LDAP OU, e.g. school for LDAP OU `ou=school,dc=example,dc=com`.
position	no			define the whole ldap position of the group, e.g. `cn=g123m-1A,cn=classes,cn=schueler,cn=groups,ou=schule,dc=example,dc=com`.
state	no	present	present absent	Whether the group is present or not.
subpath	no			Subpath inside the OU, e.g. `cn=classes,cn=students,cn=groups`.

Examples ¶

# Create a POSIX group
- udm_group:
    name: g123m-1A

# 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)
- udm_group:
    name: g123m-1A
    subpath: 'cn=classes,cn=students,cn=groups'
    ou: school
# or
- udm_group:
    name: g123m-1A
    position: 'cn=classes,cn=students,cn=groups,ou=school,dc=school,dc=example,dc=com'

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.