Replication Server

Replication Servers publish updates to Directory Servers within a Replication Domain.

Dependencies

The following objects have Replication Servers:

Properties

Use the --advanced option to access advanced properties.

Basic Properties

assured-timeout

SynopsisThe timeout value when waiting for assured mode acknowledgments.
DescriptionDefines the number of milliseconds that the replication server will wait for assured acknowledgments (in either Safe Data or Safe Read assured sub modes) before forgetting them and answer to the entity that sent an update and is waiting for acknowledgment.
Default Value1000ms
Allowed ValuesA duration. Lower limit: 1 milliseconds.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

cipher-key-length

SynopsisSpecifies the key length in bits for the preferred cipher.
Default Value128
Allowed ValuesAn integer. Lower limit: 0.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
Changes to this property take effect immediately but only affect cryptographic operations performed after the change.
AdvancedNo
Read-OnlyNo

cipher-transformation

SynopsisSpecifies the cipher for the directory server. The syntax is "algorithm/mode/padding".
DescriptionThe full transformation is required: specifying only an algorithm and allowing the cipher provider to supply the default mode and padding is not supported, because there is no guarantee these default values are the same among different implementations. Some cipher algorithms, including RC4 and ARCFOUR, do not have a mode or padding, and hence must be specified using NONE for the mode field and NoPadding for the padding field. For example, RC4/NONE/NoPadding.
Default ValueAES/CBC/PKCS5Padding
Allowed ValuesA string.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
Changes to this property take effect immediately but only affect cryptographic operations performed after the change.
AdvancedNo
Read-OnlyNo

compute-change-number

SynopsisWhether the replication server will compute change numbers.
DescriptionThis boolean tells the replication server to compute change numbers for each replicated change by maintaining a change number index database. Changenumbers are computed according to http://tools.ietf.org/html/draft-good-ldap-changelog-04. Note this functionality has an impact on CPU, disk accesses and storage. If changenumbers are not required, it is advisable to set this value to false.
Default Valuetrue
Allowed Valuestrue
false
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

confidentiality-enabled

SynopsisIndicates whether the replication change-log should make records readable only by Directory Server. Throughput and disk space are affected by the more expensive operations taking place.
DescriptionConfidentiality is achieved by encrypting records on all domains managed by this replication server. Encrypting the records prevents unauthorized parties from accessing contents of LDAP operations. For complete protection, consider enabling secure communications between servers. Change number indexing is not affected by the setting.
Default Valuefalse
Allowed Valuestrue
false
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
Changes to this property take effect immediately but only affect operations performed after the change.
AdvancedNo
Read-OnlyNo

degraded-status-threshold

SynopsisThe number of pending changes as threshold value for putting a directory server in degraded status.
DescriptionThis value represents a number of pending changes a replication server has in queue for sending to a directory server. Once this value is crossed, the matching directory server goes in degraded status. When number of pending changes goes back under this value, the directory server is put back in normal status. 0 means status analyzer is disabled and directory servers are never put in degraded status.
Default Value5000
Allowed ValuesAn integer. Lower limit: 0.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

group-id

SynopsisThe group id for the replication server.
DescriptionThis value defines the group id of the replication server. The replication system of a LDAP server uses the group id of the replicated domain and tries to connect, if possible, to a replication with the same group id.
Default Value1
Allowed ValuesAn integer. Lower limit: 1. Upper limit: 127.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

monitoring-period

SynopsisThe period between sending of monitoring messages.
DescriptionDefines the duration that the replication server will wait before sending new monitoring messages to its peers (replication servers and directory servers). Larger values increase the length of time it takes for a directory server to detect and switch to a more suitable replication server, whereas smaller values increase the amount of background network traffic.
Default Value60s
Allowed ValuesA duration. Lower limit: 0 milliseconds.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

replication-db-directory

SynopsisThe path where the Replication Server stores all persistent information.
Default ValuechangelogDb
Allowed ValuesA string.
Multi-valuedNo
RequiredYes
Admin Action RequiredNone
AdvancedNo
Read-OnlyYes

replication-port

SynopsisThe port on which this Replication Server waits for connections from other Replication Servers or Directory Servers.
Default ValueNone
Allowed ValuesAn integer. Lower limit: 1. Upper limit: 65535.
Multi-valuedNo
RequiredYes
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

replication-purge-delay

SynopsisThe time (in seconds) after which the Replication Server erases all persistent information.
Default Value3 days
Allowed ValuesA duration. Lower limit: 0 seconds.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

replication-server

SynopsisSpecifies the addresses of other Replication Servers to which this Replication Server tries to connect at startup time.
DescriptionAddresses must be specified using the syntax: "hostname:port". If IPv6 addresses are used as the hostname, they must be specified using the syntax "[IPv6Address]:port".
Default ValueNone
Allowed ValuesA host name followed by a ":" and a port number.
Multi-valuedYes
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

replication-server-id

SynopsisSpecifies a unique identifier for the Replication Server.
DescriptionEach Replication Server must have a different server ID.
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

weight

SynopsisThe weight of the replication server.
DescriptionThe weight affected to the replication server. Each replication server of the topology has a weight. When combined together, the weights of the replication servers of a same group can be translated to a percentage that determines the quantity of directory servers of the topology that should be connected to a replication server. For instance imagine a topology with 3 replication servers (with the same group id) with the following weights: RS1=1, RS2=1, RS3=2. This means that RS1 should have 25% of the directory servers connected in the topology, RS2 25%, and RS3 50%. This may be useful if the replication servers of the topology have a different power and one wants to spread the load between the replication servers according to their power.
Default Value1
Allowed ValuesAn integer. Lower limit: 1.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

Advanced Properties

queue-size

SynopsisSpecifies the number of changes that are kept in memory for each directory server in the Replication Domain.
Default Value10000
Allowed ValuesAn integer. Lower limit: 0.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedYes
Read-OnlyNo

window-size

SynopsisSpecifies the window size that the Replication Server uses when communicating with other 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