2.2.4.116 IPRange

  • Article

The IPRange complex type specifies the common information pertaining to the address range.

 <xs:complexType name="IPRange">
   <xs:complexContent mixed="false">
     <xs:extension base="ipam:BaseIpamObject">
       <xs:sequence>
         <xs:element minOccurs="0" name="AddressAssignment" type="ipam:AddressAssignment" />
         <xs:element minOccurs="0" name="AddressCategory" type="ipam:AddressCategory" />
         <xs:element minOccurs="0" name="CustomFieldValues" nillable="true" type="ipam:ArrayOfCustomFieldValue" />
         <xs:element minOccurs="0" name="DefaultGateway" nillable="true" type="sysnet:IPAddress" />
         <xs:element minOccurs="0" name="Description" nillable="true" type="xsd:string" />
         <xs:element minOccurs="0" name="DhcpScopeName" nillable="true" type="xsd:string" />
         <xs:element minOccurs="0" name="DhcpServerGuid" nillable="true" type="xsd:string" />
         <xs:element minOccurs="0" name="DhcpServerName" nillable="true" type="xsd:string" />
         <xs:element minOccurs="0" name="EndIPAddress" nillable="true" type="sysnet:IPAddress" />
         <xs:element minOccurs="0" name="ExclusionRanges" nillable="true" type="ipam:ArrayOfDhcpExclusionRange" />
         <xs:element minOccurs="0" name="ParentIPBlockRecordId" nillable="true" type="xsd:long" />
         <xs:element minOccurs="0" name="IsOverlapping" type="xsd:boolean" />
         <xs:element minOccurs="0" name="LastAssignedDate" nillable="true" type="xsd:dateTime" />
         <xs:element minOccurs="0" name="LastChangeDate" nillable="true" type="xsd:dateTime" />
         <xs:element minOccurs="0" name="LastReclaimRuntime" nillable="true" type="xsd:dateTime" />
         <xs:element minOccurs="0" name="NumberofChildAddresses" type="xsd:int" />
         <xs:element minOccurs="0" name="Owner" nillable="true" type="xsd:string" />
         <xs:element minOccurs="0" name="PartialCustomFieldValues" nillable="true" type="ipam:ArrayOfCustomFieldPartialValue" />
         <xs:element minOccurs="0" name="PrefixLength" type="xsd:int" />
         <xs:element minOccurs="0" name="RecordId" nillable="true" type="xsd:long" />
         <xs:element minOccurs="0" name="ScopeRecordId" nillable="true" type="xsd:long" />
         <xs:element minOccurs="0" name="StartIPAddress" nillable="true" type="sysnet:IPAddress" />
         <xs:element minOccurs="0" name="SubnetId" nillable="true" type="sysnet:IPAddress" />
         <xs:element minOccurs="0" name="SubnetMask" nillable="true" type="sysnet:IPAddress" />
         <xs:element minOccurs="0" name="UtilizationCalculationType" type="ipam:IPUtilizationCalculationType" />
         <xs:element minOccurs="0" name="UtilizationEventLogStatus" type="ipam:UtilizationStatus" />
         <xs:element minOccurs="0" name="UtilizationStatistics" nillable="true" type="ipam:IPUtilization" />
       </xs:sequence>
     </xs:extension>
   </xs:complexContent>
 </xs:complexType>

AddressAssignment: This specifies the type of address assignment associated with the address range.

AddressCategory: This specifies the address category to which the address range belongs to.

CustomFieldValues: This specifies the list of custom field values associated with the address range.

Description: This specifies the description for the address range.

DefaultGateway: This specifies the address of the default gateway that is mapped to this address range.

EndIPAddress: This specifies the end address of the address range.

ParentIPBlockRecordId: If the address range is mapped to an address block, this specifies the RecordId of the associated address block. Otherwise this will not be set.

IsOverlapping: This specifies whether there are other address ranges that overlap with this address range.

LastAssignedDate: This specifies the date when the address range was used last to assign addresses from.

LastChangeDate: This specifies the date when the last change was made to the address range.

LastReclaimRuntime: This specifies the time at which the addresses mapping to this address range have been reclaimed.

NumberofChildAddresses: This specifies the number of child addresses that are mapping to the specific address range.

Owner: This specifies the owner of the address range. The length of this field MUST NOT be greater than 100.

PartialCustomFieldValues: This specifies the custom field values in the form of a collection of CustomFieldPartialValue. The management server will use this to pass the custom field values during the enumeration operations. This MUST NOT be used by the management client to pass custom field values. The management client MUST instead use CustomFieldValues to perform the required processing.

PrefixLength: This specifies the prefix length for the address range.

RecordId: This specifies the unique identifier for the data in the IPAM data store.

StartIPAddress: This specifies the start IP address of the address range.

UtilizationCalculationType: This specifies the type of utilization calculation type to be used.

UtilizationEventLogStatus: This specifies the current utilization status of the address range.

UtilizationStatistics: This specifies the utilization statistics information associated with the address range.

If the address assignment type is Dynamic or Auto, the address range will have an associated DHCP scope instance. From the DHCP scope information, the following data are computed.

DhcpScopeName: This specifies the name of the DHCP scope associated with the address range.

DhcpServerGuid: This specifies the GUID of the server having the scope instance associated with the address range.

DhcpServerName: This specifies the name of the server having the scope instance associated with the address range.

ExclusionRanges: This specifies the list of exclusion ranges that are associated with the scope corresponding to the address range.

ScopeRecordId: This specifies the RecordId of the scope associated with the address range.

SubnetId: This specifies the subnet ID of the DHCP scope associated with the address range.

SubnetMask: This specifies the subnet mask corresponding to the prefix length   of the address range.