2.2.4.301 IPRange

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="AccessScopeId" type="xsd:long" />
         <xs:element minOccurs="0" name="AddressAssignment" type="ipam:AddressAssignment" />
         <xs:element minOccurs="0" name="AddressCategory" type="ipam:AddressCategory" />
         <xs:element minOccurs="0" name="AddressSpaceRecordId" type="xsd:long" />
         <xs:element minOccurs="0" name="ConnectionSpecificDNSSuffix" nillable="true" type="xsd:string" />
         <xs:element minOccurs="0" name="CustomFieldValues" nillable="true" type="ipam:ArrayOfCustomFieldValue" />
         <xs:element minOccurs="0" name="CustomerAddressSpaceName" nillable="true" type="xsd:string" />
         <xs:element minOccurs="0" name="DNSServers" nillable="true" type="serarr:ArrayOfstring" />
         <xs:element minOccurs="0" name="DNSSuffixes" nillable="true" type="serarr:ArrayOfstring" />
         <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="Gateways" nillable="true" type="ipam:ArrayOfGatewayAddress" />
         <xs:element minOccurs="0" name="IsInheritedAccessScope" type="xsd:boolean" />
         <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="MappedReverseLookupZone" nillable="true" type="xsd:string" />
         <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="ParentIPBlockRecordId" nillable="true" type="xsd:long" />
         <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="ProviderAddressSpaceName" nillable="true" type="xsd:string" />
         <xs:element minOccurs="0" name="RangeOverlapState" type="ipam:IPRangeOverlap" />
         <xs:element minOccurs="0" name="RecordId" nillable="true" type="xsd:long" />
         <xs:element minOccurs="0" name="ReservedIPRanges" nillable="true" type="sys:ArrayOfTupleOfstringstring" />
         <xs:element minOccurs="0" name="ReservedIPs" nillable="true" type="serarr:ArrayOfstring" />
         <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="UseForUtilization" type="xsd:boolean" />
         <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:element minOccurs="0" name="VIPRanges" nillable="true" type="sys:ArrayOfTupleOfstringstring" />
         <xs:element minOccurs="0" name="VIPs" nillable="true" type="serarr:ArrayOfstring" />
         <xs:element minOccurs="0" name="VirtualizationType" type="ipam:IPVirtualizationType" />
       </xs:sequence>
     </xs:extension>
   </xs:complexContent>
 </xs:complexType>

AccessScopeId:  Specifies the Record identifier for the access scope object to which this range maps.

AddressAssignment:  Specifies the type of address assignment associated with the address range.

AddressCategory:  Specifies the address category to which the address range belongs to.

AddressSpaceRecordId: Specifies the Record identifier for the address space to which this range maps.

ConnectionSpecificDNSSuffix:  Specifies a connection specific DNS suffix associated with a scope that is stored as a range in IPAM.

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

CustomerAddressSpaceName:  Specifies the name of the Customer address space associated with this range.

Description:  Specifies the description for the address range.

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

EndIPAddress:  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:  Specifies whether there are other address ranges that overlap with this address range.

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

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

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

MappedReverseLookupZone: Specifies the unique identifiers of the reverse lookup zone mapped to the IP range.

NumberOfChildAddresses:  Specifies the number of child addresses that are mapping to the specific address range.

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

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

PrefixLength:  Specifies the prefix length for the address range.

ProviderAddressSpaceName: Specifies the name of the provider address space to which the IP range is associated.

RecordId:  Specifies the unique identifier for the data in the IPAM data store.

RangeOverlapState: Specifies whether an IP address range overlaps with another IP address range.

StartIPAddress:  Specifies the start IP address of the address range.

UtilizationCalculationType:  Specifies the type of utilization calculation type to be used.

UtilizationEventLogStatus: Specifies the current utilization status of the address range.

UtilizationStatistics:  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:  Specifies the name of the DHCP scope associated with the address range.

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

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

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

ScopeRecordId:  Specifies the RecordId of the scope associated with the address range.

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

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

DNSServers:  Specifies a list of DNS servers associated with the scope that is represented as a range in IPAM.

DNSSuffixes:  Specifies a list of DNS suffixes associated with the scope that is represented as a range in IPAM.

Gateways:  Specifies a list of gateway servers associated with the scope that is represented as a range in IPAM.

IsInheritedAccessScope:  Specifies whether this block inherits access scope from its parent subnet.

ReservedIPRanges:  Specifies a list of reserved IP ranges associated with the scope that is represented as a range in IPAM.

ReservedIPs:  Specifies a list of reserved IP addresses associated with the scope that is represented as a range in IPAM.

VIPRanges: Specifies the associated Virtual IP Ranges.

VIPs: Specifies the associated Virtual IP Address.

VirtualizationType: Specifies whether the given range is a range mapping to a virtual network or a nonvirtual network.

UseForUtilization:  Specifies whether this range, of all the conflicting ranges, is used for calculating the utilization of the parent subnet.