Share via

3.4.4.3 GetADDomainController

  • Article

A server processes a GetADDomainController request using the Active Directory Web Services: Custom Action Protocol upon receiving a SOAP message that contains the GetADDomainController SOAP header and that specifies the following URI as the SOAP action:

http://schemas.microsoft.com/2008/1/ActiveDirectory/CustomActions/TopologyManagement/GetADDomainController

This operation is specified by the following WSDL.

 <wsdl:operation name="GetADDomainController">
   <wsdl:input
       wsam:Action=
 "http://schemas.microsoft.com/2008/1/ActiveDirectory/CustomActions/TopologyManagement/GetADDomainController"
       name="GetADDomainControllerRequest"
       message="ca:GetADDomainControllerRequest" />
   <wsdl:output
       wsam:Action=
 "http://schemas.microsoft.com/2008/1/ActiveDirectory/CustomActions/TopologyManagement/GetADDomainControllerResponse"
       name="GetADDomainControllerResponse"
       message="ca:GetADDomainControllerResponse" />
   <wsdl:fault
       wsam:Action="http://schemas.microsoft.com/2008/1/ActiveDirectory/Data/fault"
       name="GetADDomainControllerFault"
       message=
 "ca:TopologyManagement_GetADDomainController_GetADDomainControllerFault_FaultMessage" />
 </wsdl:operation>

The GetADDomainController custom action retrieves information for the domain controllers in the domain that contain the directory service specified in the GetADDomainControllersRequest (section 3.4.4.3.1.1) SOAP header Server (section 2.2.3.5) element. If the Server element specifies an AD LDS instance, then the server MUST return a fault, as specified in section 3.4.4.3.8.1. Upon success, the server MUST return a GetADDomainControllerResponse (section 3.4.4.3.2.4)) element with the GetADDomainControllerResponse/DomainControllers (section 3.4.4.3.2.5) element (including child elements) filled in.

Upon receiving a GetADDomainControllerRequest message, the GetADDomainController custom action retrieves information on all domain controllers in the domain as specified by the input array of distinguished names of nTDSDSA objects (see [MS-ADTS] section 6.1.1.2.2.1.2.1.1) in the GetADDomainControllerRequest/NtdsSettingsDN (section 3.4.4.3.2.3) element.

For every domain controller represented by the GetADDomainControllerRequest/NtdsSettingsDN array, the GetADDomainController custom action constructs an ActiveDirectoryDomainController (section 3.4.4.3.3.2) object (with all its elements populated) and adds it to the GetADDomainControllerResponse/DomainControllers array. When complete, the GetADDomainControllerResponse element MUST be returned.

The number and order of ActiveDirectoryDomainController elements in the GetADDomainControllerResponse/DomainControllers array MUST match the number and order of GetADDomainControllerRequest/NtdsSettingsDN elements specified in the request.

If an error occurs while processing this operation, the server MUST return the appropriate SOAP fault for the particular error condition as specified in section 3.4.4.3.8.