Configuration Reference Home
OpenDS - Proportional Load Balancing Route

Proportional Load Balancing Route

The Proportional Load Balancing Route defines a route for a proportional load balancing algorithm.

A proportional load balancing route is defined by a set of weights (a different weight for each type of operation) and is identified by a route identifier. The weight of the route is used by the proportional load balancing algorithm to determine which route should be used. The requests are distributed in proportion to the weight of each route for that type of request.

Parent Component

The Proportional Load Balancing Route component inherits from the Load Balancing Route




This page describes the Proportional Load Balancing Route:


Properties

A description of each property follows.


Basic Properties: Advanced Properties:
↓ add-weight  None
↓ bind-weight
↓ compare-weight
↓ delete-weight
↓ extended-weight
↓ modify-weight
↓ modifydn-weight
↓ search-weight
↓ workflow-element

Basic Properties

add-weight

Description
The weight of the route for add operations. The weight of the route for add operations defines the proportion of ADD requests that should be managed by this route.
Default Value
1
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No

bind-weight

Description
The weight of the route for bind operations. The weight of the route for bind operations defines the proportion of BIND requests that should be managed by this route.
Default Value
1
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No

compare-weight

Description
The weight of the route for compare operations. The weight of the route for compare operations defines the proportion of COMPARE requests that should be managed by this route.
Default Value
1
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No

delete-weight

Description
The weight of the route for delete operations. The weight of the route for delete operations defines the proportion of DELETE requests that should be managed by this route.
Default Value
1
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No

extended-weight

Description
The weight of the route for extended operations. The weight of the route for extended operations defines the proportion of EXTENDED requests that should be managed by this route.
Default Value
1
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No

modify-weight

Description
The weight of the route for modify operations. The weight of the route for modify operations defines the proportion of MODIFY requests that should be managed by this route.
Default Value
1
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No

modifydn-weight

Description
The weight of the route for modifyDN operations. The weight of the route for modifyDN operations defines the proportion of MODIFYDN requests that should be managed by this route.
Default Value
1
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No

search-weight

Description
The weight of the route for search operations. The weight of the route for search operations defines the proportion of SEARCH requests that should be managed by this route.
Default Value
1
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No

workflow-element

Description
The workflow element which contains the route.
Default Value
None
Allowed Values
The DN of any Workflow Element.
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
Yes


LDAP Mapping

Each configuration property can be mapped to a specific LDAP attribute under the "cn=config" entry. The mappings that follow are provided for information only. In general, you should avoid changing the server configuration by manipulating the LDAP attributes directly.

Base DN
cn=routes
objectclass name
ds-cfg-proportional-load-balancing-route
objectclass superior
ds-cfg-load-balancing-route

Property
LDAP attribute
add-weight
ds-cfg-add-weight
bind-weight
ds-cfg-bind-weight
compare-weight
ds-cfg-compare-weight
delete-weight
ds-cfg-delete-weight
extended-weight
ds-cfg-extended-weight
modify-weight
ds-cfg-modify-weight
modifydn-weight
ds-cfg-modifydn-weight
search-weight
ds-cfg-search-weight
workflow-element
ds-cfg-workflow-element