Simple Search Reference Criteria

Simple Search Reference Criteria define sets of criteria for grouping and describing search result references 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 reference.

Parent Component Relations from This Component Properties dsconfig Usage

Parent Component

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

Relations from This Component

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

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
 description  request-criteria
 all-included-reference-control
 any-included-reference-control
 not-all-included-reference-control
 none-included-reference-control

Basic Properties

description

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

all-included-reference-control

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

any-included-reference-control

Description
Specifies the OID of a control that may be present in search result references included in this Simple Search Reference Criteria. If any control OIDs are provided, then the reference must contain at least one of those controls. If one or more all-included reference control OIDs are provided, then this Simple Search Reference Criteria will only match search result references that include all of those controls. If one or more any-included reference control OIDs are provided, then this Simple Search Reference Criteria will only match search result references that contain at least one of those controls. If one or more not-all-included reference control OIDs are provided, then this Simple Search Reference Criteria will only match search result references which do not contain at least one of those controls. If one or more none-included reference control OIDs are provided, then this Simple Search Reference Criteria will only match search result references that do not contain any of those controls. If no all-included, any-included, not-all-included, or none-included reference control OIDs are provided, then the controls included in the search result reference will not be taken into account when determining whether it matches this Simple Search Reference 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-reference-control

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

none-included-reference-control

Description
Specifies the OID of a control that must not be present in search result references included in this Simple Search Reference Criteria. If any control OIDs are provided, then the reference must not contain any of those controls. If one or more all-included reference control OIDs are provided, then this Simple Search Reference Criteria will only match search result references that include all of those controls. If one or more any-included reference control OIDs are provided, then this Simple Search Reference Criteria will only match search result references that contain at least one of those controls. If one or more not-all-included reference control OIDs are provided, then this Simple Search Reference Criteria will only match search result references which do not contain at least one of those controls. If one or more none-included reference control OIDs are provided, then this Simple Search Reference Criteria will only match search result references that do not contain any of those controls. If no all-included, any-included, not-all-included, or none-included reference control OIDs are provided, then the controls included in the search result reference will not be taken into account when determining whether it matches this Simple Search Reference Criteria.
Default Value
None
Allowed Values
A string
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 references included in this Simple Search Reference Criteria.
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 Reference Criteria:

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

To view the configuration for an existing Search Reference Criteria:

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

To update the configuration for an existing Search Reference Criteria:

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

To create a new Simple Search Reference Criteria:

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

To delete an existing Search Reference Criteria:

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