Configuration Reference Home
OpenDJ - Replication Server

Replication Server

Replication Servers publish updates to Directory Servers within a Replication Domain.

Relations To this Component

The following components have a direct COMPOSITION relation TO Replication Servers :

Properties

A description of each property follows.


Basic Properties: Advanced Properties:
↓ assured-timeout ↓ queue-size
↓ compute-change-number ↓ window-size
↓ degraded-status-threshold
↓ group-id
↓ monitoring-period
↓ replication-db-directory
↓ replication-port
↓ replication-purge-delay
↓ replication-server
↓ replication-server-id
↓ source-address
↓ weight

Basic Properties

assured-timeout

Description
The timeout value when waiting for assured mode acknowledgments. Defines the number of milliseconds that the replication server will wait for assured acknowledgments (in either Safe Data or Safe Read assured sub modes) before forgetting them and answer to the entity that sent an update and is waiting for acknowledgment.
Default Value
1000ms
Allowed Values
A duration Syntax. Lower limit is 1 milliseconds.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No

compute-change-number

Description
Whether the replication server will compute change numbers. This boolean tells the replication server to compute change numbers for each replicated change by maintaining a change number index database. Changenumbers are computed according to http://tools.ietf.org/html/draft-good-ldap-changelog-04. Note this functionality has an impact on CPU, disk accesses and storage. If changenumbers are not required, it is advisable to set this value to false.
Default Value
true
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No

degraded-status-threshold

Description
The number of pending changes as threshold value for putting a directory server in degraded status. This value represents a number of pending changes a replication server has in queue for sending to a directory server. Once this value is crossed, the matching directory server goes in degraded status. When number of pending changes goes back under this value, the directory server is put back in normal status. 0 means status analyzer is disabled and directory servers are never put in degraded status.
Default Value
5000
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No

group-id

Description
The group id for the replication server. This value defines the group id of the replication server. The replication system of a LDAP server uses the group id of the replicated domain and tries to connect, if possible, to a replication with the same group id.
Default Value
1
Allowed Values
An integer value. Lower value is 1. Upper value is 127 .
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No

monitoring-period

Description
The period between sending of monitoring messages. Defines the duration that the replication server will wait before sending new monitoring messages to its peers (replication servers and directory servers). Larger values increase the length of time it takes for a directory server to detect and switch to a more suitable replication server, whereas smaller values increase the amount of background network traffic.
Default Value
60s
Allowed Values
A duration Syntax. Lower limit is 0 milliseconds.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No

replication-db-directory

Description
The path where the Replication Server stores all persistent information.
Default Value
changelogDb
Allowed Values
A String
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
Yes

replication-port

Description
The port on which this Replication Server waits for connections from other Replication Servers or Directory Servers.
Default Value
None
Allowed Values
An integer value. Lower value is 1. Upper value is 65535 .
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No

replication-purge-delay

Description
The time (in seconds) after which the Replication Server erases all persistent information.
Default Value
3 days
Allowed Values
A duration Syntax. Lower limit is 0 seconds.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No

replication-server

Description
Specifies the addresses of other Replication Servers to which this Replication Server tries to connect at startup time. Addresses must be specified using the syntax: "hostname:port". If IPv6 addresses are used as the hostname, they must be specified using the syntax "[IPv6Address]:port".
Default Value
None
Allowed Values
A host name followed by a ":" and a port number.
Multi-valued
Yes
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No

replication-server-id

Description
Specifies a unique identifier for the Replication Server. Each Replication Server must have a different server ID.
Default Value
None
Allowed Values
An integer value. Lower value is 1. Upper value is 65535 .
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
Yes

source-address

Description
If specified, the server will bind to the address before connecting to the remote server. The address must be one assigned to an existing network interface.
Default Value
Let the server decide.
Allowed Values
An IP address
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No

weight

Description
The weight of the replication server. The weight affected to the replication server. Each replication server of the topology has a weight. When combined together, the weights of the replication servers of a same group can be translated to a percentage that determines the quantity of directory servers of the topology that should be connected to a replication server. For instance imagine a topology with 3 replication servers (with the same group id) with the following weights: RS1=1, RS2=1, RS3=2. This means that RS1 should have 25% of the directory servers connected in the topology, RS2 25%, and RS3 50%. This may be useful if the replication servers of the topology have a different power and one wants to spread the load between the replication servers according to their power.
Default Value
1
Allowed Values
An integer value. Lower value is 1.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No


Advanced Properties

queue-size

Description
Specifies the number of changes that are kept in memory for each directory server in the Replication Domain.
Default Value
10000
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No

window-size

Description
Specifies the window size that the Replication Server uses when communicating with other Replication Servers. This option may be deprecated and removed in future releases.
Default Value
100000
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No