How to Setup LDAP Server

This guide introduces some basic information the of LDAP and explains how to setup LDAP server on Yeastar S-Series VoIP PBX and how to use LDAP phonebook on IP phones. 

In this Article

LDAP Introduction

LDAP stands for Lightweight Directory Access Protocol which is a client-server protocol for accessing a directory service. Yeastar S-Series PBX has an integrated LDAP server, to provide centralized phonebook management. With the LDAP phone book, you can quickly launch calls without wasting time finding a contact’s number and subsequently entering it on your phone.

What kind of information can be stored in the LDAP directory? 

The LDAP information model is based on entries. An entry is a collection of attributes that has a globally-unique Distinguished Name (DN). The DN is used to refer to the entry unambiguously. Each of the entry's attributes has a type and one or more values. The types are typically mnemonic strings, like "cn" for common name, or "mail" for email address. The syntax of values depend on the attribute type. For example, a cn attribute might contain the value Babs Jensen. A mail attribute might contain the value "".

LDAP Common AttributesLDAP Common Attributes

How is the information arranged? 

In LDAP, directory entries are arranged in a hierarchical tree-like structure. The following figure shows an example of Yeastar S-Series LDAP directory tree.

Yeastar S-Series LDAP directory tree

Installing and Configuring the LDAP Server

  1. Log in S-Series Web interface, go to App Center, find LDAP server and install the App.
  2. Once installed, you can find LDAP server on Main Menu.
  3. Check the option “Enable LDAP Server” and click “Save”, the page will show “LDAP is running”.
    Enable LDAP Server on PBX

    The LDAP server is preconfigured already. Please check the description for LDAP server attributes.
    description for LDAP server attributes

LDAP Phonebook/ Address Book Configuration

Default Phonebook

The LDAP server has a default LDAP phonebook with PBX DN “ou=pbx,dc=pbx,dc=com”, which is synchronized with the extensions on the S-Series PBX.

Click Edit to view the phonebook “pbx”.

Edit Phonebook on S-Series VoIP PBX

Note  Note
  • You cannot add or delete the contacts in the default phonebook directly. Go to “Settings > PBX> Extensions” to configure extensions, the phonebook will be automatically updated.

Adding a New Phonebook

  1. Click “Add” to add a new phonebook.
  2. Enter the phonebook name, the phonebook node will be automatically filled in.
  3. Click “Save”.
    Once added, you can click Edit to add and edit contacts in the phonebook, or clickDelete to delete the phonebook.

Importing a Phonebook

  1. Click “Import”.
  2. Click “Browse” and select the file to start uploading. Check the sample file below. You can export a speed dial file from S-Series and use it as a sample to start with.
  3. In the CSV file, you can specify different phonebook Node fields for different contacts. The contacts in the CSV file will be added into the existing phonebooks.
Note  Note
  • The file to be imported must be a CSV file with UTF-8 encoding. You can open the file with Notepad and save it with UTF-8 encoding.
  • Phonebook Node, Nickname and at least one contact information (Email, Mobile Number, Office Number or Home Number) are required in the CSV file.
  • Phonebook Node cannot be set to “pbx”, which is the same with the default phonebook node.

Exporting a Phonebook

Select the checkbox of the phonebook, click “Export”, the selected LDAP phonebook will be exported to your local PC.

Export LDAP phonebook

Using LDAP on Different Phones

We have tested LDAP on different phones, please check the following configuration guides for different IP Phone models.

Have more questions? Submit a request


Please sign in to leave a comment.