3.3.4.108 GetSubnetUtilization

The GetSubnetUtilization operation is used to retrieve the address block utilization.

 <wsdl:operation name="GetSubnetUtilization">
   <wsdl:input wsaw:Action="http://Microsoft.Windows.Ipam/IIpamServer/GetSubnetUtilization" message="ipam:IIpamServer_GetSubnetUtilization_InputMessage" />
   <wsdl:output wsaw:Action="http://Microsoft.Windows.Ipam/IIpamServer/GetSubnetUtilizationResponse" message="ipam:IIpamServer_GetSubnetUtilization_OutputMessage" />
 </wsdl:operation>

Upon receiving the IIpamServer_GetSubnetUtilization_InputMessage request message, the server performs the following processing steps. Upon successful completion of these steps, the server MUST respond with the IIpamServer_GetSubnetUtilization_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. Fault if GetSubnetUtilization.addressFamily is neither InterNetwork nor InterNetworkV6.

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

  3. Call GetSubnetById procedure in ADM_SubnetTable passing the following parameter.

    1. GetSubnetUtilization.id is passed as Param_SubnetId.

  4. Initialize GetSubnetUtilizationResponse.GetSubnetUtilizationResult with IPCumulativeUtilization.

  5. If GetSubnetUtilization.requestedIPUtilizationType is IPUtilizationType.Current, copy result.UtilizationStatistics to GetSubnetUtilizationResponse.GetSubnetUtilizationResult.IPUtilization.

  6. Call the procedure GetAddressBlockUtilization in ADM_IPv4AddressBlockUtilizationTable by passing the following parameters:

    1. Param_id is set to GetSubnetUtilization.id.

    2. Param_addressfamily is set to GetSubnetUtilization.addressFamily.

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

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

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

  7. Assign result.IPUtilization to GetSubnetUtilizationResponse.GetSubnetUtilizationResult.IPUtilization.