Filter Based Uncached Entry Criteria

Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact support in order to understand the potential impact of that change.

The Filter Based Uncached Entry Criteria uses a search filter to identify which entries should be stored in the id2entry database versus those which should be stored in the uncached-id2entry database.

Parent Component Properties dsconfig Usage

Parent Component

The Filter Based Uncached Entry Criteria component inherits from the Uncached Entry Criteria

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
 description  None
 enabled
 filter
 filter-identifies-uncached-entries

Basic Properties

description

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

enabled

Description
Indicates whether this Uncached Entry Criteria is enabled for use in the server.
Default Value
None
Allowed Values
true
false
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

filter

Description
Specifies the search filter that should be used to differentiate entries into cached and uncached sets. For cases in which both an original and updated entry are provided (e.g., for modify and modify DN operations), the filter will be evaluated against the updated version of the entry.
Default Value
None
Allowed Values
A valid LDAP search filter
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

filter-identifies-uncached-entries

Description
Indicates whether the associated filter identifies those entries which should be stored in the uncached-id2entry database (if true) or entries which should be stored in the id2entry database (if false).
Default Value
true
Allowed Values
true
false
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Uncached Entry Criteria:

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

To view the configuration for an existing Uncached Entry Criteria:

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

To update the configuration for an existing Uncached Entry Criteria:

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

To create a new Filter Based Uncached Entry Criteria:

dsconfig create-uncached-entry-criteria
     --criteria-name {name}
     --type filter-based
     --set enabled:{propertyValue}
     --set filter:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Uncached Entry Criteria:

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