Introduction

LDAP – Lightweight Directory Access Protocol. It is an application protocol used over an IP network to manage and access the distributed directory information service.

LDAP integration offers the ability to do lookups of contacts from your LDAP server (Active Directory or OpenLDAP for instance).

Overview

This document serves as a guide for setting up LDAP on Switchvox, which employs P-phones to access contact details from an LDAP server.

This functionality has been available as a part of Sangoma Phone firmware version 4_24_3 and later for all Sangoma P-phones models configured with Switchvox 8.2 and later.

Users can now retrieve contacts from their organization's Active Directory, assuming it is already utilized for user authentication.

At present, the contacts obtained from Active Directory include First name (givenName), Last name (sn), Extension (ipPhone), DID (telephoneNumber), and Mobile (mobile), contingent upon these fields being properly configured on the LDAP server.

How to configure LDAP on Switchvox for P-Phones?

User Must follow below steps to configure LDP on Switchvox for Sangoma P-Phones:

Step 1: After logging into Switchvox admin UI with admin credentials, go to Setup → Extensions → Settings page.

Step 2: Change the default User Authorization Type from Local to LDAP under the External Authentication section.

Open

Selecting the LDAP User Authorization Type displays the required fields you enter to set up Switchvox to use LDAP. Local is the default user authorization type and indicates passwords are managed within Switchvox. 

• User Authorization Type--Select LDAP.  This displays required information fields for your directory service host.

• Server--Enter the server name. Note: the server name must begin with ldap:// or ldaps://

• Bind DN--Enter the bind DN, which is an object that Switchvox binds to inside LDAP to request and receive user authentication.

• Bind Password--Enter the password for the bind DN.

• UID Attribute--Enter the name of the field/attribute in your directory that contains the usernames Switchvox will use to authenticate the extensions. A value in this field/attribute in your directory must match exactly to a value in the Username field in a Switchvox SIP Phone Extension. (The Username field is available while Switchvox is in LDAP mode.) The field must contain values that are unique across your directory server. (We can't tell you what this field/attribute is in your directory, but possibilities include userPrincipalName, sAMAccountName (for older versions of Windows), or uid (if you're not using Active Directory).

• Base DN--Enter the point from which a server will search for users.

Step 3: Provide the proper LDAP credentials along with all necessary LDAP details, either using ldap or ldaps.

Step 4: After entering the LDAP information, we recommend you use the Test LDAP settings button to validate the settings. Test the credentials of LDAP entered are proper by pressing “Test LDAP Settings”, then it will ask for an extension username and password, which are configured already on your LDAP server.

Open

Step 5: If the testing is successful, you’ll get the notification that all 3 tests of LDAP are configured properly.

Step 6: If there are any errors in the LDAP credentials, the test will fail and throw an error here.

Step 7: When the information is ready and Testing is successful, click the Save Extension Settings button.

Step 8: The extensions under the Setup → Extensions → Manage page are required to have a username for each, which should be present in the LDAP server.

Step 9: If the username is configured on each extension, then there will be an error as “Missing username, cannot log in”

Step 10: Now the main user's login(/main UI, DSP login, Switchboard login credentials) will be authenticated using the LDAP server and the password field under the Modify Sip Extensions page will be disabled automatically.

LDAP Contacts on P-Series Phones

After LDAP has been configured on Switchvox, and when the P-Phones(with firmware version 4_24_3 and later) are provisioned onto Switchvox,

• P-phones(Except P370), will have a key for the Directory, which is pointed to the LDAP server for contacts list from LDAP is displayed on Phones.

• For P370, there is a new app called Directory, which does the same as above.

Accessing Contacts from LDAP on P-Phones:

Step 1: For P-Phones(Except P370), Press the Contacts key on the phone, which will display all the Extensions configured on the Switchvox.

Step 2: While still accessing the Contacts, the Phone should be displaying Keys as “Dial,  Directory, Show and Filter” on the Phone screen.x

Step 3: Press the Directory key on Phone, it fetches the contacts from the LDAP server and displays onto the Phone now.

Step 4: There will be 3 keys displayed on the screen now as follows: “Dial, Contacts, and Show”.

Step 5: Select a contact and press Dial key or Check Key on the Phone, Phone will now dial the contact.

Step 6: If you press the Contacts key, then the phone screen will go back to the previous menu and display the Contacts from Switchvox.

Step 7: If you press the Show key, after selecting a contact, then it will display all the details of that contact as present on the LDAP server configured.

Step 8: For the P370 Phone model, there is a new application called “Directory”, when selected it will display all the contacts from the LDAP server.

Step 9: To initiate a call to the contact, simply press the corresponding number as present on the phone screen, and the phone will connect the call.

Reference Links

• https://help.sangoma.com/community/s/article/Switchvox-with-Active-Directory-and-LDAP