Skip to content

LDAP Policy

An LDAP Policy configures Lightweight Directory Access Protocol settings for authenticating remote users on UCS servers and chassis against a central directory service such as Microsoft Active Directory or OpenLDAP. It supports group-to-role mapping for role-based access control.

Location in Intersight GUI: Policies » LDAP

Diagram
NameTypeConstraintMandatoryDefault Value
intersightClassintersightNo

NameTypeConstraintMandatoryDefault Value
organizationsListorganizationsNo

NameTypeConstraintMandatoryDefault Value
policiesClasspoliciesNo

policies (compute.intersight.organizations)

Section titled “policies (compute.intersight.organizations)”
NameTypeConstraintMandatoryDefault Value
ldapListldapNo

ldap (compute.intersight.organizations.policies)

Section titled “ldap (compute.intersight.organizations.policies)”
NameTypeConstraintMandatoryDefault Value
nameStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$Yes
descriptionStringNo
managedBooleantrue, falseNotrue
tagsListtagsNo
enabledBooleantrue, falseNotrue
enable_dnsBooleantrue, falseNofalse
user_search_precedenceChoiceLocalUserDb, LdapUserDbNoLocalUserDb
base_propertiesClassbase_propertiesNo
dns_parametersClassdns_parametersNo
providersListprovidersNo
groupsListgroupsNo

tags (compute.intersight.organizations.policies.ldap)

Section titled “tags (compute.intersight.organizations.policies.ldap)”
NameTypeConstraintMandatoryDefault Value
keyStringYes
valueStringNo
typeChoiceKeyValue, PathTagNo

base_properties (compute.intersight.organizations.policies.ldap)

Section titled “base_properties (compute.intersight.organizations.policies.ldap)”
NameTypeConstraintMandatoryDefault Value
attributeStringNo
base_dnStringNo
bind_dnStringNo
bind_methodChoiceLoginCredentials, Anonymous, ConfiguredCredentialsNo
domainStringNo
encryptionBooleantrue, falseNo
group_authorizationBooleantrue, falseNo
nested_group_searchBooleantrue, falseNo
filterStringNo
group_attributeStringNo
nested_group_search_depthIntegermin: 1, max: 128No
passwordStringNo
timeoutIntegermin: 0, max: 180No

dns_parameters (compute.intersight.organizations.policies.ldap)

Section titled “dns_parameters (compute.intersight.organizations.policies.ldap)”
NameTypeConstraintMandatoryDefault Value
sourceChoiceExtracted, Configured, ConfiguredExtractedNo
search_domainStringNo
search_forestStringNo

providers (compute.intersight.organizations.policies.ldap)

Section titled “providers (compute.intersight.organizations.policies.ldap)”
NameTypeConstraintMandatoryDefault Value
serverStringYes
portIntegermin: 1, max: 65535No

groups (compute.intersight.organizations.policies.ldap)

Section titled “groups (compute.intersight.organizations.policies.ldap)”
NameTypeConstraintMandatoryDefault Value
nameStringYes
domainStringNo
roleStringNo

Example-1: LDAP policy for Active Directory with configured credentials and group-based role mapping, including tags.

compute:
intersight:
organizations:
- name: MyOrganization
policies:
ldap:
- name: ad-ldap
description: Active Directory LDAP authentication
enabled: true
user_search_precedence: LocalUserDb
base_properties:
base_dn: "DC=corp,DC=example,DC=com"
bind_dn: "CN=svc-intersight,OU=ServiceAccounts,DC=corp,DC=example,DC=com"
bind_method: ConfiguredCredentials
password: !env LDAP_BIND_PASSWORD
domain: "corp.example.com"
filter: sAMAccountName
group_attribute: memberOf
encryption: true
group_authorization: true
timeout: 30
providers:
- server: ldap01.corp.example.com
port: 636
- server: ldap02.corp.example.com
port: 636
groups:
- name: "CN=UCS-Admins,OU=Groups,DC=corp,DC=example,DC=com"
role: admin
- name: "CN=UCS-ReadOnly,OU=Groups,DC=corp,DC=example,DC=com"
role: readonly
tags:
- key: env
value: prod

Example-2: LDAP policy using DNS-based server discovery.

compute:
intersight:
organizations:
- name: MyOrganization
policies:
ldap:
- name: ad-ldap-dns
enabled: true
enable_dns: true
base_properties:
base_dn: "DC=corp,DC=example,DC=com"
bind_method: Anonymous
filter: sAMAccountName
dns_parameters:
source: Extracted
search_domain: corp.example.com