Identity Data Store 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 Identity Data Store 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
↓ sync-hist-purge-delay
↓ restricted

Basic Properties

server-id (Read-Only)

Description
Specifies a unique identifier for the Identity Data Store within the Replication Domain. Each Identity Data Store within the same Replication Domain must have a different server ID. An Identity Data Store 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


Advanced Properties

window-size (Advanced Property)

Description
Specifies the maximum number of replication updates the Identity Data Store can have outstanding from the Replication Server. To gauge if the current window size setting is sufficient, check the current-rcv-window monitor attribute under load. If it hovers around zero, consider increasing the window size. Likewise, if the current-send-window monitor attribute hovers around zero under load, consider increasing the window size of the associated Replication Server.
Default Value
5000
Allowed Values
An integer value. Lower limit is 10. Upper limit is 100000 .
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 Identity Data Store will use when communicating with Replication Servers. The Identity Data Store expects a regular heartbeat coming from the Replication Server within the specified interval. If a heartbeat is not received within the interval, the Identity Data Store 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

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}] ...