3.3.4.73 GetDhcpReservationOptions
The GetDhcpReservationOptions operation is used to retrieve the option definition and value configured corresponding to a given IPv4 or IPv6 reservation.
-
<wsdl:operation name="GetDhcpReservationOptions" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"> <wsdl:input wsaw:Action="http://Microsoft.Windows.Ipam/IIpamServer/GetDhcpReservationOptions" message="ipam:IIpamServer_GetDhcpReservationOptions_InputMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl" /> <wsdl:output wsaw:Action="http://Microsoft.Windows.Ipam/IIpamServer/GetDhcpReservationOptionsResponse" message="ipam:IIpamServer_GetDhcpReservationOptions_OutputMessage" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl" /> </wsdl:operation>
Upon receiving the IIpamServer_GetDhcpReservationOptions_InputMessage request message, the server performs the following processing steps. Upon successful completion of these steps, the server MUST respond with the IIpamServer_GetDhcpReservationOptions_OutputMessage message. In the event of a failure, a SOAP fault MUST be sent to the client as specified in section 2.2.2.1:
If the following condition is not satisfied, an appropriate SOAP fault MUST be generated.
GetDhcpReservationOptions.Reservation is NULL.
Initialize temp data store Result_options with a collection of DhcpOption.
Enumerate the rows in ADM_DhcpOptionsTable meeting the following criteria.
ReservationId is equal to GetDhcpReservationOptions.Reservation.RecordId.
For each of the rows, perform the following steps:
If the GetDhcpReservationOptions.Reservation.addressfamily is InterNetwork, create an instance of DhcpOptionV4. Otherwise, if the Param_addressfamily is InterNetworkV6, create an instance of DhcpOptionV6, and add it to Result_options. Fill the values as follows:
Assign OptionReferenceType to DhcpOption.OptionOwnerType.
Assign RecordId to DhcpOption.RecordId.
Call the procedure GetUserClassFromServer in ADM_DHCPServersTable passing the following parameters:
Param_addressfamily.
Param_serverRecordId is set to ServerRecordId.
Param_userClassRecordId is set to UserClassRecordId.
Assign the Result_userClass to DhcpOption.UserClass.
Call the procedure GetOptionDefinitionFromServer in ADM_DHCPServersTable passing the following parameters:
Param_addressfamily.
Param_serverRecordId is set to ServerRecordId.
Param_optionDefinitionId is set to OptionDefinitionRecordId.
Assign the Result_optionDefinition to DhcpOption.OptionDefinition.
Based on DhcpOption.OptionDefinition.OptionType and DhcpOption.OptionDefinition.OptionCollectionType, assign Values to DhcpOption.Values by converting the binary data into the type specified by OptionType.
Set GetDhcpReservationOptionsResponse.GetDhcpReservationOptionsResult as Result_Options.