--- title: "ldap" slug: "ldap" tags: ["Reference", "CMS 11.x", "EX 11.x", "HX 10.x", "FX 11.x", "AX 11.x", "NX 11.x", "IVX 11.x", "Customer", "Network Security"] updated: 2026-08-04T17:21:49Z published: 2026-08-04T17:21:49Z canonical: "docs.trellix.com/ldap" stale: true --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.trellix.com/llms.txt > Use this file to discover all available pages before exploring further. # ldap To configure the Active Directory using LDAP server settings for Trellix appliances, use the **ldap** command in configuration mode. See [ldap ssl](/network-and-platform/docs/ldap-ssl) for the commands used to secure LDAP. ### Syntax [**no**] **ldap base-dn***string* [**no**] **ldap bind-dn***string* [**no**] **ldap bind-password***string* [**no**] **ldap group-attribute** {*string* | **member** | **uniqueMember**} [**no**] **ldap group-dn***string* [**no**] **ldap host***ipv4_or_ipv6_address* [**no**] **ldap host** *ipv4_or_ipv6_address***order** {**last** | *order_number*} [**no**] **ldap login-attribute** {*string* | **uid** | **sAMAccountName**} [**no**] **ldap port** *port* [no] ldap referrals [no] ldap scope {one-level | subtree} **[no] ldap search-filter***string* [**no**] **ldap timeout-bind***seconds* [**no**] **ldap timeout-search***seconds* [**no**] **ldap version** {*versionNumber* | **2** | **3**} ### Parameters | **base-dn***string* | Configures the LDAP user search base specified as a string. | | --- | --- | | **bind-dn***string* | Sets the Distinguished Name that is to bind with the server, specified as a string. | | **bind-password***string* | Configures the credentials with which a Distinguished Name binds to the LDAP server. | | **group-attribute** { *string* \| **member** \| **uniqueMember**} | Sets the attribute name that will be used to check for group membership. The userʼs distinguished name must be listed as one of the values of this attribute, or the user will not be authorized to log in. The **no** form resets to the default, **member**. | | **group-dn***string* | Sets the Distinguished Name of a group required for authorization. | | **host** *ipv4_or_ipv6_address***order** {**last** \| *order_number*} | Configures hosts to which to send LDAP authentication requests. Optionally sets the order of the specified host, or specifies it as last. | | **login-attribute** { *string* \| **uid** \| **sAMAccountName**} | Configures which attribute is to hold the LDAP login name specified as a custom string, or as a uid LDAP login name, or as an sAMAccountName Active Directory login name. | | **port** *port* | Configures the LDAP server port number. | | **referrals** | Enables LDAP referrals. | | **scope** {**one-level** \| **subtree**} | Configures the LDAP user search scope at either one-level, which searches the object’s immediate children, or at subtree, which searches the object and all of its descendants. | | **search-filter***string* | Controls which users can log in using LDAP. For example, the filter could prevent users who are not part of a certain LDAP group from logging in. A negative response from the filter takes precedence over a remote authentication server that permits the user to log in. **NOTE**: If the string contains spaces, enclose the string with double quotation marks. | | **timeout-bind***seconds* | Configures the LDAP timeout (in seconds) for binding to a server. | | **timeout-search***seconds* | Configures the LDAP timeout (in seconds) for searching for user information. | | **version** {*versionNumber* \| **2** \| **3**} | Configures the LDAP version to support. Specify a version number, version **2** (older servers), or version **3** (for current LDAP and Active Directory servers). | ### Example The following example configures the appliance to use Active Directory authentication using LDAP for user authentication: ``` hostname (config) # ldap base-dn “OU=Users,OU=SanFrancisco,DC=Corp,DC=com” hostname (config) # ldap bind-dn “CN=Jessie Smith,OU=Users,OU=SanFrancisco,DC=Corp,DC=com” hostname (config) # ldap bind-password ******** hostname (config) # ldap group-dn “CN=Corp-Marketing,OU=Distribution Group,OU=SanFrancisco,DC=Corp,DC=com” hostname (config) # ldap host 10.1.1.0 hostname (config) # ldap group-attribute sAMAccountName hostname (config) # ldap port 389 hostname (config) # ldap version 3 hostname (config) # ldap scope subtree hostname (config) # aaa authentication login default ldap local hostname (config) # aaa authorization map default-user admin hostname (config) # write memory ``` ### User role Admin ### Command mode Config