3.3.4.66 GetBlockUtilization
The GetBlockUtilization operation can be used to retrieve the address block utilization.
-
<wsdl:operation name="GetBlockUtilization"> <wsdl:input wsaw:Action="http://Microsoft.Windows.Ipam/IIpamServer/GetBlockUtilization" message="ipam:IIpamServer_GetBlockUtilization_InputMessage" /> <wsdl:output wsaw:Action="http://Microsoft.Windows.Ipam/IIpamServer/GetBlockUtilizationResponse" message="ipam:IIpamServer_GetBlockUtilization_OutputMessage" /> </wsdl:operation>
Upon receiving the IIpamServer_GetBlockUtilization_InputMessage request message, the server performs the following processing steps. Upon successful completion of the steps specified below, the server MUST respond with the IIpamServer_GetBlockUtilization_OutputMessage message. In the event of a failure, an appropriate SOAP fault MUST be sent to the client as specified in section 2.2.2.1:
If GetBlockUtilization.addressFamily is InterNetworkV6, GetBlockUtilization.requestedIPUtilizationType MUST be IPUtilizationType.Current. Otherwise return an appropriate SOAP fault.
Call GetIPBlockFromTable procedure in ADM_IPBlocksTable passing the following parameters:
GetBlockUtilization.blockRecordId is passed as Param_blockId.
GetBlockUtilization.addressFamily is passed as Param_addressfamily.
Initialize GetBlockUtilizationResponse.GetBlockUtilizationResult with IPCumulativeUtilization.
If GetBlockUtilization.requestedIPUtilizationType is IPUtilizationType.Current, copy result.UtilizationStatistics to GetBlockUtilizationResponse.GetBlockUtilizationResult.IPUtilization.
Call the procedure GetBlockUtilization in ADM_IPv4AddressBlockUtilizationTable by passing the following parameters:
Param_id is set to GetBlockUtilization.blockRecordId.
Param_addressfamily is set to GetBlockUtilization.addressFamily.
Param_utilizationType is set to the value of GetBlockUtilization.requestedIPUtilizationType.
Param_startDate is set to the value of GetBlockUtilization.startDate.
Param_endDate is set to the value of GetBlockUtilization.endDate.
Assign result.IPUtilization to GetBlockUtilizationResponse.GetBlockUtilizationResult.IPUtilization.