Configure LDAP Server for Integration¶
This procedure adds and configures a LDAP server for integration with VOSS Automate.
To add a LDAP Server:
Log in as provider, reseller, or customer administrator.
Set the hierarchy node to the node where you want the users synchronized.
Go to (default menus) LDAP Management > LDAP Server.
Click Add.
Fill out the fields on the Base tab.
Optionally, on the Sync List tab, if you choose LDAP sync list option Create sync list from template, you can choose a LDAP sync list template (based on the server type) - either of these:
Ldap Sync List Microsoft Active Directory
Ldap Sync List Open Ldap
You can choose a template when adding the LDAP server, or update your choice after saving. If you don’t choose a template, LDAP sync is not affected by this list. See the tab description, and see:
Click Save to add the LDAP server.
Test the connection to ensure the LDAP server is configured correctly.
If the authentication credentials or search base DN are invalid, the system displays an error, for example:
Error encountered while processing your request
caught exception: [Helper] validation failed; Invalid search base db.
Base Tab¶
Fields |
Description |
|---|---|
Description |
Defaults to the current hierarchy level. |
Host Name * |
Hostname or IP address of the LDAP server. This field is required. |
Port |
Port number for LDAP traffic. Defaults to 389. |
User DN * |
The User Distinguished Name of an administrative user who has access rights to the Base DN on the LDAP server. This field is required. Examples:
|
Admin Password * |
Admin password associated with the user. This field is required. |
Search Base DN * |
Base Distinguished Name for LDAP search. This should be a container or directory on the LDAP server where the LDAP users exist, such as an Organization Unit or OU. As an example, to search within an Organizational Unit called CUS01 under a domain called GCLAB.COM, the Search Base DN would be OU=CUS01,DC=GCLAB,DC=COM. This field is required. Note that the search will traverse the directory tree from this point down and will include any sub OU’s which have been added within the OU. |
Search Filter |
An RFC 2254 conformant string used to restrict the results returned by list operations on the LDAP server. |
Server Type * |
Choose between Microsoft Active Directory or OpenLDAP. For AD LDS (ADAM), choose Microsoft Active Directory. |
AD Sync Mode * |
Defaults to Direct. |
Enable Write Operations |
This check box is only shown for Microsoft Active Directory servers (Server Type is Microsoft Active Directory) when Encryption Method is “Use SSL Encryption (ldaps://)” (port is |
Fields |
Description |
|---|---|
CUCM LDAP Directory Name |
The name of the LDAP Directory configured on CUCM that we want this user to be considered synced from. The LDAP Directory must be configured on CUCM already. This is an optional parameter but the following should be considered: For top down sync scenario, Users will be added to CUCM as Local Users if this parameter is not set. For bottom up sync scenario, Users will not be able to log on to VOSS Automate if this parameter is not set. |
Encryption Method |
Choose between No Encryption, Use SSL Encryption (ldaps://), or Use StartTLS Extension.
|
Server Root Certificate |
If Trust All is Cleared, the LDAP server’s SSL certificate is validated against this root certificate. If no Server Root Certificate is specified, validation is done against any existing trusted CA certificates. Use this option for custom root certificates in .pem format. See “SSO Certificate Management” for more information. |
Trust All |
Select this check box to disable certificate validation. |
Primary Key Attribute |
The attribute value used to uniquely identify and search for records on an LDAP server. For example, |
Authentication Scope |
Hierarchical scope this server applies to: Local authentication or Full tree authentication. 1 |
User sync type |
Type of users that can authenticate against this server: All users or Synced users only
|
Authentication enabled |
Indicate whether the server is available for authentication. Default value is True. |
Search Filter examples:
(telephoneNumber=919*): all telephone numbers starting with 919((&(OfficeLocations=RTP)(|(department=Engineering)(department=Marketing))): office is located in RTP and department is either Engineering or Marketing(&(MemberOf=cn=Admin,ou=users,dc=foo,dc=com)(!(c=US))): all Admins except those in the U.S.
User lookup for LDAP authentication is restricted to the device/ldap model
specified in the Authentication Attribute: Model Type.
For example, if this attribute was device/ldap/user, the LDAP user authentication is
restricted to (objectClass=user).
LDAP Sync Tab¶
When adding a new LDAP server or updating an existing server added prior to release 19.3.4, you can choose an LDAP Sync List Option.
A sync list improves performance and limits sync attributes to those relevant to your scenario.
The table describes the available LDAP sync list options on this tab:
No sync list - all fields will be synced |
LDAP sync is not driven by a LDAP Sync List. All fields are imported as before release 19.3.4. |
Create sync list manually |
The fields to sync can be added or modified manually. For list override precedence and other considerations, see LDAP Sync Lists. |
Create sync list from template |
This option displays an additional field (LDAP Sync List Template). Choose a sync list from a predefined configuration template (CFT). VOSS Automate provides default Sync List CFTs for the following:
These CFTs contain LDAP attributes that are typically required to be synced with LDAP. Once you’ve applied the template, or if a template is not used, a sync list is visible and configurable directly on a saved LDAP server Sync List tab. See LDAP Sync Lists. |
Related Topics
- 1
For details around authentication scope, see User Login Options by Authentication Method and Server Authentication Scope.