Metrics Engine Documentation Index
Configuration Reference Home

Aggregate Request Criteria

Note: this component has a complexity level of "expert", which means that objects of this type are not expected to be created or altered. Please contact UnboundID support for assistance if you believe that you have a need to create or modify this type of object.

Aggregate Request Criteria provide request criteria which contain Boolean combinations of other request criteria objects.

↓Parent Component
↓Relations To this Component
↓Properties
↓dsconfig Usage

Parent Component

The Aggregate Request Criteria component inherits from the Request Criteria

Relations from This Component

The following components have a direct aggregation relation from Aggregate Request Criteria:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ all-included-request-criteria
↓ any-included-request-criteria
↓ not-all-included-request-criteria
↓ none-included-request-criteria

Basic Properties

description

Description
A description for this Request Criteria
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

all-included-request-criteria

Description
Specifies a request criteria object that must match the associated operation request in order to match the aggregate request criteria. If one or more all-included request criteria objects are provided, then an operation request must match all of them in order to match the aggregate request criteria.
Default Value
None
Allowed Values
The DN of any Request Criteria.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

any-included-request-criteria

Description
Specifies a request criteria object that may match the associated operation request in order to the this aggregate request criteria. If one or more any-included request criteria objects are provided, then an operation request must match at least one of them in order to match the aggregate request criteria.
Default Value
None
Allowed Values
The DN of any Request Criteria.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

not-all-included-request-criteria

Description
Specifies a request criteria object that should not match the associated operation request in order to match the aggregate request criteria. If one or more not-all-included request criteria objects are provided, then an operation request must not match all of them (that is, it may match zero or more of them, but it must not match all of them) in order to match the aggregate request criteria.
Default Value
None
Allowed Values
The DN of any Request Criteria.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

none-included-request-criteria

Description
Specifies a request criteria object that must not match the associated operation request in order to match the aggregate request criteria. If one or more none-included request criteria objects are provided, then an operation request must not match any of them in order to match the aggregate request criteria.
Default Value
None
Allowed Values
The DN of any Request Criteria.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Request Criteria:

dsconfig list-request-criteria
     [--property {propertyName}] ...

To view the configuration for an existing Request Criteria:

dsconfig get-request-criteria-prop
     --criteria-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Request Criteria:

dsconfig set-request-criteria-prop
     --criteria-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Aggregate Request Criteria:

dsconfig create-request-criteria
     --criteria-name {name}
     --type aggregate
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Request Criteria:

dsconfig delete-request-criteria
     --criteria-name {name}