Class: Ansible::Ruby::Modules::Udm_user

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Udm_user

Defined in:

lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb

Overview

This module allows to manage posix users 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

• #birthday ⇒ Object^?

  Birthday.

• #city ⇒ Object^?

  City of users business address.

• #country ⇒ Object^?

  Country of users business address.

• #department_number ⇒ Object^?

  Department number of users business address.

• #description ⇒ Object^?

  Description (not gecos).

• #display_name ⇒ Object^?

  Display name (not gecos).

• #email ⇒ Object^?

  A list of e-mail addresses.

• #employee_number ⇒ Object^?

  Employee number.

• #employee_type ⇒ Object^?

  Employee type.

• #firstname ⇒ String^?

  First name.

• #gecos ⇒ Object^?

  GECOS.

• #groups ⇒ Object^?

  POSIX groups, the LDAP DNs of the groups will be found with the LDAP filter for each group as $GROUP: C((&(objectClass=posixGroup)(cn=$GROUP))).

• #home_share ⇒ Object^?

  Home NFS share.

• #home_share_path ⇒ Object^?

  Path to home NFS share, inside the homeShare.

• #home_telephone_number ⇒ Object^?

  List of private telephone numbers.

• #homedrive ⇒ Object^?

  Windows home drive, e.g.

• #lastname ⇒ String^?

  Last name.

• #mail_alternative_address ⇒ Object^?

  List of alternative e-mail addresses.

• #mail_home_server ⇒ Object^?

  FQDN of mail server.

• #mail_primary_address ⇒ Object^?

  Primary e-mail address.

• #mobile_telephone_number ⇒ Object^?

  Mobile phone number.

• #organisation ⇒ Object^?

  Organisation.

• #ou ⇒ String^?

  Organizational Unit inside the LDAP Base DN, e.g.

• #override_pw_history ⇒ :yes, ...

  Override password history.

• #override_pw_length ⇒ :yes, ...

  Override password check.

• #pager_telephonenumber ⇒ Object^?

  List of pager telephone numbers.

• #password ⇒ String^?

  Password.

• #phone ⇒ Object^?

  List of telephone numbers.

• #position ⇒ String^?

  Define the whole position of users object inside the LDAP tree, e.g.

• #postcode ⇒ Object^?

  Postal code of users business address.

• #primary_group ⇒ Array<String>, ...

  Primary group.

• #profilepath ⇒ Object^?

  Windows profile directory.

• #pwd_change_next_login ⇒ 0, ...

  Change password on next login.

• #room_number ⇒ Object^?

  Room number of users business address.

• #samba_privileges ⇒ Object^?

  Samba privilege, like allow printer administration, do domain join.

• #samba_user_workstations ⇒ Object^?

  Allow the authentication only on this Microsoft Windows host.

• #sambahome ⇒ Object^?

  Windows home path, e.g.

• #scriptpath ⇒ Object^?

  Windows logon script.

• #secretary ⇒ Object^?

  A list of superiors as LDAP DNs.

• #serviceprovider ⇒ Object^?

  Enable user for the following service providers.

• #shell ⇒ String^?

  Login shell.

• #state ⇒ :present, ...

  Whether the user is present or not.

• #street ⇒ Object^?

  Street of users business address.

• #subpath ⇒ String^?

  LDAP subpath inside the organizational unit, e.g.

• #title ⇒ Object^?

  Title, e.g.

• #unixhome ⇒ String^?

  Unix home directory.

• #update_password ⇒ String^?

  C(always) will update passwords if they differ.

• #userexpiry ⇒ String^?

  Account expiry date, e.g.

• #username ⇒ Object

  User name.

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

#birthday ⇒ Object^?

Returns Birthday.

Returns:

• (Object, nil) —

  Birthday

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 32

attribute :birthday

#city ⇒ Object^?

Returns City of users business address.

Returns:

• (Object, nil) —

  City of users business address.

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 35

attribute :city

#country ⇒ Object^?

Returns Country of users business address.

Returns:

• (Object, nil) —

  Country of users business address.

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 38

attribute :country

#department_number ⇒ Object^?

Returns Department number of users business address.

Returns:

• (Object, nil) —

  Department number of users business address.

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 41

attribute :department_number

#description ⇒ Object^?

Returns Description (not gecos).

Returns:

• (Object, nil) —

  Description (not gecos)

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 44

attribute :description

#display_name ⇒ Object^?

Returns Display name (not gecos).

Returns:

• (Object, nil) —

  Display name (not gecos)

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 47

attribute :display_name

#email ⇒ Object^?

Returns A list of e-mail addresses.

Returns:

• (Object, nil) —

  A list of e-mail addresses.

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 50

attribute :email

#employee_number ⇒ Object^?

Returns Employee number.

Returns:

• (Object, nil) —

  Employee number

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 53

attribute :employee_number

#employee_type ⇒ Object^?

Returns Employee type.

Returns:

• (Object, nil) —

  Employee type

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 56

attribute :employee_type

#firstname ⇒ String^?

Returns First name. Required if C(state=present).

Returns:

• (String, nil) —

  First name. Required if C(state=present).

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

attribute :firstname

#gecos ⇒ Object^?

Returns GECOS.

Returns:

• (Object, nil) —

  GECOS

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 59

attribute :gecos

#groups ⇒ Object^?

Returns POSIX groups, the LDAP DNs of the groups will be found with the LDAP filter for each group as $GROUP: C((&(objectClass=posixGroup)(cn=$GROUP))).

Returns:

• (Object, nil) —

  POSIX groups, the LDAP DNs of the groups will be found with the LDAP filter for each group as $GROUP: C((&(objectClass=posixGroup)(cn=$GROUP))).

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 62

attribute :groups

#home_share ⇒ Object^?

Returns Home NFS share. Must be a LDAP DN, e.g. C(cn=home,cn=shares,ou=school,dc=example,dc=com).

Returns:

• (Object, nil) —

  Home NFS share. Must be a LDAP DN, e.g. C(cn=home,cn=shares,ou=school,dc=example,dc=com).

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 65

attribute :home_share

#home_share_path ⇒ Object^?

Returns Path to home NFS share, inside the homeShare.

Returns:

• (Object, nil) —

  Path to home NFS share, inside the homeShare.

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 68

attribute :home_share_path

#home_telephone_number ⇒ Object^?

Returns List of private telephone numbers.

Returns:

• (Object, nil) —

  List of private telephone numbers.

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 71

attribute :home_telephone_number

#homedrive ⇒ Object^?

Returns Windows home drive, e.g. C(“H:”).

Returns:

• (Object, nil) —

  Windows home drive, e.g. C(“H:”).

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 74

attribute :homedrive

#lastname ⇒ String^?

Returns Last name. Required if C(state=present).

Returns:

• (String, nil) —

  Last name. Required if C(state=present).

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 24

attribute :lastname

#mail_alternative_address ⇒ Object^?

Returns List of alternative e-mail addresses.

Returns:

• (Object, nil) —

  List of alternative e-mail addresses.

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 77

attribute :mail_alternative_address

#mail_home_server ⇒ Object^?

Returns FQDN of mail server.

Returns:

• (Object, nil) —

  FQDN of mail server

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 80

attribute :mail_home_server

#mail_primary_address ⇒ Object^?

Returns Primary e-mail address.

Returns:

• (Object, nil) —

  Primary e-mail address

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 83

attribute :mail_primary_address

#mobile_telephone_number ⇒ Object^?

Returns Mobile phone number.

Returns:

• (Object, nil) —

  Mobile phone number

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 86

attribute :mobile_telephone_number

#organisation ⇒ Object^?

Returns Organisation.

Returns:

• (Object, nil) —

  Organisation

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 89

attribute :organisation

#ou ⇒ String^?

Returns Organizational Unit inside the LDAP Base DN, e.g. C(school) for LDAP OU C(ou=school,dc=example,dc=com).

Returns:

• (String, nil) —

  Organizational Unit inside the LDAP Base DN, e.g. C(school) for LDAP OU C(ou=school,dc=example,dc=com).

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 167

attribute :ou

#override_pw_history ⇒ :yes, ...

Returns Override password history.

Returns:

• (:yes, :no, nil) —

  Override password history

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 92

attribute :override_pw_history

#override_pw_length ⇒ :yes, ...

Returns Override password check.

Returns:

• (:yes, :no, nil) —

  Override password check

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 96

attribute :override_pw_length

#pager_telephonenumber ⇒ Object^?

Returns List of pager telephone numbers.

Returns:

• (Object, nil) —

  List of pager telephone numbers.

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 100

attribute :pager_telephonenumber

#password ⇒ String^?

Returns Password. Required if C(state=present).

Returns:

• (String, nil) —

  Password. Required if C(state=present).

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 28

attribute :password

#phone ⇒ Object^?

Returns List of telephone numbers.

Returns:

• (Object, nil) —

  List of telephone numbers.

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 103

attribute :phone

#position ⇒ String^?

Returns Define the whole position of users object inside the LDAP tree, e.g. C(cn=employee,cn=users,ou=school,dc=example,dc=com).

Returns:

• (String, nil) —

  Define the whole position of users object inside the LDAP tree, e.g. C(cn=employee,cn=users,ou=school,dc=example,dc=com).

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 159

attribute :position

#postcode ⇒ Object^?

Returns Postal code of users business address.

Returns:

• (Object, nil) —

  Postal code of users business address.

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 106

attribute :postcode

#primary_group ⇒ Array<String>, ...

Returns Primary group. This must be the group LDAP DN.

Returns:

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

  Primary group. This must be the group LDAP DN.

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 109

attribute :primary_group

#profilepath ⇒ Object^?

Returns Windows profile directory.

Returns:

• (Object, nil) —

  Windows profile directory

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 113

attribute :profilepath

#pwd_change_next_login ⇒ 0, ...

Returns Change password on next login.

Returns:

• (0, 1, nil) —

  Change password on next login.

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 116

attribute :pwd_change_next_login

#room_number ⇒ Object^?

Returns Room number of users business address.

Returns:

• (Object, nil) —

  Room number of users business address.

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 120

attribute :room_number

#samba_privileges ⇒ Object^?

Returns Samba privilege, like allow printer administration, do domain join.

Returns:

• (Object, nil) —

  Samba privilege, like allow printer administration, do domain join.

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 123

attribute :samba_privileges

#samba_user_workstations ⇒ Object^?

Returns Allow the authentication only on this Microsoft Windows host.

Returns:

• (Object, nil) —

  Allow the authentication only on this Microsoft Windows host.

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 126

attribute :samba_user_workstations

#sambahome ⇒ Object^?

Returns Windows home path, e.g. C(‘\\$FQDN\$USERNAME’).

Returns:

• (Object, nil) —

  Windows home path, e.g. C(‘\\$FQDN\$USERNAME’).

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 129

attribute :sambahome

#scriptpath ⇒ Object^?

Returns Windows logon script.

Returns:

• (Object, nil) —

  Windows logon script.

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 132

attribute :scriptpath

#secretary ⇒ Object^?

Returns A list of superiors as LDAP DNs.

Returns:

• (Object, nil) —

  A list of superiors as LDAP DNs.

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 135

attribute :secretary

#serviceprovider ⇒ Object^?

Returns Enable user for the following service providers.

Returns:

• (Object, nil) —

  Enable user for the following service providers.

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 138

attribute :serviceprovider

#shell ⇒ String^?

Returns Login shell.

Returns:

• (String, nil) —

  Login shell

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 141

attribute :shell

#state ⇒ :present, ...

Returns Whether the user is present or not.

Returns:

• (:present, :absent, nil) —

  Whether the user is present or not.

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

attribute :state

#street ⇒ Object^?

Returns Street of users business address.

Returns:

• (Object, nil) —

  Street of users business address.

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 145

attribute :street

#subpath ⇒ String^?

Returns LDAP subpath inside the organizational unit, e.g. C(cn=teachers,cn=users) for LDAP container C(cn=teachers,cn=users,dc=example,dc=com).

Returns:

• (String, nil) —

  LDAP subpath inside the organizational unit, e.g. C(cn=teachers,cn=users) for LDAP container C(cn=teachers,cn=users,dc=example,dc=com).

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 171

attribute :subpath

#title ⇒ Object^?

Returns Title, e.g. C(Prof.).

Returns:

• (Object, nil) —

  Title, e.g. C(Prof.).

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 148

attribute :title

#unixhome ⇒ String^?

Returns Unix home directory.

Returns:

• (String, nil) —

  Unix home directory

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 151

attribute :unixhome

#update_password ⇒ String^?

Returns C(always) will update passwords if they differ. C(on_create) will only set the password for newly created users.

Returns:

• (String, nil) —

  C(always) will update passwords if they differ. C(on_create) will only set the password for newly created users.

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 163

attribute :update_password

#userexpiry ⇒ String^?

Returns Account expiry date, e.g. C(1999-12-31).

Returns:

• (String, nil) —

  Account expiry date, e.g. C(1999-12-31).

# File 'lib/ansible/ruby/modules/generated/cloud/univention/udm_user.rb', line 155

attribute :userexpiry

#username ⇒ Object

Returns User name.

Returns:

• (Object) —

  User name

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

attribute :username