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:

  1. If GetBlockUtilization.addressFamily is InterNetworkV6, GetBlockUtilization.requestedIPUtilizationType MUST be IPUtilizationType.Current. Otherwise return an appropriate SOAP fault.

  2. Call GetIPBlockFromTable procedure in ADM_IPBlocksTable passing the following parameters:

    1. GetBlockUtilization.blockRecordId is passed as Param_blockId.

    2. GetBlockUtilization.addressFamily is passed as Param_addressfamily.

  3. Initialize GetBlockUtilizationResponse.GetBlockUtilizationResult with IPCumulativeUtilization.

  4. If GetBlockUtilization.requestedIPUtilizationType is IPUtilizationType.Current, copy result.UtilizationStatistics to GetBlockUtilizationResponse.GetBlockUtilizationResult.IPUtilization.

  5. Call the procedure GetBlockUtilization in ADM_IPv4AddressBlockUtilizationTable by passing the following parameters:

    1. Param_id is set to GetBlockUtilization.blockRecordId.

    2. Param_addressfamily is set to GetBlockUtilization.addressFamily.

    3. Param_utilizationType is set to the value of GetBlockUtilization.requestedIPUtilizationType.

    4. Param_startDate is set to the value of GetBlockUtilization.startDate.

    5. Param_endDate is set to the value of GetBlockUtilization.endDate.

  6. Assign result.IPUtilization to GetBlockUtilizationResponse.GetBlockUtilizationResult.IPUtilization.