Directory Proxy Server Documentation Index
Configuration Reference Home

Criteria Based Load Balancing Algorithm

The Criteria Based Load Balancing Algorithm identifies a load-balancing algorithm to be used for a request that satisfies the associated criteria. It may be used by a request processor to specify an alternate load-balancing algorithm for requests that satisfy specific connection or request criteria. For example, this can be used to route write operations to a single server to eliminate the possibility of replication conflicts. To do so, the Criteria Based Load Balancing Algorithm should reference a fail-over load-balancing algorithm and should specify simple request criteria whose operation-type is restricted to "add", "delete", "modify" and "modify-dn" operations.

↓Relations from This Component
↓Relations to This Component
↓Properties
↓dsconfig Usage

Relations from This Component

The following components have a direct aggregation relation from Criteria Based Load Balancing Algorithms:

Relations to This Component

The following components have a direct aggregation relation to Criteria Based Load Balancing Algorithms:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ load-balancing-algorithm
↓ connection-criteria
↓ request-criteria

Basic Properties

description

Description
A description for this Criteria Based Load Balancing Algorithm
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

load-balancing-algorithm

Description
Specifies the load-balancing algorithm that will be used to select the backend server for each operation processed through this Criteria Based Load Balancing Algorithm
Default Value
None
Allowed Values
The DN of any Load Balancing Algorithm. Load-balancing algorithms associated with Criteria Based Load Balancing Algorithms must be enabled.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

connection-criteria

Description
Specifies a set of connection criteria used to indicate that only operations from clients matching this criteria may use the specified load-balancing algorithm.
Default Value
None
Allowed Values
The DN of any Connection Criteria.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

request-criteria

Description
Specifies a set of request criteria used to indicate that only operations for requests matching this criteria may use the specified load-balancing algorithm.
Default Value
None
Allowed Values
The DN of any Request Criteria.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Criteria Based Load Balancing Algorithms:

dsconfig list-criteria-based-load-balancing-algorithms
     [--property {propertyName}] ...

To view the configuration for an existing Criteria Based Load Balancing Algorithm:

dsconfig get-criteria-based-load-balancing-algorithm-prop
     --algorithm-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Criteria Based Load Balancing Algorithm:

dsconfig set-criteria-based-load-balancing-algorithm-prop
     --algorithm-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Criteria Based Load Balancing Algorithm:

dsconfig create-criteria-based-load-balancing-algorithm
     --algorithm-name {name}
     --set load-balancing-algorithm:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Criteria Based Load Balancing Algorithm:

dsconfig delete-criteria-based-load-balancing-algorithm
     --algorithm-name {name}