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:
Fault if GetSubnetUtilization.addressFamily is neither InterNetwork nor InterNetworkV6.
If GetSubnetUtilization.addressFamily is InterNetworkV6, GetSubnetUtilization.requestedIPUtilizationType MUST be IPUtilizationType.Current. Otherwise, return an appropriate SOAP fault.
Call GetSubnetById procedure in ADM_SubnetTable passing the following parameter.
GetSubnetUtilization.id is passed as Param_SubnetId.
Initialize GetSubnetUtilizationResponse.GetSubnetUtilizationResult with IPCumulativeUtilization.
If GetSubnetUtilization.requestedIPUtilizationType is IPUtilizationType.Current, copy result.UtilizationStatistics to GetSubnetUtilizationResponse.GetSubnetUtilizationResult.IPUtilization.
Call the procedure GetAddressBlockUtilization in ADM_IPv4AddressBlockUtilizationTable by passing the following parameters:
Param_id is set to GetSubnetUtilization.id.
Param_addressfamily is set to GetSubnetUtilization.addressFamily.
Param_utilizationType is set to the value of GetSubnetUtilization.requestedIPUtilizationType.
Param_startDate is set to the value of GetSubnetUtilization.startDate.
Param_endDate is set to the value of GetSubnetUtilization.endDate.
Assign result.IPUtilization to GetSubnetUtilizationResponse.GetSubnetUtilizationResult.IPUtilization.