Metrics Engine Documentation Index
Configuration Reference Home

Root DSE 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.

Root DSE Request Criteria provide request criteria implementations that can be used to identify search and/or compare requests that target the server root DSE.

Parent Component
Properties
dsconfig Usage

Parent Component

The Root DSE Request Criteria component inherits from the Request Criteria

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ operation-type

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

operation-type

Description
The types of operations that may be matched by this Root DSE Request Criteria.
Default Value
compare
base-object-search
Allowed Values
compare - Indicates that compare operations targeting the root DSE may be matched by this criteria.

base-object-search - Indicates that search operations with a base DN of the null DN and a base-object scope (i.e., search operations targeting only the root DSE) may be matched by this criteria.

single-level-search - Indicates that search operations with a base DN of the null DN and a single-level scope (i.e., search operations targeting only the entries for the public naming contexts) may be matched by this criteria.

whole-subtree-search - Indicates that search operations with a base DN of the null DN and a whole-subtree scope (i.e., search operations targeting all entries in public backends) may be matched by this criteria. For searches that target the root DSE, the use of the whole-subtree scope should be equivalent to the use of the subordinate-subtree scope.

subordinate-subtree-search - Indicates that search operations with a base DN of the null DN and a subordinate-subtree scope (i.e., search operations targeting all entries in public backends) may be matched by this criteria. For searches that target the root DSE, the use of the whole-subtree scope should be equivalent to the use of the subordinate-subtree scope.
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 Root DSE Request Criteria:

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

To delete an existing Request Criteria:

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