About this Resource

Modified: for 1.3.0

The Acive Directory Domain Controller resource contains settings for the domain controllers used by the Active Directory Configuration.

REST API Methods for this Resource

Resource Schema

Configuration

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
DescriptionYesNostringnone64 - Max Length The description of the Domain Controller that will be referenced by the Active Directory Configuration resource.
LDAPQueryYesNostringnone256 - 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.
SearchScopeYesNostringnone256 - Max Length Specifies the tree location in Active Directory to use at the starting point for search queries or authentication requests.
LdapTimeoutNoNoint5Possible values:
  • 5 - Minimum
  • 15 - Maximum
Controls the timeout value used when querying the domain controller. If there is no response before this timeout value has passed then the attempt will be aborted for that session. Note: this should only be changed from the default of 5 seconds if it has been determined to not be enough.
DomainControllerYesNostringnone256 - Max Length Specifies an IP address or Fully Qualified Domain Name (FQDN) of the Domain Controller.
PreferredIpVersionYesNoEnum0Possible values:
  • 0 - ePreferIPv4
  • 1 - ePreferIPv6
 Specifies whether the FQDN should be resolved into IPv4 addresses or IPv6 addresses.
UserNameYesNostringnone256 - Max Length Specifies username (BindDN) to use for querying the Active Directory.
EncryptedPasswordYesNostringnone256 - Max Length Specifies password (BindPW) to use for querying the Active Directory.
DCPriorityYesYesint0Possible values:
  • 0 - Minimum
  • 5 - Maximum
Sets the priority of the DC which determines in what order AD will be queried.

This has no affect when using the AD cache.

Each DC type (Auth and call routing) have their own set of priorities.

Priority of 0 indicates not configured. Set a valid priority.

DCTypeYesNoEnum0Possible values:
  • 0 - eDCAuth
  • 1 - eDCCallRoute
  • 2 - eDCOnPrem
Determines whether this DC will be used for user authentication, call routing or On Premise lookup.
DCRoleYesNoEnum0Possible values:
  • 0 - eADPrimary
  • 1 - eADBackup
 Indicates if this DC is intended to be a backup of another DC. If this value is set to Backup then this DC will not be queried while refreshing the AD cache or for call route lookups unless the primary DC is down. Applies to Call Route DC's only.
PrimaryDCRowYesNoint0Possible values:
  • 0 - Minimum
  • 7 - Maximum
 This option only visible if DCRole is set to Backup. Must be a valid row number of another DC which this DC is intended to be a backup to. This value automatically set to 0 if DCRole is set to Primary. Applies to Call Route DC's only.

Runtime

Parameter Name Description Data Type Possible Values
rt_ADStatus Reports the up/down state of the Domain Controller. EnumPossible values:
  • 0 - eADUp
  • 1 - eADDown
rt_CacheStatus Reports the current cache status of the Domain Controller EnumPossible values:
  • 0 - eCacheDisabled
  • 1 - eCacheBuilding
  • 2 - eCacheUpdating
  • 3 - eCacheActive
  • 4 - eCacheFailed
  • 5 - eCacheBackup
  • 6 - eCacheTruncated
  • 7 - eCacheNotApplicable
  • 8 - eCacheIncomplete
  • 9 - eCacheLoading
  • 10 - eCacheBackupTrunc
rt_BackupStatus Reports the current backup status of the Domain Controller. EnumPossible values:
  • 0 - eBackupSuccessful
  • 1 - eBackupFailed
  • 2 - eBackupDisabled
  • 3 - eBackupNotApplicable
  • 4 - eBackupTruncated
  • 5 - eBackupUpdating