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.
Replication Servers publish updates to Identity Data Store instances within a Replication Domain.
Replication Servers publish updates to Identity Data Store instances within a Replication Domain. They are created when replication is enabled using the dsreplication tool.
↓Relations From this Component
↓Properties
The following components have a direct composition relation to Replication Servers:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ replication-server-id | ↓ window-size |
| ↓ replication-db-directory | ↓ queue-size |
| ↓ replication-port | ↓ je-property |
| ↓ compression-criteria | ↓ replication-purge-delay |
| ↓ compression-mechanism | ↓ listen-on-all-addresses |
| ↓ compression-parameter | ↓ heartbeat-interval |
| ↓ gateway-priority | ↓ restricted-domain |
replication-server-id (Read-Only)
| 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 limit is 1. Upper limit is 65535 . |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The path where the Replication Server stores all persistent information. |
| Default Value | changelogDb |
| Allowed Values | Unknown |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | The Identity Data Store must be restarted for changes to this setting to take effect. Modification requires that the Identity Data Store be stopped, the database directory manually relocated, and then the Identity Data Store restarted. While the Identity Data Store is stopped, the old database directory and its contents must be manually moved or copied to the new location. |
| Description | The port on which this Replication Server waits for connections from other Replication Servers or Identity Data Store instances. |
| 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 |
| 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 are 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 |
| 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 |
| 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 |
| Description | Specifies the gateway priority of the Replication Server in the current location. The Replication Server acting as a gateway handles communication with servers in other locations. The highest priority value is 1 and the lowest value is 10. To prevent this Replication Server from ever assuming the gateway role, set the priority to 0. The gateway role is assumed by the Replication Server with the highest gateway priority. Multiple Replication Servers may, however, share the same priority value. In such case, the first Replication Server requesting the role will normally assume this role. See the Replication chapter in the Administration Guide for further details about the gateway election process. |
| Default Value | 5 |
| Allowed Values | An integer value. Lower limit is 0. Upper limit is 10 . |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
window-size (Advanced Property)
| Description | Specifies the maximum number of replication updates the Replication Server can have outstanding from each of the other Replication Servers. 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 remote 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 |
queue-size (Advanced Property)
| Description | Specifies the number of changes that are kept in memory for each Identity Data Store in the Replication Domain. |
| Default Value | 25000 |
| Allowed Values | An integer value. Lower limit is 0. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
je-property (Advanced Property)
| Description | Specifies the database and environment properties for the Berkeley DB Java Edition database for the replication changelog. Any Berkeley DB Java Edition property can be specified using the following form: property-name=property-value. Refer to the Identity Data Store documentation for further information on related properties, their implications, and range values. The definitive identification of all the property parameters is available in the example.properties file of Berkeley DB Java Edition distribution. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | Changes to this configuration property will only take effect if the associated multimaster replication synchronization provider is disabled and re-enabled (or the Identity Data Store is restarted). |
replication-purge-delay (Advanced Property)
| Description | The time (in seconds) after which the Replication Server erases all persistent information. |
| 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 |
listen-on-all-addresses (Advanced Property)
| Description | Indicates whether the Replication Server should listen on all addresses for this host. If set to FALSE, then the Replication Server will listen only to the address resolved from the hostname provided. |
| Default Value | true |
| Allowed Values | true false |
| 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. |
| Default Value | 15000ms |
| Allowed Values | A duration. Lower limit is 10000 milliseconds. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
restricted-domain (Advanced Property)
| Description | Specifies the base DN of domains that are only replicated between 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 | None |
| Allowed Values | A valid DN. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |