The Single Server Load Balancing Algorithm is a simple proxy load-balancing algorithm that forwards all operations to a single backend LDAP server. At present, only the UnboundID Identity Data Store is supported.
↓Parent Component
↓Relations To this Component
↓Properties
↓dsconfig Usage
The Single Server Load Balancing Algorithm component inherits from the Load Balancing Algorithm
The following components have a direct aggregation relation from Single Server Load Balancing Algorithms:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | ↓ initial-connections |
| ↓ enabled | ↓ max-connections |
| ↓ backend-server | |
| ↓ maximum-allowed-local-response-time | |
| ↓ maximum-allowed-nonlocal-response-time |
| 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 backend server that should be used to process operations in the associated proxying request processor. |
| Default Value | None |
| Allowed Values | The DN of any LDAP External Server. |
| Multi-Valued | No |
| Required | Yes |
| 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 |
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 create a new Single Server Load Balancing Algorithm:
dsconfig create-load-balancing-algorithm
--algorithm-name {name}
--type single-server
--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}