The Failover Request Processor may be used to fail over between request processors in the event that a higher-priority request processor is unavailable. In the event that an operation fails in one request processor, it will be re-tried in the next request processor in the list.
↓Parent Component
↓Relations from This Component
↓Properties
↓dsconfig Usage
The Failover Request Processor component inherits from the Request Processor
The following components have a direct aggregation relation from Failover Request Processors:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | None |
| ↓ enabled | |
| ↓ allowed-operation | |
| ↓ subordinate-request-processor | |
| ↓ failover-result | |
| ↓ failover-for-search-returning-no-entries |
| Description | A description for this Request Processor |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether this Request Processor is enabled for use in the Directory Proxy Server. |
| Default Value | true |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the types of operations that this Request Processor may be requested to process. |
| Default Value | abandon add bind compare delete extended modify modify-dn search |
| Allowed Values | abandon - This Request Processor may be used to process abandon operations. add - This Request Processor may be used to process add operations. bind - This Request Processor may be used to process bind operations. compare - This Request Processor may be used to process compare operations. delete - This Request Processor may be used to process delete operations. extended - This Request Processor may be used to process extended operations. modify - This Request Processor may be used to process modify operations. modify-dn - This Request Processor may be used to process modify DN operations. search - This Request Processor may be used to process search operations. |
| Multi-Valued | Yes |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the request processors for which to provide failover support. The position of the request processors in this list is used to determine their relative priorities. Request processors which come earlier in the list will be preferred over those which are lower in the list. |
| Default Value | None |
| Allowed Values | The DN of any Request Processor. |
| Multi-Valued | Yes |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the set of operation result codes that will cause the server to re-try the operation in the next request processor in the list. |
| Default Value | operations-error no-such-object busy unavailable other |
| Allowed Values | success - Operation processing completed successfully. operations-error - An error occurred related to the ordering of operations. protocol-error - An error occurred while parsing the request from the client. time-limit-exceeded - Search processing took longer than the maximum allowed time to complete. size-limit-exceeded - The associated search request matched more entries than are allowed to be returned to the client. compare-false - The assertion contained in the associated compare request did not match the target entry. compare-true - The assertion contained in the associated compare request matched target entry. auth-method-not-supported - The requested authentication type is not supported. strong-auth-required - Strong authentication is required for the requested operation. referral - A referral was encountered while processing the operation. admin-limit-exceeded - An administrative limit was exceeded while processing the operation. unavailable-critical-extension - A critical control included in the request could not be processed. confidentiality-required - The requested operation requires confidentiality for communication between the client and the server. sasl-bind-in-progress - A multi-stage SASL bind operation is in progress. no-such-attribute - A specified attribute did not exist in the target entry. undefined-attribute-type - A specified attribute type does is not defined in the server schema. inappropriate-matching - The operation attempted to perform a type of comparison against a specified attribute that is not allowed for that attribute type. constraint-violation - The operation would have violated a constraint defined in the server. attribute-or-value-exists - The operation would have resulted in a conflict with an existing attribute or attribute value in the target entry. invalid-attribute-syntax - An attribute value was provided that is not valid according to the associated attribute syntax. no-such-object - The operation targeted an entry that does not exist. alias-problem - An attempt was made to perform an illegal operation against an alias. invalid-dn-syntax - A provided value could not be parsed as a valid distinguished name. alias-dereferencing-problem - A problem occurred while attempting to dereference an alias during search processing. inappropriate-authentication - The attempted authentication type was not appropriate for the target user. invalid-credentials - The bind credentials provided were not valid. insufficient-access-rights - The user does not have permission to perform the requested operation. busy - The server is too busy to process the requested operation. unavailable - The server is not available to process client requests. unwilling-to-perform - The server is not willing to process the requested operation. loop-detect - A referral or chaining loop was encountered while processing the request. sort-control-missing - The search request contained the virtual list view request control but was missing the required server-side sort request control. offset-range-error - The search request contained the virtual list view request control with an invalid offset or range. naming-violation - The operation would have resulted in an entry that violates the server's naming constraints. objectclass-violation - The operation would have resulted in an entry that violates schema constraints for the object classes contained in the entry. not-allowed-on-nonleaf - The requested operation is not allowed for non-leaf entries. not-allowed-on-rdn - The requested operation attempted to alter an RDN attribute value in a manner that is not allowed. entry-already-exists - The requested operation would have resulted in an entry that conflicts with an entry that already exists in the server. objectclass-mods-prohibited - The requested operation would have modified the object classes contained in the target entry in a manner that is not allowed. affects-multiple-dsas - The requested operation would have required updating entries that exist in multiple servers. virtual-list-view-error - An error occurred while performing virtual list view processing. other - An error occurred which does not fit any other defined result code. canceled - The operation was canceled. no-such-operation - The target operation could not be canceled because it did not exist or had already completed. too-late - The target operation could not be canceled because the server had already completed too much processing on the operation to allow it to be canceled. cannot-cancel - The target operation could not be canceled because operations of that type cannot be canceled. assertion-failed - The target entry did not match the filter contained in the assertion request control. authorization-denied - The client does not have permission to use the proxied authorization control. no-operation - No problems were encountered while processing the operation, but no changes were applied because the request included the no-op control. interactive-transaction-aborted - The interactive transaction has been aborted. |
| Multi-Valued | Yes |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
failover-for-search-returning-no-entries
| Description | Indicates whether a search operation which does not return any entries should be re-tried in the next request processor in the list. |
| 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 Request Processors:
dsconfig list-request-processors
[--property {propertyName}] ...
To view the configuration for an existing Request Processor:
dsconfig get-request-processor-prop
--processor-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Request Processor:
dsconfig set-request-processor-prop
--processor-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Failover Request Processor:
dsconfig create-request-processor
--processor-name {name}
--type failover
--set subordinate-request-processor:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Request Processor:
dsconfig delete-request-processor
--processor-name {name}