--- title: Leader Based Replication Synchronization Provider description: The Leader Based Replication Synchronization Provider provides leader based eventually consistent replication of data across multiple directory server instances. component: pingds version: 8.1 page_id: pingds:configref:objects-leader-based-replication-synchronization-provider canonical_url: https://docs.pingidentity.com/pingds/8.1/configref/objects-leader-based-replication-synchronization-provider.html section_ids: parent: Parent dependencies: Dependencies leader_based_replication_synchronization_provider_properties: Leader Based Replication Synchronization Provider properties basic_properties: Basic properties advertised-listen-address: advertised-listen-address bootstrap-replication-server: bootstrap-replication-server enabled: enabled key-manager-provider: key-manager-provider replication-port: replication-port replication-purge-delay: replication-purge-delay ssl-cert-nickname: ssl-cert-nickname ssl-cipher-suite: ssl-cipher-suite ssl-protocol: ssl-protocol trust-manager-provider: trust-manager-provider advanced_properties: Advanced properties java-class: java-class solve-conflicts: solve-conflicts --- # Leader Based Replication Synchronization Provider The Leader Based Replication Synchronization Provider provides leader based eventually consistent replication of data across multiple directory server instances. ## Parent The Leader Based Replication Synchronization Provider object inherits from [Synchronization Provider](objects-synchronization-provider.html). ## Dependencies Leader Based Replication Synchronization Providers depend on the following objects: * [Key Manager Provider](objects-key-manager-provider.html) * [Trust Manager Provider](objects-trust-manager-provider.html) Leader Based Replication Synchronization Providers depend on the following objects: * [Leader Based Replication Domain](objects-leader-based-replication-domain.html) ## Leader Based Replication Synchronization Provider properties You can use configuration expressions to set property values at startup time. For details, see [Property value substitution](expressions.html). | Basic Properties | Advanced Properties | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | | [advertised-listen-address](#advertised-listen-address) [bootstrap-replication-server](#bootstrap-replication-server) [enabled](#enabled) [key-manager-provider](#key-manager-provider) [replication-port](#replication-port) [replication-purge-delay](#replication-purge-delay) [ssl-cert-nickname](#ssl-cert-nickname) [ssl-cipher-suite](#ssl-cipher-suite) [ssl-protocol](#ssl-protocol) [trust-manager-provider](#trust-manager-provider) | [java-class](#java-class) [solve-conflicts](#solve-conflicts) | ### Basic properties Use the `--advanced` option to access advanced properties. ### advertised-listen-address | | | | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------- | | *Synopsis* | The advertised address(es) which clients should use for connecting to this Leader Based Replication Synchronization Provider. | | *Description* | Multiple addresses may be provided as separate values for this attribute. The meta-address 0.0.0.0 is not permitted. | | *Default value* | None | | *Allowed values* | A hostname or an IP address. | | *Multi-valued* | Yes | | *Required* | Yes | | *Admin action required* | None | | *Advanced* | No | | *Read-only* | No | ### bootstrap-replication-server | | | | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | *Synopsis* | The addresses of one or more replication servers within the topology which this server should connect to in order to discover the rest of the topology. | | *Description* | Addresses must be specified using the replication port of the remote replication servers using the syntax "hostname:repl-port". When using an IPv6 address as the hostname, put brackets around the address as in "\[IPv6Address]:repl-port". | | *Default value* | Adding a replication server or a replication domain requires this to be filled. | | *Allowed values* | A host name or an IP address followed by a ":" and a port number.Port number must be greater than 1 and less than 65535. | | *Multi-valued* | Yes | | *Required* | No | | *Admin action required* | None | | *Advanced* | No | | *Read-only* | No | ### enabled | | | | ----------------------- | ------------------------------------------------------------------ | | *Synopsis* | Indicates whether the Synchronization Provider is enabled for use. | | *Default value* | None | | *Allowed values* | truefalse | | *Multi-valued* | No | | *Required* | Yes | | *Admin action required* | None | | *Advanced* | No | | *Read-only* | No | ### key-manager-provider | | | | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | | *Synopsis* | Specifies the name of the key manager that should be used with this Leader Based Replication Synchronization Provider. | | *Default value* | None | | *Allowed values* | The name of an existing [key-manager-provider](objects-key-manager-provider.html).The referenced key manager provider must be enabled. | | *Multi-valued* | No | | *Required* | Yes | | *Admin action required* | NoneChanges to this property take effect immediately, but only for subsequent attempts to access the key manager provider for associated client connections. | | *Advanced* | No | | *Read-only* | No | ### replication-port | | | | ----------------------- | -------------------------------------------------------------------------------- | | *Synopsis* | The port on which the directory server listens for the replication LDAP traffic. | | *Default value* | None | | *Allowed values* | An integer.Lower limit: 1.Upper limit: 65535. | | *Multi-valued* | No | | *Required* | Yes | | *Admin action required* | None | | *Advanced* | No | | *Read-only* | No | ### replication-purge-delay | | | | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | *Synopsis* | Minimum lifetime of changelog data and old replication meta-data in directory entries. Changelog data and replication meta-data older than this setting is eligible to be removed. | | *Description* | After the purge delay has passed, the server removes old changelog data over time when it applies new updates. Replication meta-data is stored in changed directory entries. The server removes old replication meta-data either when the entry is next modified, or by a dedicated purge task, whichever happens first. The server temporarily stops removing old data when it has been unable to process updates for an extended period of time. For example, the server stops removing data when the server is offline, and when it cannot access other servers due to a network partition. Once old data is removed, the server can no longer use it for replication. Changelog and replication meta-data older than the purge delay must therefore be considered stale. Backups must be newer than the purge delay, including the time it takes to restore a backup. | | *Default value* | 3 days | | *Allowed values* | Uses [duration syntax](duration-syntax.html).Lower limit: 0 seconds. | | *Multi-valued* | No | | *Required* | No | | *Admin action required* | None | | *Advanced* | No | | *Read-only* | No | ### ssl-cert-nickname | | | | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | *Synopsis* | Specifies the nicknames (also called the aliases) of the keys or key pairs that the Leader Based Replication Synchronization Provider should use when performing SSL communication. | | *Description* | The property can be used multiple times (referencing different nicknames) when server certificates with different public key algorithms are used in parallel (for example, RSA, DSA, and ECC-based algorithms). When a nickname refers to an asymmetric (public/private) key pair, the nickname for the public key certificate and associated private key entry must match exactly. A single nickname is used to retrieve both the public key and the private key. This is only applicable when the Leader Based Replication Synchronization Provider is configured to use SSL. | | *Default value* | Let the server decide. | | *Allowed values* | A string. | | *Multi-valued* | Yes | | *Required* | No | | *Admin action required* | Restart the server for changes to take effect. | | *Advanced* | No | | *Read-only* | No | ### ssl-cipher-suite | | | | ----------------------- | ------------------------------------------------------------------------------------------------------------------------- | | *Synopsis* | Specifies the names of the SSL cipher suites that are allowed for use in SSL or TLS communication. | | *Default value* | Uses the default set of SSL cipher suites provided by the server's JVM. | | *Allowed values* | A string. | | *Multi-valued* | Yes | | *Required* | No | | *Admin action required* | NoneChanges to this property take effect immediately but only impact new SSL/TLS-based sessions created after the change. | | *Advanced* | No | | *Read-only* | No | ### ssl-protocol | | | | ----------------------- | ------------------------------------------------------------------------------------------------------------------------- | | *Synopsis* | Specifies the names of the SSL protocols that are allowed for use in SSL or TLS communication. | | *Default value* | Uses the default set of SSL protocols provided by the server's JVM. | | *Allowed values* | A string. | | *Multi-valued* | Yes | | *Required* | No | | *Admin action required* | NoneChanges to this property take effect immediately but only impact new SSL/TLS-based sessions created after the change. | | *Advanced* | No | | *Read-only* | No | ### trust-manager-provider | | | | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | *Synopsis* | Specifies the name of the trust manager that should be used with the Leader Based Replication Synchronization Provider. | | *Default value* | None | | *Allowed values* | The name of an existing [trust-manager-provider](objects-trust-manager-provider.html).The referenced trust manager provider must be enabled. | | *Multi-valued* | Yes | | *Required* | Yes | | *Admin action required* | NoneChanges to this property take effect immediately, but only for subsequent attempts to access the trust manager provider for associated client connections. | | *Advanced* | No | | *Read-only* | No | ## Advanced properties Use the `--advanced` option to access advanced properties. ### java-class | | | | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | *Synopsis* | Specifies the fully-qualified name of the Java class that provides the Leader Based Replication Synchronization Provider implementation. | | *Default value* | org.forgerock.opendj.server.leaderbasedreplication.LeaderBasedReplication | | *Allowed values* | A Java class that extends or implements:- org.opends.server.api.SynchronizationProvider | | *Multi-valued* | No | | *Required* | Yes | | *Admin action required* | None | | *Advanced* | Yes | | *Read-only* | No | ### solve-conflicts | | | | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | *Synopsis* | Indicates if this server solves conflict. | | *Description* | This boolean indicates if this domain keeps the historical meta-data necessary to solve conflicts. When set to false the server will not maintain historical meta-data 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 value* | true | | *Allowed values* | truefalse | | *Multi-valued* | No | | *Required* | No | | *Admin action required* | None | | *Advanced* | Yes | | *Read-only* | No |