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.
Each Entry Counter Plugin Criteria defines a set of criteria that can be used to identify a type of entries to be counted.
The following components have a direct composition relation to Entry Counter Criteria:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| base-dn | None |
| filter | |
| named-sub-category-filter | |
| warning-threshold-minimum-count | |
| error-threshold-minimum-count | |
| track-matching-entry-size |
| Description | The base DNs for entries that are eligible to match this criteria. If no base DNs are specified, then the set of public naming contexts will be used. |
| Default Value | The set of all public naming contexts will be used as the set of included base DNs. |
| Allowed Values | A valid DN. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The filter to use to identify entries that are eligible to match this criteria. |
| Default Value | None |
| Allowed Values | A valid LDAP search filter |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | An optional set of named filters that can be used to divide entries that match the base DN and filter criteria into additional sub-categories. If any sub-category-filter values are specified, then each value must be a category name followed by a colon and a search filter. The category name itself must not contain a colon. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
warning-threshold-minimum-count
| Description | The minimum number of entries in the server that must match this criteria before the server will raise a warning alarm. |
| Default Value | None |
| Allowed Values | An integer value. Lower limit is 1. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The minimum number of entries in the server that must match this criteria before the server will raise an error alarm. |
| Default Value | None |
| Allowed Values | An integer value. Lower limit is 1. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether to track information about the size of each matching entry. Note that the size estimate for any given entry may depend on the type of backend from which that entry was retrieved and the configuration of that backend. It may also include only the encoded representation of that entry, but could exclude the size of additional storage required to hold information about the entry, like references to that entry in indexes. |
| Default Value | false |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured Entry Counter Criteria:
dsconfig list-entry-counter-criteria
[--property {propertyName}] ...
To view the configuration for an existing Entry Counter Plugin Criteria:
dsconfig get-entry-counter-plugin-criteria-prop
--criteria-name {name}
--plugin-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Entry Counter Plugin Criteria:
dsconfig set-entry-counter-plugin-criteria-prop
--criteria-name {name}
--plugin-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Entry Counter Plugin Criteria:
dsconfig create-entry-counter-plugin-criteria
--criteria-name {name}
--plugin-name {name}
--set filter:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Entry Counter Plugin Criteria:
dsconfig delete-entry-counter-plugin-criteria
--criteria-name {name}
--plugin-name {name}