Directory Server Documentation Index
Configuration Reference Home

Replication Domain

Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact UnboundID support in order to understand the potential impact of that change.

A Replication Domain comprises of several Directory Server instances sharing the same synchronized set of data.

Relations From this Component
Properties
dsconfig Usage

Relations to This Component

The following components have a direct composition relation to Replication Domains:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ server-id ↓ window-size
↓ base-dn ↓ heartbeat-interval
↓ compression-criteria ↓ isolation-policy
↓ compression-mechanism ↓ sync-hist-purge-delay
↓ compression-parameter ↓ restricted

Basic Properties

server-id (Read-Only)

Description
Specifies a unique identifier for the Directory Server within the Replication Domain. Each Directory Server within the same Replication Domain must have a different server ID. A Directory Server which is a member of multiple Replication Domains may use the same server ID for each of its Replication Domain configurations.
Default Value
None
Allowed Values
An integer value. Lower limit is 1. Upper limit is 65535 .
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

base-dn (Read-Only)

Description
Specifies the base DN of the replicated data.
Default Value
None
Allowed Values
A valid DN.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

compression-criteria

Description
Specifies when the replication traffic should be compressed. The replication traffic can be compressed to reduce the amount of data flowing through particular data links.
Default Value
remote
Allowed Values
always - Replication traffic is always compressed except when the replica and the replication server is in the same process.

remote - Replication traffic compression is enabled when a replica or replication server communicates with a replication server in a different location.

never - Replication traffic is never compressed.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

compression-mechanism

Description
Specifies the class of a compression mechanism implementation used for compressing the replication traffic.
Default Value
com.unboundid.directory.server.replication.protocol.ZipCompression
Allowed Values
The fully-qualified name of a Java class that extends or implements com.unboundid.directory.server.replication.protocol.CompressionMechanism
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

compression-parameter

Description
Optional compression mechanism parameters.
Default Value
None
Allowed Values
A string
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action


Advanced Properties

window-size (Advanced Property)

Description
Specifies the window size that the Directory Server will use when communicating with Replication Servers.
Default Value
1000
Allowed Values
An integer value. Lower limit is 0.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

heartbeat-interval (Advanced Property)

Description
Specifies the heartbeat interval that the Directory Server will use when communicating with Replication Servers. The Directory Server expects a regular heartbeat coming from the Replication Server within the specified interval. If a heartbeat is not received within the interval, the Directory Server closes its connection and connects to another Replication Server.
Default Value
30000ms
Allowed Values
A duration. Lower limit is 10000 milliseconds.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

isolation-policy (Advanced Property)

Description
Specifies the behavior of the Directory Server if a write operation is attempted on the data within the Replication Domain when none of the configured Replication Servers are available.
Default Value
reject-all-updates
Allowed Values
accept-all-updates - Indicates that updates should be accepted even though it is not possible to send them to any Replication Server. Best effort is made to re-send those updates to a Replication Server when one of them is available, however those changes are at risk because they are only available from the historical information. This mode can also introduce high replication latency.

reject-all-updates - Indicates that all updates attempted on this Replication Domain are rejected when no Replication Server is available.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

sync-hist-purge-delay (Advanced Property)

Description
The time in seconds after which historical information used in replication conflict resolution is purged. The information is removed from entries when they are modified after the purge delay has elapsed.
Default Value
86400s
Allowed Values
A duration. Lower limit is 0 seconds.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

restricted (Advanced Property)

Description
When set to true, changes are only replicated with server instances that belong to the same replication set. By default, replication changes are propagated in the entire topology. In some cases, however, it is desirable to limit the scope of replication. The entry balancing feature, for example, allows the same base DN to be partitioned into multiple data sets. Changes within a data set may be replicated, while the same is not desired between data sets.
Default Value
false
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Replication Domains:

dsconfig list-replication-domains
     [--property {propertyName}] ...

To view the configuration for an existing Replication Domain:

dsconfig get-replication-domain-prop
     --domain-name {name}
     --provider-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Replication Domain:

dsconfig set-replication-domain-prop
     --domain-name {name}
     --provider-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...