Note: this is an abstract component that cannot be instantiated.
The Load Balancing Algorithm is used to choose the appropriate backend server to use to process a request. It may be used to provide improved availability and performance by distributing the workload across multiple backend server systems.
↓Direct Subcomponents
↓Relations to This Component
↓Properties
↓dsconfig Usage
The following Load Balancing Algorithms are available in the server :
These Load Balancing Algorithms inherit from the properties described below.
The following components have a direct aggregation relation to Load Balancing Algorithms:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | ↓ initial-connections |
| ↓ enabled | ↓ max-connections |
| 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 |
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 |
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 delete an existing Load Balancing Algorithm:
dsconfig delete-load-balancing-algorithm
--algorithm-name {name}