LDAP Policy
IntersightAn 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
Section titled “Diagram”Classes
Section titled “Classes”compute
Section titled “compute”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| intersight | Class | intersight | No |
intersight (compute)
Section titled “intersight (compute)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| organizations | List | organizations | No |
organizations (compute.intersight)
Section titled “organizations (compute.intersight)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| policies | Class | policies | No |
policies (compute.intersight.organizations)
Section titled “policies (compute.intersight.organizations)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| ldap | List | ldap | No |
ldap (compute.intersight.organizations.policies)
Section titled “ldap (compute.intersight.organizations.policies)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | Regex: ^[a-zA-Z0-9_ | Yes | |
| description | String | No | ||
| managed | Boolean | true, false | No | true |
| tags | List | tags | No | |
| enabled | Boolean | true, false | No | true |
| enable_dns | Boolean | true, false | No | false |
| user_ | Choice | LocalUserDb, LdapUserDb | No | LocalUserDb |
| base_properties | Class | base_properties | No | |
| dns_parameters | Class | dns_parameters | No | |
| providers | List | providers | No | |
| groups | List | groups | No |
tags (compute.intersight.organizations.policies.ldap)
Section titled “tags (compute.intersight.organizations.policies.ldap)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| key | String | Yes | ||
| value | String | No | ||
| type | Choice | KeyValue, PathTag | No |
base_properties (compute.intersight.organizations.policies.ldap)
Section titled “base_properties (compute.intersight.organizations.policies.ldap)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| attribute | String | No | ||
| base_dn | String | No | ||
| bind_dn | String | No | ||
| bind_method | Choice | LoginCredentials, Anonymous, ConfiguredCredentials | No | |
| domain | String | No | ||
| encryption | Boolean | true, false | No | |
| group_ | Boolean | true, false | No | |
| nested_ | Boolean | true, false | No | |
| filter | String | No | ||
| group_attribute | String | No | ||
| nested_ | Integer | min: 1, max: 128 | No | |
| password | String | No | ||
| timeout | Integer | min: 0, max: 180 | No |
dns_parameters (compute.intersight.organizations.policies.ldap)
Section titled “dns_parameters (compute.intersight.organizations.policies.ldap)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| source | Choice | Extracted, Configured, ConfiguredExtracted | No | |
| search_domain | String | No | ||
| search_forest | String | No |
providers (compute.intersight.organizations.policies.ldap)
Section titled “providers (compute.intersight.organizations.policies.ldap)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| server | String | Yes | ||
| port | Integer | min: 1, max: 65535 | No |
groups (compute.intersight.organizations.policies.ldap)
Section titled “groups (compute.intersight.organizations.policies.ldap)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | Yes | ||
| domain | String | No | ||
| role | String | No |
Examples
Section titled “Examples”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: prodExample-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