3.4.4.4 GetADForest

  • Article

A server processes a GetADForest request using the Active Directory Web Services: Custom Action Protocol upon receiving a SOAP message containing the GetADForest SOAP header and specifying the following URI as the SOAP action:

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

This operation is specified by the following WSDL.

 <wsdl:operation name="GetADForest">
   <wsdl:input
     wsam:Action=
 "http://schemas.microsoft.com/2008/1/ActiveDirectory/CustomActions/TopologyManagement/GetADForest"
     name="GetADForestRequest"
     message="ca:GetADForestRequest" />
   <wsdl:output
     wsam:Action=
 "http://schemas.microsoft.com/2008/1/ActiveDirectory/CustomActions/TopologyManagement/GetADForestResponse"
     name="GetADForestResponse"
     message="ca:GetADForestResponse" />
   <wsdl:fault
     wsam:Action="http://schemas.microsoft.com/2008/1/ActiveDirectory/Data/fault"
     name="GetADForestFault"
     message="ca:TopologyManagement_GetADForest_GetADForestFault_FaultMessage" />
 </wsdl:operation>

The GetADForest custom action retrieves information for the forest that contains the directory service specified in the GetADForestRequest 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.4.8.1. Upon success, the server MUST return a GetADForestResponse (section 3.4.4.4.2.3) with the GetADForestResponse/Forest (section 3.4.4.4.2.4) element (including child elements) filled in.

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.4.8.