Replication Domain

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

Dependencies

The following objects belong to Replication Domains:

The following objects have Replication Domains:

Properties

Use the --advanced option to access advanced properties.

Basic Properties

assured-sd-level

SynopsisThe level of acknowledgment for Safe Data assured sub mode.
DescriptionWhen assured replication is configured in Safe Data mode, this value defines the number of replication servers (with the same group ID of the local server) that should acknowledge the sent update before the LDAP client call can return.
Default Value1
Allowed ValuesAn integer. Lower limit: 1. Upper limit: 127.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

assured-timeout

SynopsisThe timeout value when waiting for assured replication acknowledgments.
DescriptionDefines the amount of milliseconds the server will wait for assured acknowledgments (in either Safe Data or Safe Read assured replication modes) before returning anyway the LDAP client call.
Default Value2000ms
Allowed ValuesA duration. Lower limit: 1 milliseconds.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

assured-type

SynopsisDefines the assured replication mode of the replicated domain.
DescriptionThe assured replication can be disabled or enabled. When enabled, two modes are available: Safe Data or Safe Read modes.
Default Valuenot-assured
Allowed Values

not-assured: Assured replication is not enabled. Updates sent for replication (for being replayed on other LDAP servers in the topology) are sent without waiting for any acknowledgment and the LDAP client call returns immediately.

safe-data: Assured replication is enabled in Safe Data mode: updates sent for replication are subject to acknowledgment from the replication servers that have the same group ID as the local server (defined with the group-id property). The number of acknowledgments to expect is defined by the assured-sd-level property. After acknowledgments are received, LDAP client call returns.

safe-read: Assured replication is enabled in Safe Read mode: updates sent for replication are subject to acknowledgments from the LDAP servers in the topology that have the same group ID as the local server (defined with the group-id property). After acknowledgments are received, LDAP client call returns.

Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

base-dn

SynopsisSpecifies the base DN of the replicated data.
Default ValueNone
Allowed ValuesA valid DN.
Multi-valuedNo
RequiredYes
Admin Action RequiredNone
AdvancedNo
Read-OnlyYes

conflicts-historical-purge-delay

SynopsisThis delay indicates the time (in minutes) the domain keeps the historical information necessary to solve conflicts.When a change stored in the historical part of the user entry has a date (from its replication ChangeNumber) older than this delay, it is candidate to be purged. The purge is applied on 2 events: modify of the entry, dedicated purge task.
Default Value1440m
Allowed ValuesA duration. Lower limit: 0 minutes.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

fractional-exclude

SynopsisAllows to exclude some attributes to replicate to this server.
DescriptionIf fractional-exclude configuration attribute is used, attributes specified in this attribute will be ignored (not added/modified/deleted) when an operation performed from another directory server is being replayed in the local server. Note that the usage of this configuration attribute is mutually exclusive with the usage of the fractional-include attribute.
Default ValueNone
Allowed ValuesThe name of one or more attribute types in the named object class to be excluded. The object class may be "*" indicating that the attribute type(s) should be excluded regardless of the type of entry they belong to.
Multi-valuedYes
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

fractional-include

SynopsisAllows to include some attributes to replicate to this server.
DescriptionIf fractional-include configuration attribute is used, only attributes specified in this attribute will be added/modified/deleted when an operation performed from another directory server is being replayed in the local server. Note that the usage of this configuration attribute is mutually exclusive with the usage of the fractional-exclude attribute.
Default ValueNone
Allowed ValuesThe name of one or more attribute types in the named object class to be included. The object class may be "*" indicating that the attribute type(s) should be included regardless of the type of entry they belong to.
Multi-valuedYes
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

group-id

SynopsisThe group ID associated with this replicated domain.
DescriptionThis value defines the group ID of the replicated domain. The replication system will preferably connect and send updates to replicate to a replication server with the same group ID as its own one (the local server group ID).
Default Value1
Allowed ValuesAn integer. Lower limit: 1. Upper limit: 127.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

heartbeat-interval

SynopsisSpecifies the heartbeat interval that the directory server will use when communicating with Replication Servers.
DescriptionThe 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 Value10000ms
Allowed ValuesA duration. Lower limit: 100 milliseconds.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

initialization-window-size

SynopsisSpecifies the window size that this directory server may use when communicating with remote Directory Servers for initialization.
Default Value100
Allowed ValuesAn integer. Lower limit: 0.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

isolation-policy

SynopsisSpecifies 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 Valuereject-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 Servers 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-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

log-changenumber

SynopsisIndicates if this server logs the ChangeNumber in access log.
DescriptionThis boolean indicates if the domain should log the ChangeNumber of replicated operations in the access log.
Default Valuefalse
Allowed Valuestrue
false
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

referrals-url

SynopsisThe URLs other LDAP servers should use to refer to the local server.
DescriptionURLs used by peer servers in the topology to refer to the local server through LDAP referrals. If this attribute is not defined, every URLs available to access this server will be used. If defined, only URLs specified here will be used.
Default ValueNone
Allowed ValuesA LDAP URL compliant with RFC 2255.
Multi-valuedYes
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

replication-server

SynopsisSpecifies the addresses of the Replication Servers within the Replication Domain to which the directory server should try to connect at startup time.
DescriptionAddresses must be specified using the syntax: hostname:port
Default ValueNone
Allowed ValuesA host name followed by a ":" and a port number.
Multi-valuedYes
RequiredYes
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

server-id

SynopsisSpecifies a unique identifier for the directory server within the Replication Domain.
DescriptionEach 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 ValueNone
Allowed ValuesAn integer. Lower limit: 1. Upper limit: 65535.
Multi-valuedNo
RequiredYes
Admin Action RequiredNone
AdvancedNo
Read-OnlyYes

source-address

SynopsisIf specified, the server will bind to the address before connecting to the remote server.
DescriptionThe address must be one assigned to an existing network interface.
Default ValueLet the server decide.
Allowed ValuesAn IP address.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

Advanced Properties

changetime-heartbeat-interval

SynopsisSpecifies the heartbeat interval that the directory server will use when sending its local change time to the Replication Server.
DescriptionThe directory server sends a regular heartbeat to the Replication within the specified interval. The heartbeat indicates the change time of the directory server to the Replication Server.
Default Value1000ms
Allowed ValuesA duration. Lower limit: 0 milliseconds.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedYes
Read-OnlyNo

solve-conflicts

SynopsisIndicates if this server solves conflict.
DescriptionThis boolean indicates if this domain keeps the historical information necessary to solve conflicts. When set to false the server will not maintain historical information and will therefore not be able to solve conflict. This should therefore be done only if the replication is used in a single master type of deployment.
Default Valuetrue
Allowed Valuestrue
false
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedYes
Read-OnlyNo

window-size

SynopsisSpecifies the window size that the directory server will use when communicating with Replication Servers.
DescriptionThis option may be deprecated and removed in future releases.
Default Value100000
Allowed ValuesAn integer. Lower limit: 0.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedYes
Read-OnlyNo