2.2.5.8 CommonProperties

The CommonProperties simple type is an enumeration that specifies the identifier for all the common IPAM server properties.

 <xs:simpleType name="CommonProperties">
   <xs:restriction base="xsd:string">
     <xs:enumeration value="None" />
     <xs:enumeration value="MaximumUtilizationThreshold" />
     <xs:enumeration value="MinimumUtilizationThreshold" />
     <xs:enumeration value="LastAddressUtilizationCollectionTaskRuntime" />
     <xs:enumeration value="GpoPrefix">
       <xs:annotation>
         <xs:appinfo>
           <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">5</EnumerationValue>
         </xs:appinfo>
       </xs:annotation>
     </xs:enumeration>
     <xs:enumeration value="DeploymentType">
       <xs:annotation>
         <xs:appinfo>
           <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">6</EnumerationValue>
         </xs:appinfo>
       </xs:annotation>
     </xs:enumeration>
     <xs:enumeration value="ExpiryAlertThreshold">
       <xs:annotation>
         <xs:appinfo>
           <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">8</EnumerationValue>
         </xs:appinfo>
       </xs:annotation>
     </xs:enumeration>
     <xs:enumeration value="IpamExpiryLoggingPeriodicity">
       <xs:annotation>
         <xs:appinfo>
           <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">9</EnumerationValue>
         </xs:appinfo>
       </xs:annotation>
     </xs:enumeration>
     <xs:enumeration value="IpamSecurityGroupIpamUsers">
       <xs:annotation>
         <xs:appinfo>
           <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">10</EnumerationValue>
         </xs:appinfo>
       </xs:annotation>
     </xs:enumeration>
     <xs:enumeration value="IpamSecurityGroupIpamAdministrators">
       <xs:annotation>
         <xs:appinfo>
           <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">11</EnumerationValue>
         </xs:appinfo>
       </xs:annotation>
     </xs:enumeration>
     <xs:enumeration value="IpamSecurityGroupIpamAsmAdministrators">
       <xs:annotation>
         <xs:appinfo>
           <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">12</EnumerationValue>
         </xs:appinfo>
       </xs:annotation>
     </xs:enumeration>
     <xs:enumeration value="IpamSecurityGroupIpamMsmAdministrators">
       <xs:annotation>
         <xs:appinfo>
           <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">13</EnumerationValue>
         </xs:appinfo>
       </xs:annotation>
     </xs:enumeration>
     <xs:enumeration value="IpamSecurityGroupIpamIPAuditAdministrators">
       <xs:annotation>
         <xs:appinfo>
           <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">14</EnumerationValue>
         </xs:appinfo>
       </xs:annotation>
     </xs:enumeration>
     <xs:enumeration value="IpamConfiguredDate">
       <xs:annotation>
         <xs:appinfo>
           <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">26</EnumerationValue>
         </xs:appinfo>
       </xs:annotation>
     </xs:enumeration>
     <xs:enumeration value="LastPurgeAuditResult">
       <xs:annotation>
         <xs:appinfo>
           <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">27</EnumerationValue>
         </xs:appinfo>
       </xs:annotation>
     </xs:enumeration>
     <xs:enumeration value="IPAuditTracking">
       <xs:annotation>
         <xs:appinfo>
           <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">28</EnumerationValue>
         </xs:appinfo>
       </xs:annotation>
     </xs:enumeration>
         <xs:enumeration value="LastUtilizationPurgeResult">
       <xs:annotation>
         <xs:appinfo>
           <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">29</EnumerationValue>
         </xs:appinfo>
       </xs:annotation>
     </xs:enumeration>
     <xs:enumeration value="RowCountOnFirstFetch">
       <xs:annotation>
         <xs:appinfo>
           <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">30</EnumerationValue>
         </xs:appinfo>
       </xs:annotation>
     </xs:enumeration>
   </xs:restriction>
 </xs:simpleType>

The following table specifies the valid values for this type.

Value

Description

None

Unspecified or an invalid value.

MaximumUtilizationThreshold

The percentage utilization threshold above which a utilization value is deemed to be over-utilized.

MinimumUtilizationThreshold

The percentage utilization threshold below which a utilization value is deemed to be underutilized.

LastAddressUtilizationCollectionTaskRuntime

The last runtime of the address utilization. 

GpoPrefix

The prefix of the group policy object-names that will be used by the IPAM server to enable automatic provisioning of the access settings on the managed servers.

DeploymentType

This specifies whether the IPAM server is provisioned for Automatic, Manual, or None provisioning model.

ExpiryAlertThreshold

The number of days before expiry during which an IP address state will be marked to be due for address expiry.

IpamExpiryLoggingPeriodicity

The frequency at which the address expiry IPAM task has to log the 'Expiry Due' and 'Expired' events.

IpamSecurityGroupIpamUsers

The name of IPAM security group 'IPAM Users' in the IPAM server system language.

IpamSecurityGroupIpamAdministrators

The name of IPAM security group 'IPAM Administrators' in the IPAM server system language.

IpamSecurityGroupIpamAsmAdministrators

The name of IPAM security group 'IPAM ASM Administrators' in the IPAM server system language.

IpamSecurityGroupIpamMsmAdministrators

The name of IPAM security group 'IPAM MSM Administrators' in the IPAM server system language.

IpamSecurityGroupIpamIPAuditAdministrators

The name of IPAM security group 'IPAM IP Audit Administrators' in the IPAM server system language.

IpamConfiguredDate

The date on which the IPAM server was provisioned.

LastPurgeAuditResult

The result of the last audit log purge operation.

IPAuditTracking

Optional IPAM capability which allows tracking of IP addresses using DHCP lease events and user logon events collected from  Network Policy Server (NPS) , domain controllers, and DHCP servers.

LastUtilizationPurgeResult

The result of the last utilization purge operation.

RowCountOnFirstFetch

Represents the number of rows that will be fetched on the first fetch by the IPAM Server.