The Weighted Load Balancing Algorithm may be used to select between servers that are classified in weighted sets. Which set to use will be selected in a manner based on the weights assigned to those sets. Servers within a set will be selected in a round-robin manner. The location and health of the servers may be taken into account, so that servers in the same location as this Identity Broker will be preferred over those in other locations, and servers with a state of "available" will be preferred over those with a state of "degraded".
↓Parent Component
↓Relations To this Component
↓Properties
↓dsconfig Usage
The Weighted Load Balancing Algorithm component inherits from the Load Balancing Algorithm
The following components have a direct aggregation relation from Weighted Load Balancing Algorithms:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | ↓ initial-connections |
| ↓ enabled | ↓ max-connections |
| ↓ server-set | ↓ operation-to-retry |
| ↓ use-location | |
| ↓ server-affinity-provider | |
| ↓ prefer-degraded-servers-over-failover | |
| ↓ maximum-allowed-local-response-time | |
| ↓ maximum-allowed-nonlocal-response-time | |
| ↓ maximum-retry-count |
| 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 weighted server sets that will be used by this Weighted Load Balancing Algorithm. |
| Default Value | None |
| Allowed Values | The DN of any Weighted Server Set. |
| 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 Identity Broker 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 Identity Broker. 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 |
| Description | The server affinity provider to use in order to attempt to consistently route requests of a particular type to the same backend server. If an affinity is defined for a particular request, then it may override the logic used by this Weighted Load Balancing Algorithm. |
| Default Value | None |
| Allowed Values | The DN of any Server Affinity Provider. |
| 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 Identity Broker 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 Identity Broker 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 |
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 Identity Broker should retry add operations if they fail with a result that indicates they might succeed on an alternate server. bind - The Identity Broker should retry bind operations if they fail with a result that indicates they might succeed on an alternate server. compare - The Identity Broker should retry compare operations if they fail with a result that indicates they might succeed on an alternate server. delete - The Identity Broker should retry delete operations if they fail with a result that indicates they might succeed on an alternate server. extended - The Identity Broker should retry extended operations if they fail with a result that indicates they might succeed on an alternate server. modify - The Identity Broker should retry modify operations if they fail with a result that indicates they might succeed on an alternate server. modify-dn - The Identity Broker should retry modify DN operations if they fail with a result that indicates they might succeed on an alternate server. search - The Identity Broker 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 |
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 Weighted Load Balancing Algorithm:
dsconfig create-load-balancing-algorithm
--algorithm-name {name}
--type weighted
--set enabled:{propertyValue}
--set server-set:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Load Balancing Algorithm:
dsconfig delete-load-balancing-algorithm
--algorithm-name {name}