LDAP Directory configuration

Last Updated : Apr 17, 2026 |
Prolog information
Metadata
Keywords:
Use the 46xxsettings.txt file to set the following parameters for the LDAP directory:
Parameter name
Default value
Description
DIRENABLED_PLATFORM
Determines whether the LDAP directory search and application are enabled on the phone.
Value operation:
DIRUSERNAME
Null
Specifies the LDAP client username.
The following characters are allowed:
  • 0–9
  • a-z
  • A-Z
The preferred way of configuring this parameter is through the web interface.
DIRPASSWORD
Null
Specifies the LDAP client password.
The following characters are allowed:
  • 0–9
  • a-z
  • A-Z
The preferred way of configuring this parameter is through the web interface.
DIRSRVR
Null
Specifies the IP address or a fully qualified domain name (FQDN) of the LDAP directory server.
The valid value is an IPv6 or IPv4 address in the dotted decimal format or a FQDN.
For example,SET DIRSRVR 192.168.161.54orSET DIRSRVR domain.com
DIRSRVRPRT
389
Specifies the port number for the LDAP directory server.
Valid values are positive integers from 1 to 65535.
For example,SET DIRSRVRPRT 389
DIRTOPDN
Null
Specifies the LDAP search base.
For example,
SET DIRTOPDN "dc=global,dc=avaya,dc=com"
DIRSECURE
Specifies whether to use TLS or TCP for the LDAP server.
Value operation:
For example,
SET DIRSECURE 1
There is a difference between STARTTLS and LDAPS: STARTTLS uses the same port as the LDAP protocol. The DIRSRVRPRT parameter value must be the same as the port configured for the LDAP (not for LDAPS) protocol on the server side.
The LDAPS protocol uses a port different from LDAP. The value for DIRSRVRPRT needs to correspond to server port for the LDAPS connection.
DIRAUTHTYPE
Specifies the kind of authentication that is used if the value of the DIRUSERNAME parameter is not null.
Value operation:
  • If a connection is established over TLS (DIRSECURE is set to 1 or 2), DIGEST-MD5 or PLAIN authentication mechanisms are supported.
    If the connection established over TCP (DIRSECURE is set to 0) DIGEST-MD5 is the only supported mechanism.
DIRSEARCH_FIELDS
"cn,sn,telephoneNumber"
Specifies LDAP search attributes. The exact number and names of the search attributes depend on the LDAP server configuration and can vary from one LDAP directory to another.
When configuring the DIRSEARCH_FIELDS parameter, you must use attribute names that coincide with the selected LDAP server attribute names.
For example,
SET DIRSEARCH_FIELDS "givenName,mail,middle initials, telephoneNumber,sn,mobile ,o ,department ,Rank ,office ,DoD SIP URI"
DIRSHOW_FIELDS
"cn,sn,telephoneNumber,Mail"
Specifies LDAP detail show fields. The phone returns the attributes, specified in this parameter, for each match found for a search query.
You can use this parameter to map the specified LDAP keywords. This mapping defines the way the phone displays the fields with LDAP details.
For example,
SET DIRSHOW_FIELDS "dn=Distinguished Name,rank,gn=First Name,office=Office,middle initials=Middle Initial,Display Name=Full Name,sn=Last Name,job title=Job,cn=Common Name,o=Office,c=Country,department=Department,street=Street,mail=Mail Box,l,telephoneNumber=PhoneNumber,st,mobile=Mobile,postalCode=Postal code,facsimileTelephoneNumber=Fax,DoD SIP URI=Number"
In this example, the format is as follows:
SET DIRSHOW_FIELDS "[LDAP Attributes]=[Field Names],[LDAP Attribute 1]=[Field Name1]"
DIRNAME_FIELDS
cn
Specifies the attributes and their order, shown in the search results. Users can view other attributes, pressing the Details soft key.
The attributes specified in this parameter must be a subset of the attributes specified in DIRNAME_FIELDS.
For example,
SET DIRNAME_FIELDS "cn,sn"
In this example, each match on the search result list displays the last name and first name.
DIRNUMBER_FIELDS
telephoneNumber
Specifies the LDAP fields that contain a number a user can call to. The first number listed becomes the primary number.
For example,
SET DIRNUMBER_FIELDS "telephoneNumber,mobile,DoD SIP URI"
DIR_TO_LOCAL_MAPPING
"displayName:Name,telephoneNumber:Work,mobile:Mobile"
Specifies mapping of LDAP fields to local contact fields. If there is no rule for at least one contact number, the entire contact mapping is disabled.
Local contact field names can be assigned from the following:
  • "firstname"
  • "nickname"
  • "URI"
  • "extension"
  • "email"
  • "department"
  • "zipCode"
  • "country"
for number types:
  • "work"
  • "home"
  • "mobile"
  • "other"
DIR_LDAP_DESCRIPTION
“LDAP Directory”
Specifies a custom label to be used for the LDAP directory in the Contacts application.
Valid value is a text string.
Related information
LDAP Directory