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 Request Criteria define sets of criteria for grouping and describing operation requests based on a number of properties, including the type of operation, the client connection, the time the operation was requested, and and any controls included in the request. Additional criteria is available for specific types of operations.
↓Parent Component
↓Relations To this Component
↓Properties
↓dsconfig Usage
The Simple Request Criteria component inherits from the Request Criteria
The following components have a direct aggregation relation from Simple Request Criteria:
The properties supported by this managed object are as follows:
| 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 |
| Description | Specifies the operation type(s) for operations that should be included in this Simple Request Criteria. |
| Default Value | abandon add bind compare delete extended modify modify-dn search unbind |
| Allowed Values | abandon - Abandon operations may be included in this Simple Request Criteria. add - Add operations may be included in this Simple Request Criteria. bind - Bind operations may be included in this Simple Request Criteria. compare - Compare operations may be included in this Simple Request Criteria. delete - Delete operations may be included in this Simple Request Criteria. extended - Extended operations may be included in this Simple Request Criteria. modify - Modify operations may be included in this Simple Request Criteria. modify-dn - Modify DN operations may be included in this Simple Request Criteria. search - Search operations may be included in this Simple Request Criteria. unbind - Unbind operations may be included in this Simple Request Criteria. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the origin for operations to be included in this Simple Request Criteria. If no values are provided, then the operation origin will not be taken into consideration when determining whether an operation matches this Simple Request Criteria. |
| Default Value | None |
| Allowed Values | external-request - Requests from external clients may be included in this Simple Request Criteria. internal-operation - Requests from internal operations may be included in this Simple Request Criteria. replicated-operation - Requests related to replication or other forms of synchronization may be included in this Simple Request Criteria. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the OID of a control that must be present in the request from the client for operations included in this Simple Request Criteria. If any control OIDs are provided, then the request must contain all of those controls. If one or more all-included request control OIDs are provided, then this Simple Request Criteria will only match operations in which the request includes all of those controls. If one or more any-included request control OIDs are provided, then this Simple Request Criteria will only match operations in which the request contains at least one of those controls. If one or more not-all-included request control OIDs are provided, then this Simple Request Criteria will only match operations in which the request does not contain at least one of those controls. If one or more none-included request control OIDs are provided, then this Simple Request Criteria will only match operations in which the request does not contain any of those controls. If no all-included, any-included, not-all-included, or none-included request control OIDs are provided, then the controls included in the request will not be taken into account when determining whether an operation matches this Simple Request Criteria. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the OID of a control that may be present in the request from the client for operations included in this Simple Request Criteria. If any control OIDs are provided, then the request must contain at least one of those controls. If one or more all-included request control OIDs are provided, then this Simple Request Criteria will only match operations in which the request includes all of those controls. If one or more any-included request control OIDs are provided, then this Simple Request Criteria will only match operations in which the request contains at least one of those controls. If one or more not-all-included request control OIDs are provided, then this Simple Request Criteria will only match operations in which the request does not contain at least one of those controls. If one or more none-included request control OIDs are provided, then this Simple Request Criteria will only match operations in which the request does not contain any of those controls. If no all-included, any-included, not-all-included, or none-included request control OIDs are provided, then the controls included in the request will not be taken into account when determining whether an operation matches this Simple Request 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-request-control
| Description | Specifies the OID of a control that should not be present in the request from the client for operations included in this Simple Request Criteria. If any control OIDs are provided, then the request must not contain at least one of those controls (that is, the request may contain zero or more of those controls, but not all of them). If one or more all-included request control OIDs are provided, then this Simple Request Criteria will only match operations in which the request includes all of those controls. If one or more any-included request control OIDs are provided, then this Simple Request Criteria will only match operations in which the request contains at least one of those controls. If one or more not-all-included request control OIDs are provided, then this Simple Request Criteria will only match operations in which the request does not contain at least one of those controls. If one or more none-included request control OIDs are provided, then this Simple Request Criteria will only match operations in which the request does not contain any of those controls. If no all-included, any-included, not-all-included, or none-included request control OIDs are provided, then the controls included in the request will not be taken into account when determining whether an operation matches this Simple Request Criteria. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the OID of a control that must not be present in the request from the client for operations included in this Simple Request Criteria. If any control OIDs are provided, then the request must not contain any of those controls. If one or more all-included request control OIDs are provided, then this Simple Request Criteria will only match operations in which the request includes all of those controls. If one or more any-included request control OIDs are provided, then this Simple Request Criteria will only match operations in which the request contains at least one of those controls. If one or more not-all-included request control OIDs are provided, then this Simple Request Criteria will only match operations in which the request does not contain at least one of those controls. If one or more none-included request control OIDs are provided, then this Simple Request Criteria will only match operations in which the request does not contain any of those controls. If no all-included, any-included, not-all-included, or none-included request control OIDs are provided, then the controls included in the request will not be taken into account when determining whether an operation matches this Simple Request Criteria. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies a base DN below which targeted entries may exist for requests included in this Simple Request Criteria. This will only be taken into account for add, simple bind, compare, delete, modify, modify DN, and search operations. It will be ignored for abandon, SASL bind, extended, and unbind operations. If at least one included target entry DN is provided, then this Simple Request Criteria will only match requests in which the target entry exists at or below one of the included target entry DNs. If at least one excluded target entry DN is provided, then this Simple Request Criteria will not match any requests in which the target entry exists below one of the excluded target entry DNs. If no included target entry DNs and no excluded target entry DNs are provided, then the location of the target entry will not be considered when determining whether a request matches this Simple Request Criteria. |
| Default Value | None |
| Allowed Values | A valid DN. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies a base DN below which targeted entries may not exist for requests included in this Simple Request Criteria. This will only be taken into account for add, simple bind, compare, delete, modify, modify DN, and search operations. It will be ignored for abandon, SASL bind, extended, and unbind operations. If at least one included target entry DN is provided, then this Simple Request Criteria will only match requests in which the target entry exists at or below one of the included target entry DNs. If at least one excluded target entry DN is provided, then this Simple Request Criteria will not match any requests in which the target entry exists below one of the excluded target entry DNs. If no included target entry DNs and no excluded target entry DNs are provided, then the location of the target entry will not be considered when determining whether a request matches this Simple Request Criteria. |
| Default Value | None |
| Allowed Values | A valid DN. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the authentication type for bind requests included in this Simple Request Criteria. This will only be taken into account for bind operations and will be ignored for any other type of operation. If no values are provided, then the authentication type will not be considered when determining whether the request should be included in this Simple Request Criteria. |
| Default Value | None |
| Allowed Values | simple - Simple bind requests may be included in this Simple Request Criteria. sasl - SASL bind requests may be included in this Simple Request Criteria. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
included-target-sasl-mechanism
| Description | Specifies the name of a SASL mechanism for bind requests included in this Simple Request Criteria. This will only be taken into account for SASL bind operations and will be ignored for other types of operations and for bind operations that do not use SASL authentication. If one or more included SASL mechanism names are provided, then only SASL bind requests with any of those mechanisms will be included in this Simple Request Criteria. If one or more excluded SASL mechanism names are provided, then no SASL bind requests with any of those mechanisms will be included in this Simple Request Criteria. If no included SASL mechanism names and no excluded SASL mechanism names are provided, then the SASL mechanism will not be considered when determining whether the request should be included in this Simple Request Criteria. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
excluded-target-sasl-mechanism
| Description | Specifies the name of a SASL mechanism for bind requests excluded from this Simple Request Criteria. This will only be taken into account for SASL bind operations and will be ignored for other types of operations and for bind operations that do not use SASL authentication. If one or more included SASL mechanism names are provided, then only SASL bind requests with any of those mechanisms will be included in this Simple Request Criteria. If one or more excluded SASL mechanism names are provided, then no SASL bind requests with any of those mechanisms will be included in this Simple Request Criteria. If no included SASL mechanism names and no excluded SASL mechanism names are provided, then the SASL mechanism will not be considered when determining whether the request should be included in this Simple Request Criteria. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the name or OID of an attribute type which must be targeted by requests included in this Simple Request Criteria. This will only be taken into account for add, compare, modify, modify DN, and search operations. It will be ignored for abandon, bind, delete, extended, and unbind operations. For an add operation, an attribute will be considered a target attribute if the associated attribute type is included in the entry to be added. For a compare operation, an attribute will be considered a target attribute if the associated attribute type is to be used in the assertion. For a modify operation, an attribute will be considered a target attribute if the associated attribute type is included in any of the modifications. For a modify DN operation, an attribute will be considered a target attribute if the associated attribute type is used in the new RDN. For a search operation, an attribute will be considered a target attribute if the associated attribute type is used in the filter. If one or more target attributes are provided, then only requests which target at least one of them will be included in this Simple Request Criteria. If one or more excluded target attributes are provided, then only requests which do not target any of them will be included in this Simple Request Criteria. If no included target attributes and no excluded target attributes are provided, then the attributes targeted by the requested will not be considered when determining whether the request should be included in this Simple Request Criteria. |
| Default Value | None |
| Allowed Values | The name or OID of an attribute type defined in the server schema. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the name or OID of an attribute type which must not be targeted by requests included in this Simple Request Criteria. This will only be taken into account for add, compare, modify, modify DN, and search operations. It will be ignored for abandon, bind, delete, extended, and unbind operations. For an add operation, an attribute will be considered a target attribute if the associated attribute type is included in the entry to be added. For a compare operation, an attribute will be considered a target attribute if the associated attribute type is to be used in the assertion. For a modify operation, an attribute will be considered a target attribute if the associated attribute type is included in any of the modifications. For a modify DN operation, an attribute will be considered a target attribute if the associated attribute type is used in the new RDN. For a search operation, an attribute will be considered a target attribute if the associated attribute type is used in the filter. If one or more target attributes are provided, then only requests which target at least one of them will be included in this Simple Request Criteria. If one or more excluded target attributes are provided, then only requests which do not target any of them will be included in this Simple Request Criteria. If no included target attributes and no excluded target attributes are provided, then the attributes targeted by the requested will not be considered when determining whether the request should be included in this Simple Request Criteria. |
| Default Value | None |
| Allowed Values | The name or OID of an attribute type defined in the server schema. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
included-extended-operation-oid
| Description | Specifies the request OID for extended requests included in this Simple Request Criteria. This will only be taken into account for extended requests and will be ignored for all other types of requests. If one or more included extended operation types are provided, then only extended requests with a request OID matching one of those values will be included in this Simple Request Criteria. If one or more excluded extended operation types are provided, then only extended request with a request OID that does not match any of those values will be included in this Simple Request Criteria. If no included extended operation types and no excluded extended operation types are provided, then the extended request OID will not be considered when determining whether the request should be included in this Simple Request Criteria. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
excluded-extended-operation-oid
| Description | Specifies the request OID for extended requests excluded from this Simple Request Criteria. This will only be taken into account for extended requests and will be ignored for all other types of requests. If one or more included extended operation types are provided, then only extended requests with a request OID matching one of those values will be included in this Simple Request Criteria. If one or more excluded extended operation types are provided, then only extended request with a request OID that does not match any of those values will be included in this Simple Request Criteria. If no included extended operation types and no excluded extended operation types are provided, then the extended request OID will not be considered when determining whether the request should be included in this Simple Request Criteria. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the search scope values included in this Simple Request Criteria. This will only be taken into account for search requests and will be ignored for all other types of requests. |
| Default Value | base-object single-level whole-subtree subordinate-subtree |
| Allowed Values | base-object - Indicates that search operations with a scope of "base-object" (which may match only the entry specified as the search base) may be included in this Simple Request Criteria. single-level - Indicates that search operations with a scope of "single-level" (which may match only entries immediately subordinate to the search base, but not the search base entry itself) may be included in this Simple Request Criteria. whole-subtree - Indicates that search operations with a scope of "whole-subtree" (which may match the search base entry and all entries subordinate to it to any depth) may be included in this Simple Request Criteria. subordinate-subtree - Indicates that search operations with a scope of "subordinate-subtree" (which may all entries subordinate to the search base entry to any depth, but not the search base entry itself) may be included in this Simple Request Criteria. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
using-administrative-session-worker-thread
| Description | Indicates whether operations being processed using a dedicated administrative session worker thread should be included in this Simple Request Criteria. |
| Default Value | any |
| Allowed Values | true - Indicates that only operations being processed using a dedicated administrative session worker thread should be included in this Simple Request Criteria. false - Indicates that only operations not being processed using a dedicated administrative session worker thread should be included in this Simple Request Criteria. any - Indicates that the use of a dedicated administrative session worker thread does not have any impact on whether an operation should be included in this Simple Request Criteria. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
connection-criteria (Advanced Property)
| Description | Specifies a connection criteria object that must match the associated client connection for operations included in this Simple Request Criteria. |
| Default Value | None |
| Allowed Values | The DN of any Connection Criteria. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
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 Simple Request Criteria:
dsconfig create-request-criteria
--criteria-name {name}
--type simple
[--set {propertyName}:{propertyValue}] ...
To delete an existing Request Criteria:
dsconfig delete-request-criteria
--criteria-name {name}