---
gitea: none
include_toc: true
---
# openldap
## Synopsis
OpenLDAP, the LDAP server.
[Software's website.](https://www.openldap.org/)
This service provides a LDAP server.
It is possible to request the creation of users. Those users can be mixed or
classified into families.
Those users will be created and updated. They will never be deleted. The
initial password will be generated but never updated. You can modify them.
Other services may also require automatic user creation.
## Variables
### Accounts
#### Users management
Management of manually created local users. Those users are not classified. This family is a leadership.
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------|
| **[accounts.users.ldap_user_mail](extras/accounts/00_account.xml)**
multiple
**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Email address.
An user is identify by his email address.
**Example:** johndoe@example.net |
| **[accounts.users.ldap_user_aliases](extras/accounts/00_account.xml)**
multiple
**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Emails aliases.
**Example:** jdoe@example.net |
| **[accounts.users.ldap_user_uid](extras/accounts/00_account.xml)**
mandatory
**Type:** [`unix_user`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Account name.
**Example:** jdoe |
| **[accounts.users.ldap_user_gn](extras/accounts/00_account.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Given Name.
**Example:** John |
| **[accounts.users.ldap_user_sn](extras/accounts/00_account.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Surname.
**Example:** Doe |
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|
| **[accounts.families](extras/accounts/00_account.xml)**
multiple
**Type:** [`unix_user`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Families to create.
Users can be classified into families. This variable contains all the names of the families to be created. |
#### Management of family *suffix name*
Management of manually created users. Those users an classified in a family. This a dynamic family generated from the variable "accounts.families".
##### Gestion des utilisateurs de la famille *suffix name*
This family is a leadership.
| Parameter | Comments |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------|
| **[accounts.family_*suffix name*.users_*suffix name*.ldap_user_mail_*suffix name*](extras/accounts/00_account.xml)**
multiple
**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Adresse courriel du compte de la famille . |
| **[accounts.family_*suffix name*.users_*suffix name*.ldap_user_aliases_*suffix name*](extras/accounts/00_account.xml)**
multiple
**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Aliases du mail de la famille . |
| **[accounts.family_*suffix name*.users_*suffix name*.ldap_user_uid_*suffix name*](extras/accounts/00_account.xml)**
mandatory
**Type:** [`unix_user`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de compte de la famille . |
| **[accounts.family_*suffix name*.users_*suffix name*.ldap_user_sn_*suffix name*](extras/accounts/00_account.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Prénom de la famille . |
| **[accounts.family_*suffix name*.users_*suffix name*.ldap_user_gn_*suffix name*](extras/accounts/00_account.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de famille de la famille . |
## Variables for expert
### Général
#### ldap
| Parameter | Comments |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **[general.ldap.ldap_schemas](dictionaries/21_openldap-server.xml)**
mandatory, multiple
**Type:** [`filename`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Schémas LDAP additionnel.
**Default:**