W3cubDocs

/Ansible

community.general.udm_group module – Manage of the posix group

Note

This module is part of the community.general collection (version 10.7.3).

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 community.general.

To use it in a playbook, specify: community.general.udm_group.

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.

Parameters

Parameter

Comments

description

string

Group description.

name

string / required

Name of the POSIX group.

ou

string

LDAP OU, for example school for LDAP OU ou=school,dc=example,dc=com.

Default: ""

position

string

Define the whole LDAP position of the group, for example cn=g123m-1A,cn=classes,cn=schueler,cn=groups,ou=schule,dc=example,dc=com.

Default: ""

state

string

Whether the group is present or not.

Choices:

  • "present" ← (default)
  • "absent"

subpath

string

Subpath inside the OU, for example cn=classes,cn=students,cn=groups.

Default: "cn=groups"

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: partial

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Examples

- name: Create a POSIX group
  community.general.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)
- name: Create a POSIX group with a DN
  community.general.udm_group:
    name: g123m-1A
    subpath: 'cn=classes,cn=students,cn=groups'
    ou: school

# 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'

Authors

  • Tobias Rüetschi (@keachi)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/udm_group_module.html