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.
Note: this is an abstract component that cannot be instantiated.
Matching Rules define a set of rules for performing matching operations against assertion values.
Matching rules are frequently associated with an attribute syntax and are used to compare values according to that syntax. For example, the distinguishedNameEqualityMatch matching rule can be used to determine whether two DNs are equal and can ignore unnecessary spaces around commas and equal signs, differences in capitalization in attribute names, an so on.
↓Direct Subcomponents
↓Properties
↓dsconfig Usage
The following Matching Rules are available in the server :
These Matching Rules inherit from the properties described below.
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ enabled | None |
| ↓ java-class |
| Description | Indicates whether the Matching Rule is enabled for use. |
| Default Value | None |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the fully-qualified name of the Java class that provides the Matching Rule implementation. |
| Default Value | None |
| Allowed Values | The fully-qualified name of a Java class that extends or implements com.unboundid.directory.server.api.MatchingRule |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
To list the configured Matching Rules:
dsconfig list-matching-rules
[--property {propertyName}] ...
To view the configuration for an existing Matching Rule:
dsconfig get-matching-rule-prop
--rule-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Matching Rule:
dsconfig set-matching-rule-prop
--rule-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To delete an existing Matching Rule:
dsconfig delete-matching-rule
--rule-name {name}