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.
Result Code Maps provide a way to customize the result codes that should be returned for various error conditions.
The following components have a direct aggregation relation to Result Code Maps:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| description | None |
| bind-account-locked-result-code | |
| bind-missing-user-result-code | |
| bind-missing-password-result-code | |
| server-error-result-code |
| Description | A description for this Result Code Map |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
bind-account-locked-result-code
| Description | Specifies the result code that should be returned if a bind attempt fails because the user's account is locked as a result of too many failed authentication attempts. |
| Default Value | 49 |
| Allowed Values | An integer value. Lower limit is 0. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the result code that should be returned if a bind attempt fails because the target user entry does not exist in the server. |
| Default Value | 49 |
| Allowed Values | An integer value. Lower limit is 0. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
bind-missing-password-result-code
| Description | Specifies the result code that should be returned if a password-based bind attempt fails because the target user entry does not have a password. |
| Default Value | 49 |
| Allowed Values | An integer value. Lower limit is 0. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the result code that should be returned if a generic error occurs within the server. |
| Default Value | 80 |
| Allowed Values | An integer value. Lower limit is 0. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured Result Code Maps:
dsconfig list-result-code-maps
[--property {propertyName}] ...
To view the configuration for an existing Result Code Map:
dsconfig get-result-code-map-prop
--map-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Result Code Map:
dsconfig set-result-code-map-prop
--map-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Result Code Map:
dsconfig create-result-code-map
--map-name {name}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Result Code Map:
dsconfig delete-result-code-map
--map-name {name}