Page History
About this Resource
| Excerpt |
|---|
The Acive Directory Domain Controller resource contains settings for the domain controllers used by the Active Directory Configuration. |
REST API Methods for this Resource
- GET domaincontroller
- GET domaincontroller id
- POST domaincontroller id
- PUT domaincontroller id
- DELETE domaincontroller id
Resource Schema
Configuration
| Parameter Name | Required | Service Affecting | Data Type | Default Value | Possible Values | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Description | Yes | No | string | none | 64 - Max Length | The description of the Domain Controller that will be referenced by the Active Directory Configuration resource. | ||||||
| LDAPQuery | Yes | No | string | none | 256 - Max Length | Applies a filter to the Search Scope (defined in the Active Directory Configuration resource) to limit the number of active directory users included in the cache. | ||||||
| SearchScope | Yes | No | string | none | 256 - Max Length | Specifies the tree location in Active Directory to use at the starting point for search queries or authentication requests. | ||||||
| DomainController | Yes | No | string | none | 256 - Max Length | Specifies an IP address or Fully Qualified Domain Name (FQDN) of the Domain Controller. | ||||||
| UserName | Yes | No | string | none | 256 - Max Length | Specifies username (BindDN) to use for querying the Active Directory. | ||||||
| EncryptedPassword | Yes | No | string | none | 256 - Max Length | Specifies password (BindPW) to use for querying the Active Directory. | ||||||
| DCPriority | Yes | Yes | int | 0 | Possible values:
| Sets the priority of the DC which determines in what order AD will be queried.
| ||||||
| DCType | Yes | No | int | 0 | Possible values:
| Determines whether this DC will be used for user authentication or call routing. |
Runtime
| Parameter Name | Description | Data Type | Possible Values |
|---|---|---|---|
| rt_ADStatus | Reports the up/down state of the Domain Controller. | Enum | Possible values:
|
| rt_CacheStatus | Reports the current cache status of the Domain Controller | Enum | Possible values:
|
| rt_BackupStatus | Reports the current backup status of the Domain Controller. | Enum | Possible values:
|
Overview
Content Tools