2.2.4.257 IpamIPAddress

The IpamIPAddress complex type specifies the common address object information in the IPAM data store.

 <xs:complexType name="IpamIPAddress">
   <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="Address" nillable="true" type="sysnet:IPAddress" />
         <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="AssetTag" nillable="true" type="xsd:string" />
         <xs:element minOccurs="0" name="AssignedDate" nillable="true" type="xsd:dateTime" />
         <xs:element minOccurs="0" name="ChangedDate" nillable="true" type="xsd:dateTime" />
         <xs:element minOccurs="0" name="CreatedFromDnsResourceRecord" type="xsd:boolean" />
         <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="DeviceName" nillable="true" type="xsd:string" />
         <xs:element minOccurs="0" name="DhcpScopeDescription" nillable="true" type="sysnet:IPAddress" />
         <xs:element minOccurs="0" name="DhcpScopeId" nillable="true" type="xsd:long" />
         <xs:element minOccurs="0" name="DhcpScopeName" nillable="true" type="xsd:string" />
         <xs:element minOccurs="0" name="DhcpScopeSubnetId" nillable="true" type="sysnet:IPAddress" />
         <xs:element minOccurs="0" name="DnsForwardLookupZoneDnsServerId" nillable="true" type="xsd:long" />
         <xs:element minOccurs="0" name="DnsForwardLookupZoneServerName" nillable="true" type="xsd:string" />
         <xs:element minOccurs="0" name="DnsForwardSyncStatus" type="ipam:DnsSyncStatus" />
         <xs:element minOccurs="0" name="DnsReverseLookupZoneDnsServerId" nillable="true" type="xsd:long" />
         <xs:element minOccurs="0" name="DnsReverseLookupZoneId" nillable="true" type="xsd:long" />
         <xs:element minOccurs="0" name="DnsReverseLookupZoneName" nillable="true" type="xsd:string" />
         <xs:element minOccurs="0" name="DnsReverseLookupZonePrefix" nillable="true" type="xsd:int" />
         <xs:element minOccurs="0" name="DnsReverseLookupZoneServerName" nillable="true" type="xsd:string" />
         <xs:element minOccurs="0" name="DnsReverseSyncStatus" type="ipam:DnsSyncStatus" />
         <xs:element minOccurs="0" name="DnsZoneId" nillable="true" type="xsd:long" />
         <xs:element minOccurs="0" name="DnsZoneName" nillable="true" type="xsd:string" />
         <xs:element minOccurs="0" name="ExpiryAndAlertEventLoggingStatus" type="ipam:IPAddressExpiryStatus" />
         <xs:element minOccurs="0" name="ExpiryDate" nillable="true" type="xsd:dateTime" />
         <xs:element minOccurs="0" name="InWarningPeriod" type="xsd:boolean" />
         <xs:element minOccurs="0" name="IsDuplicate" type="xsd:boolean" />
         <xs:element minOccurs="0" name="IsExpired" type="xsd:boolean" />
         <xs:element minOccurs="0" name="MacAddress" nillable="true" type="ipam:MACAddress" />
         <xs:element minOccurs="0" name="Notes" nillable="true" type="xsd:string" />
         <xs:element minOccurs="0" name="OSName" nillable="true" type="xsd:string" />
         <xs:element minOccurs="0" name="OSVersion" nillable="true" type="xsd:string" />
         <xs:element minOccurs="0" name="Owner" nillable="true" type="xsd:string" />
         <xs:element minOccurs="0" name="ParentIPRangeEndIP" nillable="true" type="sysnet:IPAddress" />
         <xs:element minOccurs="0" name="ParentIPRangeRecordId" nillable="true" type="xsd:long" />
         <xs:element minOccurs="0" name="ParentIPRangeStartIP" nillable="true" type="sysnet:IPAddress" />
         <xs:element minOccurs="0" name="PartialCustomFieldValues" nillable="true" type="ipam:ArrayOfCustomFieldPartialValue" />
         <xs:element minOccurs="0" name="ProviderAddressSpaceName" nillable="true" type="xsd:string" />
         <xs:element minOccurs="0" name="RecordId" nillable="true" type="xsd:long" />
         <xs:element minOccurs="0" name="ReservationDescription" nillable="true" type="xsd:string" />
         <xs:element minOccurs="0" name="ReservationName" nillable="true" type="xsd:string" />
         <xs:element minOccurs="0" name="ReservationRecordId" nillable="true" type="xsd:long" />
         <xs:element minOccurs="0" name="ReservationServerName" nillable="true" type="xsd:string" />
         <xs:element minOccurs="0" name="ReservationSyncStatus" type="ipam:DhcpReservationSyncStatus" />
         <xs:element minOccurs="0" name="SerialNumber" nillable="true" type="xsd:string" />
         <xs:element minOccurs="0" name="VirtualizationType" type="ipam:IPVirtualizationType" />
       </xs:sequence>
     </xs:extension>
   </xs:complexContent>
 </xs:complexType>
  

AccessScopeId:  This specifies the RecordId for the access scope object to which this address maps.

AddressAssignment:  This specifies the address assignment type specific to the IpamIPAddress.

AddressCategory: This specifies the category of the IP address space to which the address belongs.

AddressSpaceRecordId:  This specifies the RecordId for the address space to which this address maps to.

AssetTag: This specifies the asset tag of the device to which the address is assigned.

AssignedDate:  This specifies the date on which the address was assigned to a device.

ChangedDate: This specifies the date on which the address instance was modified last.

CreatedFromDnsResourceRecord:  This specifies that the IP address was created from DNS resource record.

CustomFieldValues: This specifies the collection of CustomFieldValue complex types (section 2.2.4.85) that specify the custom field values associated with the address instance.

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

DeviceName: This specifies the device name to which the address has been assigned.

ExpiryAndAlertEventLoggingStatus: This specifies the current status of the address instance with regard to address expiration.

ExpiryDate: This specifies the expiration date of the address.

InWarningPeriod: This specifies whether the address is in a warning period but has not expired yet.

Address: This specifies the IP address of the instance.

IsDuplicate: This specifies whether the address instance is a duplicate or not.

IsExpired:  This specifies whether the address instance has already expired or not.

MacAddress: This specifies the MAC address of the device to which the address instance is assigned and associated with. This MUST be specified if a DHCP reservation has to be created for the address. Otherwise the field is optional.

Notes: This specifies any additional notes for the address instance.

OSName: This specifies the name of the operating system that is hosting the specific address instance.

OSVersion: This specifies the version of the operating system that is hosting the specific address instance.

Owner: This specifies the admin-specified owner for the address instance.

ParentIPRangeEndIP: This specifies the end address of the address range to which the address instance maps.

ParentIPRangeRecordId: This specifies the RecordId of the address range to which the address instance maps.

ParentIPRangeStartIP: This specifies the start address of the address range to which the address instance maps.

PartialCustomFieldValues: This specifies the collection of CustomFieldPartialValues (section 2.2.4.84) that specify the custom field values to the management client as a part of enumeration operations. The management client MUST NOT use this to specify the custom field values as a part of add or edit operations, but rather use the CustomFieldValues field to specify the same.

ProviderAddressSpaceName:  Specifies the name of the provider address space associated with this address. The value is Default if this is a nonvirtualized address space.

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

SerialNumber:  Specifies the serial number of the device to which the address is assigned.

The next set of properties is applicable only when AddressAssignment is Dynamic; that is, a DHCP scope is associated with the address range to which the address instance maps.

DhcpScopeDescription: This specifies the subnet ID of the scope to which the address instance maps.

DhcpScopeId: This specifies the RecordId of the DHCP scope to which the address belongs. This is applicable only when AddressAssignment is Dynamic and the address maps to an address range specific to a DHCP scope instance.

DhcpScopeName:  This specifies the name of the DHCP scope to which the address maps.

DhcpScopeSubnetId:  This specifies the subnet ID of the DHCP scope to which the address maps.

The next set of properties is applicable only when the address has been registered with the DNS server for A/AAA and PTR records.

DnsForwardLookupZoneDnsServerId: This specifies the RecordId of the DNS server forward lookup DNS zone hosting information. This is applicable only when the address has been registered with forward lookup DNS zone.

DnsForwardLookupZoneServerName: This specifies the name of the server hosting the forward lookup DNS zone to which the address instance has been registered.

DnsForwardSyncStatus: This specifies the current status of the DNS registration of the IP address instance.

DnsReverseLookupZoneDnsServerId:  This specifies the RecordId of the server hosting the reverse lookup DNS zone instance.

DnsReverseLookupZoneId: This specifies the RecordId of the reverse lookup DNS zone under which the address instance has been registered.

DnsReverseLookupZoneName: This specifies the name of the reverse lookup DNS zone under which the address instance has been registered.

DnsReverseLookupZonePrefix: This specifies the prefix of the reverse lookup DNS zone under which the address instance has been registered.

DnsReverseLookupZoneServerName: This specifies the name of the server hosting the reverse lookup DNS zone against which the address instance has been registered.

DnsReverseSyncStatus: This specifies the current status of the DNS registration of the IP address instance under the reverse lookup DNS zone.

DnsZoneId: This specifies the RecordId of the forward lookup DNS zone under which the address has been registered.

DnsZoneName: This specifies the name of the forward lookup DNS zone under which the address instance has been registered.

The next set of properties are applicable only when there is a DHCP reservation associated with the address instance.

ReservationDescription: If there is a reservation in a DHCP server instance associated with the address instance, this specifies the description of the reservation.

ReservationName:  If there is a reservation in a DHCP server instance associated with the address instance, this specifies the name of the reservation.

ReservationRecordId: If there is a reservation in a DHCP server instance associated with the address instance, this specifies the RecordId of the reservation.

ReservationServerName: If there is a reservation in a DHCP server instance associated with the address instance, this specifies the name of the DHCP server instance.

ReservationSyncStatus:  This specifies the current status of the DHCP reservation status.

VirtualizationType:  Specifies the virtualization type of the given address. It can be NonVirtualized, Fabric, and Virtual.