Class: Ansible::Ruby::Modules::Udm_group

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/univention/udm_group.rb

Overview

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.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#description ⇒ Object?

Returns Group description.

Returns:

  • (Object, nil) —

    Group description.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_group.rb', line 20

attribute :description

#name ⇒ String

Returns Name of the posix group.

Returns:

  • (String) —

    Name of the posix group.



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_group.rb', line 16

attribute :name

#ou ⇒ String?

Returns LDAP OU, e.g. school for LDAP OU C(ou=school,dc=example,dc=com).

Returns:

  • (String, nil) —

    LDAP OU, e.g. school for LDAP OU C(ou=school,dc=example,dc=com).



27
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_group.rb', line 27

attribute :ou

#position ⇒ Array<String>, ...

Returns 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).

Returns:

  • (Array<String>, String, nil) —

    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).



23
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_group.rb', line 23

attribute :position

#state ⇒ :present, ...

Returns Whether the group is present or not.

Returns:

  • (:present, :absent, nil) —

    Whether the group is present or not.



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_group.rb', line 12

attribute :state

#subpath ⇒ Array<String>, ...

Returns Subpath inside the OU, e.g. C(cn=classes,cn=students,cn=groups).

Returns:

  • (Array<String>, String, nil) —

    Subpath inside the OU, e.g. C(cn=classes,cn=students,cn=groups).



31
 
# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_group.rb', line 31

attribute :subpath