2.2.4.7 AddressSpace

The AddressSpace complex type is a set of connected networks that are reachable (routable) from one another form an address space. In IPAM, all IP blocks, subnets, ranges and IP addresses that belong to such a set of networks are grouped together within an address space container. To support network virtualization, IPAM provides two types of address spaces: Provider and Customer. All IPAM entities reside in a built-in address space called the DefaultIPAddressSpace. Any conventional (nonvirtualized) network entity such as a subnet or IP address range are in the default address space.

 <xs:complexType name="AddressSpace">
   <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="AddressSpaceType" type="ipam:IPAddressSpaceType" />
         <xs:element minOccurs="0" name="CustomFieldValues" nillable="true" type="ipam:ArrayOfCustomFieldValue" />
         <xs:element minOccurs="0" name="Description" nillable="true" type="xsd:string" />
         <xs:element minOccurs="0" name="IPv4UtilizationStatistics" nillable="true" type="ipam:IPv4Utilization" />
         <xs:element minOccurs="0" name="IPv6UtilizationStatistics" nillable="true" type="ipam:IPv6Utilization" />
         <xs:element minOccurs="0" name="IsInheritedAccessScope" type="xsd:boolean" />
         <xs:element minOccurs="0" name="Name" nillable="true" type="xsd:string" />
         <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="RecordId" nillable="true" type="xsd:long" />
       </xs:sequence>
     </xs:extension>
   </xs:complexContent>
 </xs:complexType>

AccessScopeId:  Identifies the access scope that is associated with this address space.

AddressSpaceType:  Specifies whether the address space is a Provider or Customer. The Provider address space encapsulates entities that host the provider's infrastructure while the Customer address space encapsulates entities defined for tenant machines. This MUST NOT be NULL.

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

Description:  Specifies the description for the address space.

IPv4UtilizationStatistics:  Specifies the utilization statistics of the IPv4 subnets that map to this address space.

IPv6UtilizationStatistics:  Specifies the utilization statistics of the IPv6 subnets that map to this address space.

IsInheritedAccessScope:  Specifies whether the given address space inherits its access scope from another object.

Name:  Specifies the name for the address space.

Owner:  Specifies the owner for the address space. The length of the string MUST NOT exceed 100 characters.

PartialCustomFieldValues:  Specifies the custom field values associated with the address space in the form of a collection of CustomFieldPartialValue (section 2.2.4.84). The management client MUST NOT use this for specifying the custom field values but rather use the CustomFieldValues property. The management server uses this to send across the custom field values as a part of enumeration processing.

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