2.2.4.123 IPUtilization

  • Article

The IPUtilization complex type is used to specify the address utilization data for a specific time range.

 <xs:complexType name="IPUtilization">
   <xs:complexContent mixed="false">
     <xs:extension base="ipam:IpamObject">
       <xs:sequence>
         <xs:element minOccurs="0" name="EndTime" nillable="true" type="xsd:dateTime" />
         <xs:element minOccurs="0" name="IsValid" type="xsd:boolean" />
         <xs:element minOccurs="0" name="StartTime" nillable="true" type="xsd:dateTime" />
         <xs:element minOccurs="0" name="TotalAssignedAddresses" type="xsd:double" />
         <xs:element minOccurs="0" name="TotalAvailableAddresses" type="xsd:double" />
         <xs:element minOccurs="0" name="TotalUtilizedAddresses" type="xsd:double" />
       </xs:sequence>
     </xs:extension>
   </xs:complexContent>
 </xs:complexType>

EndTime: This specifies the end time of the time period for which the IPUtilization specifies the address utilization.

IsValid: This specifies whether the address utilization data is valid or not.

StartTime: This specifies the start time of the time period for which the IPUtilization specifies the address utilization.

TotalAssignedAddresses: This defines the number of addresses that is assigned from an IP address space. Typically this is based on the start and end address for an IP addresses space. In case of an IP address space being an IP address range, then the available addresses is the same as assigned addresses. In case of an IP address space being an IP address block, then the assigned addresses will be based on the volume of IP address ranges that is mapped under the IP address block.

TotalAvailableAddresses: This defines the available number of addresses in an IP address space. Typically this is based on the start and end address for an IP addresses space.

TotalUtilizedAddresses: This defines the number of addresses that is utilized from the assigned pool of IP address space. Typically the utilized count of IP address space will be based on the number of addresses that is either reserved in IPAM (in case of address assignment type being AddressAssignment.Static) or allocated to the network (in case of address assignment type being AddressAssignment.Dynamic).