2.2.4.30 ConfigurationAuditEnumerationParameters

The ConfigurationAuditEnumerationParameters complex type is used to specify the enumeration criteria for the configuration audit information.

 <xs:complexType name="ConfigurationAuditEnumerationParameters">
   <xs:complexContent mixed="false">
     <xs:extension base="ipam:EnumerationParametersBase">
       <xs:sequence>
         <xs:element minOccurs="0" name="NumberOfRecords" type="xsd:int" />
         <xs:element minOccurs="0" name="SearchCriteriaXml" nillable="true" type="xsd:string" />
       </xs:sequence>
     </xs:extension>
   </xs:complexContent>
 </xs:complexType>

NumberOfRecords: This specifies the maximum number of records to be returned to the management client.

SearchCriteriaXml: This specifies the search condition in the form of an XML string. The XML is based on the following schema.

 <?xml version="1.0" encoding="utf-8"?>
 <xs:schema id="NewDataSet" xmlns="" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
   <xs:element name="OP_AND">
     <xs:complexType>
       <xs:sequence>
         <xs:element name="OP_OR" minOccurs="0" maxOccurs="unbounded">
           <xs:complexType>
             <xs:sequence>
               <xs:element name="ConfigurationSearchNode" minOccurs="0" maxOccurs="unbounded">
                 <xs:complexType>
                   <xs:sequence>
                     <xs:element name="Name" type="xs:string" minOccurs="0" />
                     <xs:element name="Value1" type="xs:string" minOccurs="0" />
                     <xs:element name="Value2" type="xs:string" minOccurs="0" />
                     <xs:element name="Value" type="xs:string" minOccurs="0" />
                     <xs:element name="Operator" type="xs:string" minOccurs="0" />
                   </xs:sequence>
                 </xs:complexType>
               </xs:element>
             </xs:sequence>
           </xs:complexType>
         </xs:element>
         <xs:element ref="OP_AND" minOccurs="0" maxOccurs="unbounded" />
       </xs:sequence>
     </xs:complexType>
   </xs:element>
   <xs:element name="ConfigurationSearchParameters">
     <xs:complexType>
       <xs:sequence>
         <xs:element ref="OP_AND" minOccurs="0" maxOccurs="unbounded" />
       </xs:sequence>
       <xs:attribute name="type" type="xs:string" />
     </xs:complexType>
   </xs:element>
   <xs:element name="NewDataSet" msdata:IsDataSet="true" msdata:UseCurrentLocale="true">
     <xs:complexType>
       <xs:choice minOccurs="0" maxOccurs="unbounded">
         <xs:element ref="OP_AND" />
         <xs:element ref="ConfigurationSearchParameters" />
       </xs:choice>
     </xs:complexType>
   </xs:element>
 </xs:schema>

type: This is an attribute of the top-level node ConfigurationSearchParameters. This MUST be one of the following values:

  • IPAM – This specifies the configuration audit search is against the configuration change events in the IPAM data store pertaining to IPAM operations.

  • DHCP – This specifies the configuration audit search is against the configuration change events in the IPAM data store pertaining to DHCP server management operational events of the various DHCP server instances present in the IPAM data store.

OP_AND: This specifies the AND operator that is applied on the child node criteria of this element.

OP_OR: This specifies the OR operator that is applied on the child node criteria of this element.

ConfigurationSearchNode: This element can be used to specify the filter condition.

NewDataSet: This is a data set comprising of search parameters and operators that form the complete search criteria.

Name: This is the filter condition field name.

Operator: This specifies the filter operator for the filter condition. It can be one of the following values.

  • EQUALS – Equality operator

  • BETWEEN – Range comparison operator

  • CONTAINS – Partial string match operator

Value1, Value2, Value: Values for the field specified by Name to be used with the specific operator specified by Operator. Value MUST be used to specify the value for operators EQUALS and CONTAINS. Value1 and Value2 MUST be used to specify the range of values which is required for BETWEEN operator.

The various field names, their supported operators and type of value for DHCP and IPAM configuration audit search MUST be validated to be as specified in the following table. DateTime values MUST be specified as Coordinated Universal Time (UTC) in the string representation as specified by [ISO-8601].

Type

Name

Type

Operator

IPAM

EVENT_ID

Integer

EQUALS

TIME_OF_EVENT

DateTime

BETWEEN

USER_NAME

String

CONTAINS

EQUALS

USER_DOMAIN_NAME

String

CONTAINS

EQUALS

TASK_CATEGORY

String

CONTAINS

EQUALS

KEYWORDS

String

CONTAINS

EQUALS

OPCODE

String

CONTAINS

EQUALS

DESCRIPTION

String

EQUALS

CONTAINS

IP_BLOCK_ID

String

EQUALS

IP_ADDRESS_RANGE_ID

String

EQUALS

IP_ADDRESS

String

EQUALS

LOGICAL_GROUP_NAME

String

CONTAINS

EQUALS

CUSTOM_FIELD_NAME

String

CONTAINS

EQUALS

DHCP

EVENT_ID

Integer

EQUALS

SERVER_NAME

String

CONTAINS

EQUALS

TIME_OF_EVENT

DateTime

BETWEEN

USER_NAME

String

CONTAINS

EQUALS

USER_DOMAIN_NAME

String

CONTAINS

EQUALS

SCOPE_NAME

String

CONTAINS

EQUALS

SCOPE_ID

String

EQUALS

OPTION_ID

Integer

EQUALS

OPTION_NAME

String

CONTAINS

EQUALS

RESERVATION_ADDRESS

String

EQUALS