The Failover Load Balancing Algorithm may be used to attempt to always send requests to the same server. If the preferred server is not available, then it will fail over to alternate servers in a predefined order. It can also be configured to take location into account, so that it will prefer servers in the same location as this Directory Proxy Server.
↓Parent Component
↓Relations from This Component
↓Properties
↓dsconfig Usage
The Failover Load Balancing Algorithm component inherits from the Location Based Load Balancing Algorithm
The properties supported by this managed object are as follows:
| Description | A description for this Load Balancing Algorithm |
| 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 load-balancing algorithm is enabled for use in the server. |
| Default Value | None |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the set of backend servers that will be available to process forwarded requests. |
| Default Value | None |
| Allowed Values | The DN of any LDAP External Server. |
| Multi-Valued | Yes |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether to take server locations into account when selecting servers to receive forwarded requests. If this is true, then the Directory Proxy Server instance and all of the associated LDAP external servers must be configured with a location, and this load-balancing algorithm will attempt to access only available servers in the same location as the Directory Proxy Server. If none are available then it will attempt to use available servers in the first preferred failover location (as defined in the location configuration), and then available servers in the second preferred failover location, etc. If this is false, then this load-balancing algorithm will consider all configured backend servers equal and will not take their locations into account when deciding how to forward requests. |
| Default Value | true |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
prefer-degraded-servers-over-failover
| Description | Indicates whether this load-balancing algorithm should prefer degraded servers in the same location over available servers in an alternate location. This property will be ignored if the value of the use-location property is false. |
| Default Value | false |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
maximum-allowed-local-response-time
| Description | The maximum length of time to wait for a response from a backend server in the same location as the Directory Proxy Server before considering it unavailable. |
| Default Value | 30 seconds |
| Allowed Values | A duration. Lower limit is 1 milliseconds. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
maximum-allowed-nonlocal-response-time
| Description | The maximum length of time to wait for a response from a backend server in a different location from the Directory Proxy Server before considering it unavailable. |
| Default Value | 30 seconds |
| Allowed Values | A duration. Lower limit is 1 milliseconds. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The maximum number of times that an operation should be retried against an alternate server in the event that it does not complete within the specified time limit or fails with a result code that indicates it may succeed against an alternate server. |
| Default Value | 1 |
| Allowed Values | An integer value. Lower limit is 0. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The set of base DNs below which to provide load spreading for this Failover Load Balancing Algorithm. This option is primarily intended for use in environments with a large number of branches below a common base DN where operations (including searches) are generally constrained to one of those branches (for example, a multi-tenant directory in which each tenant's data is in a separate branch). It can help spread the load across all the backend servers (subject to the location and health of those servers) while still offering consistent routing to avoid problems associated with replication propagation delay. |
| Default Value | None |
| Allowed Values | A valid DN. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
initial-connections (Advanced Property)
| Description | The number of connections to initially establish to each LDAP external server associated with this load-balancing algorithm. A nonzero value will override the initial number of connections defined in the LDAP external server configuration for this load-balancing algorithm. A value of zero indicates that the configuration for each LDAP external server should be used to determine the initial number of connections for the server. Note that this will be ignored for servers configured to use a thread-local connection pool. |
| Default Value | 0 |
| Allowed Values | An integer value. Lower limit is 0. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
max-connections (Advanced Property)
| Description | The maximum number of connections to maintain for each LDAP external server associated with this load-balancing algorithm. A nonzero value will override the maximum number of connections defined in the LDAP external server configuration for this load-balancing algorithm. A value of zero indicates that the configuration for each LDAP external server should be used to determine the maximum number of connections for the server. Note that this will be ignored for servers configured to use a thread-local connection pool. |
| Default Value | 0 |
| Allowed Values | An integer value. Lower limit is 0. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
operation-to-retry (Advanced Property)
| Description | Specifies the types of operations that may be retried on an alternate server upon failing with a result code that indicates it may succeed against an alternate server. |
| Default Value | bind compare delete extended modify modify-dn search |
| Allowed Values | add - The Directory Proxy Server should retry add operations if they fail with a result that indicates they might succeed on an alternate server. bind - The Directory Proxy Server should retry bind operations if they fail with a result that indicates they might succeed on an alternate server. compare - The Directory Proxy Server should retry compare operations if they fail with a result that indicates they might succeed on an alternate server. delete - The Directory Proxy Server should retry delete operations if they fail with a result that indicates they might succeed on an alternate server. extended - The Directory Proxy Server should retry extended operations if they fail with a result that indicates they might succeed on an alternate server. modify - The Directory Proxy Server should retry modify operations if they fail with a result that indicates they might succeed on an alternate server. modify-dn - The Directory Proxy Server should retry modify DN operations if they fail with a result that indicates they might succeed on an alternate server. search - The Directory Proxy Server should retry search operations if they fail with a result that indicates they might succeed on an alternate server. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
maximum-retryable-local-read-response-time (Advanced Property)
| Description | The maximum length of time to allow for the response to a read operation which may be retried on an alternate server if the attempt fails. This property will be used for bind, compare, and search operations against servers in the same location as this Directory Proxy Server instance when retries are allowed for the specified operation type and there are one or more remaining servers that can be tried. If this is not specified, then the value of the maximum-allowed-local-response-time property will be used instead. |
| Default Value | None |
| Allowed Values | A duration. Lower limit is 1 milliseconds. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
maximum-non-retryable-local-read-response-time (Advanced Property)
| Description | The maximum length of time to allow for the response to a read operation which may not be retried on an alternate server, either because retries have been disabled or because there are no more servers to be tried. This property will be used for bind, compare, and search operations against servers in the same location as this Directory Proxy Server instance. If this is not specified, then the value of the maximum-allowed-local-response-time property will be used instead. |
| Default Value | None |
| Allowed Values | A duration. Lower limit is 1 milliseconds. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
maximum-retryable-local-write-response-time (Advanced Property)
| Description | The maximum length of time to allow for the response to a write operation which may be retried on an alternate server if the attempt fails. This property will be used for add, delete, modify, and modify DN operations against servers in the same location as this Directory Proxy Server instance when retries are allowed for the specified operation type and there are one or more remaining servers that can be tried. If this is not specified, then the value of the maximum-allowed-local-response-time property will be used instead. |
| Default Value | None |
| Allowed Values | A duration. Lower limit is 1 milliseconds. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
maximum-non-retryable-local-write-response-time (Advanced Property)
| Description | The maximum length of time to allow for the response to a write operation which may not be retried on an alternate server, either because retries have been disabled or because there are no more servers to be tried. This property will be used for add, delete, modify, and modify DN operations against servers in the same location as this Directory Proxy Server instance. If this is not specified, then the value of the maximum-allowed-local-response-time property will be used instead. |
| Default Value | None |
| Allowed Values | A duration. Lower limit is 1 milliseconds. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
maximum-retryable-nonlocal-read-response-time (Advanced Property)
| Description | The maximum length of time to allow for the response to a read operation which may be retried on an alternate server if the attempt fails. This property will be used for bind, compare, and search operations against servers in a different location from this Directory Proxy Server instance when retries are allowed for the specified operation type and there are one or more remaining servers that can be tried. If this is not specified, then the value of the maximum-allowed-nonlocal-response-time property will be used instead. |
| Default Value | None |
| Allowed Values | A duration. Lower limit is 1 milliseconds. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
maximum-non-retryable-nonlocal-read-response-time (Advanced Property)
| Description | The maximum length of time to allow for the response to a read operation which may not be retried on an alternate server, either because retries have been disabled or because there are no more servers to be tried. This property will be used for bind, compare, and search operations against servers in a different location from this Directory Proxy Server instance. If this is not specified, then the value of the maximum-allowed-nonlocal-response-time property will be used instead. |
| Default Value | None |
| Allowed Values | A duration. Lower limit is 1 milliseconds. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
maximum-retryable-nonlocal-write-response-time (Advanced Property)
| Description | The maximum length of time to allow for the response to a write operation which may be retried on an alternate server if the attempt fails. This property will be used for add, delete, modify, and modify DN operations against servers in a different location from this Directory Proxy Server instance when retries are allowed for the specified operation type and there are one or more remaining servers that can be tried. If this is not specified, then the value of the maximum-allowed-nonlocal-response-time property will be used instead. |
| Default Value | None |
| Allowed Values | A duration. Lower limit is 1 milliseconds. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
maximum-non-retryable-nonlocal-write-response-time (Advanced Property)
| Description | The maximum length of time to allow for the response to a write operation which may not be retried on an alternate server, either because retries have been disabled or because there are no more servers to be tried. This property will be used for add, delete, modify, and modify DN operations against servers in a different location from this Directory Proxy Server instance. If this is not specified, then the value of the maximum-allowed-nonlocal-response-time property will be used instead. |
| Default Value | None |
| Allowed Values | A duration. Lower limit is 1 milliseconds. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured Load Balancing Algorithms:
dsconfig list-load-balancing-algorithms
[--property {propertyName}] ...
To view the configuration for an existing Load Balancing Algorithm:
dsconfig get-load-balancing-algorithm-prop
--algorithm-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Load Balancing Algorithm:
dsconfig set-load-balancing-algorithm-prop
--algorithm-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Failover Load Balancing Algorithm:
dsconfig create-load-balancing-algorithm
--algorithm-name {name}
--type {type}
--set enabled:{propertyValue}
--set backend-server:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Load Balancing Algorithm:
dsconfig delete-load-balancing-algorithm
--algorithm-name {name}