Configuration Reference Home
OpenDS - Saturation Load Balancing Route

Saturation Load Balancing Route

The Saturation Load Balancing Route defines a route for a saturation load balancing algorithm.

A saturation load balancing route is defined by a priority and a saturation level threshold. It is identified by a route identifier.

Parent Component

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




This page describes the Saturation Load Balancing Route:


Properties

A description of each property follows.


Basic Properties: Advanced Properties:
↓ alert-threshold  None
↓ priority
↓ threshold
↓ workflow-element

Basic Properties

alert-threshold

Description
The saturation level of the route which triggers an alert. The saturation level alert threshold is used by the saturation load balancing algorithm to determine if an alert should be created. When the saturation level of the route reaches the alert threshold, an alert is generated to warn the system administrator that the route is saturated. When the saturation level of the route falls below the alert threshold, an alert is generated to warn the system administrator that the route saturation is back to an acceptable state.
Default Value
90
Allowed Values
An integer value. Lower value is 0. Upper value is 100 .
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No

priority

Description
The priority of the route. The priority of the route is used by the saturation load balancing algorithm to determine which route should be used first. The lower the number, the higher the priority, and the highest priority is 0.
Default Value
None
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No

threshold

Description
The maximum saturation level of the route. The saturation level threshold is used by the saturation load balancing algorithm to determine whether the route should continute to be used. Saturation is defined as a percentage where 100 means that the element is completely saturated and should not be used, and 0 means that the element is fully operational. When the saturation level of the route is below the saturation level threshold, the route is considered acceptable and can be chosen by the algorithm. When the saturation level of the route is higher than or equal to the saturation level threshold, the next highest priority route with an acceptable saturation level is chosen. When all routes are saturated, the route with the lowest saturation level is chosen. The saturation level threshold is expressed as a percentage value.
Default Value
80
Allowed Values
An integer value. Lower value is 0. Upper value is 100 .
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-saturation-load-balancing-route
objectclass superior
ds-cfg-load-balancing-route

Property
LDAP attribute
alert-threshold
ds-cfg-saturation-load-balancing-alert-threshold
priority
ds-cfg-saturation-load-balancing-priority
threshold
ds-cfg-saturation-load-balancing-threshold
workflow-element
ds-cfg-workflow-element