UnboundID Metrics Engine - Simple Search Entry Criteria

Metrics Engine Documentation Index
Configuration Reference Home

Simple Search Entry 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.

Simple Search Entry Criteria define sets of criteria for grouping and describing search result entries based on a number of properties. It can take into account properties from the client connection, the operation request, and the contents of the returned entry.

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

Parent Component

The Simple Search Entry Criteria component inherits from the Search Entry Criteria

Relations from This Component

The following components have a direct aggregation relation from Simple Search Entry Criteria:

Request Criteria

Properties

The properties supported by this managed object are as follows:

Basic Properties:	Advanced Properties:
↓ description	↓ request-criteria
↓ all-included-entry-control
↓ any-included-entry-control
↓ not-all-included-entry-control
↓ none-included-entry-control
↓ included-entry-base-dn
↓ excluded-entry-base-dn
↓ all-included-entry-filter
↓ any-included-entry-filter
↓ not-all-included-entry-filter
↓ none-included-entry-filter
↓ all-included-entry-group-dn
↓ any-included-entry-group-dn
↓ not-all-included-entry-group-dn
↓ none-included-entry-group-dn

Basic Properties

description

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

all-included-entry-control

Description	Specifies the OID of a control that must be present in search result entries included in this Simple Search Entry Criteria. If any control OIDs are provided, then the entry must contain all of those controls. If one or more all-included entry control OIDs are provided, then this Simple Search Entry Criteria will only match search result entries that include all of those controls. If one or more any-included entry control OIDs are provided, then this Simple Search Entry Criteria will only match search result entries that contain at least one of those controls. If one or more not-all-included entry control OIDs are provided, then this Simple Search Entry Criteria will only match search result entries which do not contain at least one of those controls. If one or more none-included entry control OIDs are provided, then this Simple Search Entry Criteria will only match search result entries that do not contain any of those controls. If no all-included, any-included, not-all-included, or none-included entry control OIDs are provided, then the controls included in the search result entry will not be taken into account when determining whether it matches this Simple Search Entry Criteria.
Default Value	None
Allowed Values	A string
Multi-Valued	Yes
Required	No
Admin Action Required	None. Modification requires no further action

any-included-entry-control

Description	Specifies the OID of a control that may be present in search result entries included in this Simple Search Entry Criteria. If any control OIDs are provided, then the entry must contain at least one of those controls. If one or more all-included entry control OIDs are provided, then this Simple Search Entry Criteria will only match search result entries that include all of those controls. If one or more any-included entry control OIDs are provided, then this Simple Search Entry Criteria will only match search result entries that contain at least one of those controls. If one or more not-all-included entry control OIDs are provided, then this Simple Search Entry Criteria will only match search result entries which do not contain at least one of those controls. If one or more none-included entry control OIDs are provided, then this Simple Search Entry Criteria will only match search result entries that do not contain any of those controls. If no all-included, any-included, not-all-included, or none-included entry control OIDs are provided, then the controls included in the search result entry will not be taken into account when determining whether it matches this Simple Search Entry Criteria.
Default Value	None
Allowed Values	A string
Multi-Valued	Yes
Required	No
Admin Action Required	None. Modification requires no further action

not-all-included-entry-control

Description	Specifies the OID of a control that should not be present in search result entries included in this Simple Search Entry Criteria. If any control OIDs are provided, then the entry must not contain at least one of those controls (that is, it may contain zero or more of those controls, but not all of them). If one or more all-included entry control OIDs are provided, then this Simple Search Entry Criteria will only match search result entries that include all of those controls. If one or more any-included entry control OIDs are provided, then this Simple Search Entry Criteria will only match search result entries that contain at least one of those controls. If one or more not-all-included entry control OIDs are provided, then this Simple Search Entry Criteria will only match search result entries which do not contain at least one of those controls. If one or more none-included entry control OIDs are provided, then this Simple Search Entry Criteria will only match search result entries that do not contain any of those controls. If no all-included, any-included, not-all-included, or none-included entry control OIDs are provided, then the controls included in the search result entry will not be taken into account when determining whether it matches this Simple Search Entry Criteria.
Default Value	None
Allowed Values	A string
Multi-Valued	Yes
Required	No
Admin Action Required	None. Modification requires no further action

none-included-entry-control

Description	Specifies the OID of a control that must not be present in search result entries included in this Simple Search Entry Criteria. If any control OIDs are provided, then the entry must not contain any of those controls. If one or more all-included entry control OIDs are provided, then this Simple Search Entry Criteria will only match search result entries that include all of those controls. If one or more any-included entry control OIDs are provided, then this Simple Search Entry Criteria will only match search result entries that contain at least one of those controls. If one or more not-all-included entry control OIDs are provided, then this Simple Search Entry Criteria will only match search result entries which do not contain at least one of those controls. If one or more none-included entry control OIDs are provided, then this Simple Search Entry Criteria will only match search result entries that do not contain any of those controls. If no all-included, any-included, not-all-included, or none-included entry control OIDs are provided, then the controls included in the search result entry will not be taken into account when determining whether it matches this Simple Search Entry Criteria.
Default Value	None
Allowed Values	A string
Multi-Valued	Yes
Required	No
Admin Action Required	None. Modification requires no further action

included-entry-base-dn

Description	Specifies a base DN below which entries included in this Simple Search Entry Criteria may exist. If at least one included base DN is provided, then this Simple Search Entry Criteria will only match entries below one of the included base DNs. If at least one excluded base DN is provided, then this Simple Search Entry Criteria will not match any entries below one of the excluded base DNs. If no included base DNs and no excluded base DNs are provided, then the location of the entry will not be considered when determining whether it matches this Simple Search Entry Criteria.
Default Value	None
Allowed Values	A valid DN.
Multi-Valued	Yes
Required	No
Admin Action Required	None. Modification requires no further action

excluded-entry-base-dn

Description	Specifies a base DN below which entries included in this Simple Search Entry Criteria may not exist. If at least one included base DN is provided, then this Simple Search Entry Criteria will only match entries below one of the included base DNs. If at least one excluded base DN is provided, then this Simple Search Entry Criteria will not match any entries below one of the excluded base DNs. If no included base DNs and no excluded base DNs are provided, then the location of the entry will not be considered when determining whether it matches this Simple Search Entry Criteria.
Default Value	None
Allowed Values	A valid DN.
Multi-Valued	Yes
Required	No
Admin Action Required	None. Modification requires no further action

all-included-entry-filter

Description	Specifies a search filter that must match search result entries included in this Simple Search Entry Criteria. Note that this matching will be performed against the entry that is actually returned to the client and may not reflect the complete entry stored in the server. If any filters are provided, then the returned entry must match all of those filters. If one or more all-included filters are provided, then this Simple Search Entry Criteria will only match search result entries that match all of those filters. If one or more any-included filters are provided, then this Simple Search Entry Criteria will only match entries that match at least one of those filters. If one or more not-all-included filters are provided, then this Simple Search Entry Criteria will only match entries that do not match at least one of those filters. If one or more none-included filters are provided, then this Simple Search Entry Criteria will only match entries that do not match any of those filters. If no all-included, any-included, not-all-included, or none-included filters are provided, then the content of the entry will not be taken into account when determining whether it matches this Simple Search Entry Criteria.
Default Value	None
Allowed Values	A valid LDAP search filter
Multi-Valued	Yes
Required	No
Admin Action Required	None. Modification requires no further action

any-included-entry-filter

Description	Specifies a search filter that may match search result entries included in this Simple Search Entry Criteria. Note that this matching will be performed against the entry that is actually returned to the client and may not reflect the complete entry stored in the server. If any filters are provided, then the entry must match at least one of those filters. If one or more all-included filters are provided, then this Simple Search Entry Criteria will only match search result entries that match all of those filters. If one or more any-included filters are provided, then this Simple Search Entry Criteria will only match entries that match at least one of those filters. If one or more not-all-included filters are provided, then this Simple Search Entry Criteria will only match entries that do not match at least one of those filters. If one or more none-included filters are provided, then this Simple Search Entry Criteria will only match entries that do not match any of those filters. If no all-included, any-included, not-all-included, or none-included filters are provided, then the content of the entry will not be taken into account when determining whether it matches this Simple Search Entry Criteria.
Default Value	None
Allowed Values	A valid LDAP search filter
Multi-Valued	Yes
Required	No
Admin Action Required	None. Modification requires no further action

not-all-included-entry-filter

Description	Specifies a search filter that should not match search result entries included in this Simple Search Entry Criteria. Note that this matching will be performed against the entry that is actually returned to the client and may not reflect the complete entry stored in the server. If any filters are provided, then the entry must not match at least one of those filters (that is, the entry may match zero or more of those filters, but not of all of them). If one or more all-included filters are provided, then this Simple Search Entry Criteria will only match search result entries that match all of those filters. If one or more any-included filters are provided, then this Simple Search Entry Criteria will only match entries that match at least one of those filters. If one or more not-all-included filters are provided, then this Simple Search Entry Criteria will only match entries that do not match at least one of those filters. If one or more none-included filters are provided, then this Simple Search Entry Criteria will only match entries that do not match any of those filters. If no all-included, any-included, not-all-included, or none-included filters are provided, then the content of the entry will not be taken into account when determining whether it matches this Simple Search Entry Criteria.
Default Value	None
Allowed Values	A valid LDAP search filter
Multi-Valued	Yes
Required	No
Admin Action Required	None. Modification requires no further action

none-included-entry-filter

Description	Specifies a search filter that must not match search result entries included in this Simple Search Entry Criteria. Note that this matching will be performed against the entry that is actually returned to the client and may not reflect the complete entry stored in the server. If any filters are provided, then the entry must not match any of those filters. If one or more all-included filters are provided, then this Simple Search Entry Criteria will only match search result entries that match all of those filters. If one or more any-included filters are provided, then this Simple Search Entry Criteria will only match entries that match at least one of those filters. If one or more not-all-included filters are provided, then this Simple Search Entry Criteria will only match entries that do not match at least one of those filters. If one or more none-included filters are provided, then this Simple Search Entry Criteria will only match entries that do not match any of those filters. If no all-included, any-included, not-all-included, or none-included filters are provided, then the content of the entry will not be taken into account when determining whether it matches this Simple Search Entry Criteria.
Default Value	None
Allowed Values	A valid LDAP search filter
Multi-Valued	Yes
Required	No
Admin Action Required	None. Modification requires no further action

all-included-entry-group-dn

Description	Specifies the DN of a group in which the user associated with the entry must be a member to be included in this Simple Search Entry Criteria. If any group DNs are provided, then the entry must be a member of all of them. If one or more all-included group DNs are provided, then this Simple Search Entry Criteria will only match search result entries that are members of all of those groups. If one or more any-included group DNs are provided, then this Simple Search Entry Criteria will only match entries that are members of at least one of those groups. If one or more not-all-included group DNs are provided, then this Simple Search Entry Criteria will only match entries that are not members of at least one of those groups. If one or more none-included group DNs are provided, then this Simple Search Entry Criteria will only match entries that are not members of any of those groups. If no all-included, any-included, not-all-included, or none-included group DNs are provided, then the group membership for the associated user will not be taken into account when determining whether the entry matches this Simple Search Entry Criteria.
Default Value	None
Allowed Values	A valid DN.
Multi-Valued	Yes
Required	No
Admin Action Required	None. Modification requires no further action

any-included-entry-group-dn

Description	Specifies the DN of a group in which the user associated with the entry may be a member to be included in this Simple Search Entry Criteria. If any group DNs are provided, then the entry must be a member of at least one of them. If one or more all-included group DNs are provided, then this Simple Search Entry Criteria will only match search result entries that are members of all of those groups. If one or more any-included group DNs are provided, then this Simple Search Entry Criteria will only match entries that are members of at least one of those groups. If one or more not-all-included group DNs are provided, then this Simple Search Entry Criteria will only match entries that are not members of at least one of those groups. If one or more none-included group DNs are provided, then this Simple Search Entry Criteria will only match entries that are not members of any of those groups. If no all-included, any-included, not-all-included, or none-included group DNs are provided, then the group membership for the associated user will not be taken into account when determining whether the entry matches this Simple Search Entry Criteria.
Default Value	None
Allowed Values	A valid DN.
Multi-Valued	Yes
Required	No
Admin Action Required	None. Modification requires no further action

not-all-included-entry-group-dn

Description	Specifies the DN of a group in which the user associated with the entry should not be a member to be included in this Simple Search Entry Criteria. If any group DNs are provided, then the entry must not be a member of at least one of them (that is, the entry may be a member of zero or more of the specified groups, but not of all of them). If one or more all-included group DNs are provided, then this Simple Search Entry Criteria will only match search result entries that are members of all of those groups. If one or more any-included group DNs are provided, then this Simple Search Entry Criteria will only match entries that are members of at least one of those groups. If one or more not-all-included group DNs are provided, then this Simple Search Entry Criteria will only match entries that are not members of at least one of those groups. If one or more none-included group DNs are provided, then this Simple Search Entry Criteria will only match entries that are not members of any of those groups. If no all-included, any-included, not-all-included, or none-included group DNs are provided, then the group membership for the associated user will not be taken into account when determining whether the entry matches this Simple Search Entry Criteria.
Default Value	None
Allowed Values	A valid DN.
Multi-Valued	Yes
Required	No
Admin Action Required	None. Modification requires no further action

none-included-entry-group-dn

Description	Specifies the DN of a group in which the user associated with the entry must not be a member to be included in this Simple Search Entry Criteria. If any group DNs are provided, then the entry must not be a member of any of them. If one or more all-included group DNs are provided, then this Simple Search Entry Criteria will only match search result entries that are members of all of those groups. If one or more any-included group DNs are provided, then this Simple Search Entry Criteria will only match entries that are members of at least one of those groups. If one or more not-all-included group DNs are provided, then this Simple Search Entry Criteria will only match entries that are not members of at least one of those groups. If one or more none-included group DNs are provided, then this Simple Search Entry Criteria will only match entries that are not members of any of those groups. If no all-included, any-included, not-all-included, or none-included group DNs are provided, then the group membership for the associated user will not be taken into account when determining whether the entry matches this Simple Search Entry Criteria.
Default Value	None
Allowed Values	A valid DN.
Multi-Valued	Yes
Required	No
Admin Action Required	None. Modification requires no further action

Advanced Properties

request-criteria (Advanced Property)

Description	Specifies a request criteria object that must match the associated request for entries included in this Simple Search Entry Criteria. of them.
Default Value	None
Allowed Values	The DN of any Request Criteria.
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

dsconfig Usage

To list the configured Search Entry Criteria:

dsconfig list-search-entry-criteria
     [--property {propertyName}] ...

To view the configuration for an existing Search Entry Criteria:

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

To update the configuration for an existing Search Entry Criteria:

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

To create a new Simple Search Entry Criteria:

dsconfig create-search-entry-criteria
     --criteria-name {name}
     --type simple
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Search Entry Criteria:

dsconfig delete-search-entry-criteria
     --criteria-name {name}