Replication Server

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

Dependencies

The following objects have Replication Servers:

Replication Server Properties

You can use configuration expressions to set property values at startup time. For details, see Property Value Substitution.

Basic Properties Advanced Properties

advertised-listen-address
changelog-enabled
changelog-enabled-excluded-domains
cipher-key-length
cipher-transformation
confidentiality-enabled
degraded-status-threshold
listen-address
replication-db-directory
replication-port
weight

allow-updates-policy
allow-updates-server-fingerprints
disk-full-threshold
disk-low-threshold

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 Replication Server.

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

changelog-enabled

Synopsis

Specifies whether the "cn=changelog" backend will be available to client applications.

Default Value

enabled

Allowed Values

  • disabled: The "cn=changelog" backend will not be available to client applications.

  • enabled: The "cn=changelog" backend will be available to client applications. It will support searches using changelog cookies and "change numbers" as per the internet draft, http://tools.ietf.org/html/draft-good-ldap-changelog-04. Change numbers are globally consistent across all servers. This mode requires additional CPU, disk accesses and storage, so it should not be used unless change number based browsing is required.

  • enabled-cookie-mode-only: The "cn=changelog" backend will be available to client applications. However, it will only support searches using changelog cookies. Changes are published immediately, and in an order which may vary from one server to another. This mode does not require additional server resources.

Multi-valued

No

Required

No

Admin Action Required

None

Advanced

No

Read-Only

No

changelog-enabled-excluded-domains

Synopsis

Specifies the base DNs of domains to exclude from the change number indexer when changelog is enabled.

Default Value

When changelog is enabled, searches using "change numbers" is available for all domains (in other words, change number indexer includes all domains).

Allowed Values

A valid DN.

Multi-valued

Yes

Required

No

Admin Action Required

None

Advanced

No

Read-Only

No

cipher-key-length

Synopsis

Specifies the key length in bits for the preferred cipher.

Default Value

128

Allowed Values

An integer.

Lower limit: 0.

Multi-valued

No

Required

No

Admin Action Required

None

Changes to this property take effect immediately but only affect cryptographic operations performed after the change.

Advanced

No

Read-Only

No

cipher-transformation

Synopsis

Specifies the cipher for the directory server. The syntax is "algorithm/mode/padding".

Description

The 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 Value

AES/GCM/NoPadding

Allowed Values

A string.

Multi-valued

No

Required

No

Admin Action Required

None

Changes to this property take effect immediately but only affect cryptographic operations performed after the change.

Advanced

No

Read-Only

No

confidentiality-enabled

Synopsis

Indicates 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.

Description

Confidentiality 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 Value

false

Allowed Values

true

false

Multi-valued

No

Required

No

Admin Action Required

None

Changes to this property take effect immediately but only affect operations performed after the change.

Advanced

No

Read-Only

No

degraded-status-threshold

Synopsis

The number of pending changes as threshold value for putting a directory server in degraded status.

Description

This 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 Value

5000

Allowed Values

An integer.

Lower limit: 0.

Multi-valued

No

Required

No

Admin Action Required

None

Advanced

No

Read-Only

No

listen-address

Synopsis

The network interface(s) on which this Replication Server should listen for incoming client connections.

Description

Multiple addresses may be provided as separate values for this attribute. If no values are provided, then the directory server will listen on all interfaces.

Default Value

0.0.0.0

Allowed Values

A hostname or an IP address.

Multi-valued

Yes

Required

No

Admin Action Required

None

Advanced

No

Read-Only

No

replication-db-directory

Synopsis

The path where the Replication Server stores all persistent information.

Default Value

changelogDb

Allowed Values

A string.

Multi-valued

No

Required

Yes

Admin Action Required

None

Advanced

No

Read-Only

Yes

replication-port

Synopsis

The port on which this Replication Server waits for connections from other Replication Servers or Directory Servers.

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

weight

Synopsis

The weight of the replication server.

Description

The 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 Value

1

Allowed Values

An integer.

Lower limit: 1.

Multi-valued

No

Required

No

Admin Action Required

None

Advanced

No

Read-Only

No

Advanced Properties

Use the --advanced option to access advanced properties.

allow-updates-policy

Synopsis

Define how to allow servers to send updates to this replication server

Description

The replication server will only accept updates from servers allowed by the specified strategy. It will discard updates coming from servers which are not allowed, without processing them nor storing them in its changelog.

Default Value

all

Allowed Values

  • all: All servers can send updates.

  • verify-certificate-fingerprint: Only servers whose certificate fingerprint is listed in allow-updates-server-fingerprints can send updates

  • verify-certificate-key-usage: Only servers whose certificates' ExtendedKeyUsage includes 1.3.6.1.4.1.36733.2.1.10.1 can send updates

Multi-valued

No

Required

No

Admin Action Required

None

Advanced

Yes

Read-Only

No

allow-updates-server-fingerprints

Synopsis

Lists the certificate fingerprints of servers allowed to send updates to this replication server.

Description

This property is only applicable when allow-updates-policy is set to verify-certificate-fingerprint. In that case, this replication server will only process updates coming from servers whose certificates have a fingerprint matching one of the specified values.

Default Value

None

Allowed Values

A certificate fingerprint prefixed by its algorithm in curly braces.

Multi-valued

Yes

Required

No

Admin Action Required

None

Advanced

Yes

Read-Only

No

disk-full-threshold

Synopsis

The free disk space threshold at which point a warning alert notification will be triggered and the replication server will disconnect from the rest of the replication topology.

Description

When the available free space on the disk used by the replication changelog falls below the value specified, this replication server will stop. Connected Directory Servers will fail over to another RS. The replication server will restart again as soon as free space rises above the low threshold.

Default Value

5% of the filesystem size, plus 1 GB

Allowed Values

Uses size syntax.

Multi-valued

No

Required

No

Admin Action Required

None

Advanced

Yes

Read-Only

No

disk-low-threshold

Synopsis

The free disk space threshold at which point a warning alert notification will be triggered.

Description

When the available free space on the disk used by the replication changelog falls below the value specified, a warning is sent and logged. Normal operation will continue but administrators are advised to take action to free some disk space.

Default Value

5% of the filesystem size, plus 5 GB

Allowed Values

Uses size syntax.

Multi-valued

No

Required

No

Admin Action Required

None

Advanced

Yes

Read-Only

No