W3cubDocs

/Ansible

community.general.udm_group – Manage of the posix group

Note

This plugin is part of the community.general collection (version 3.8.1).

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.

Requirements

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

  • Python >= 2.6

Parameters

Parameter Choices/Defaults Comments
description
string
Group description.
name
string / required
Name of the posix group.
ou
string
LDAP OU, e.g. school for LDAP OU ou=school,dc=example,dc=com.
position
string
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
string
    Choices:
  • present ←
  • absent
Whether the group is present or not.
subpath
string
Default:
"cn=groups"
Subpath inside the OU, e.g. cn=classes,cn=students,cn=groups.

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–2021 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