Replication Service Discovery Mechanism

A Replication Service Discovery Mechanism returns the set of directory servers participating in a replication topology.

The Replication Service Discovery Mechanism specifies the replication servers whose configuration is periodically read to discover available replicas.

Parent

The Replication Service Discovery Mechanism object inherits from Service Discovery Mechanism.

Dependencies

Replication Service Discovery Mechanisms depend on the following objects:

Properties

Use the --advanced option to access advanced properties.

Basic Properties

bind-dn

SynopsisThe bind DN for periodically reading replication server configurations
DescriptionThe bind DN must be present on all replication servers and directory servers, it must be able to read the server configuration.
Default ValueNone
Allowed ValuesA valid DN.
Multi-valuedNo
RequiredYes
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

bind-password

SynopsisThe clear-text bind password for periodically reading replication server configurations.
DescriptionThe bind password must be the same on all replication and directory servers.
Default ValueNone
Allowed ValuesA string.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

bind-password-environment-variable

SynopsisSpecifies the name of the environment variable that contains the clear-text bind password for periodically reading replication server configurations.
DescriptionThe bind password must be the same on all replication and directory servers.
Default ValueNone
Allowed ValuesA string.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
Changes to this property will take effect the next time that the Replication Service Discovery Mechanism is accessed.
AdvancedNo
Read-OnlyNo

bind-password-file

SynopsisSpecifies the path to the text file whose only contents should be a single line containing the clear-text bind password for periodically reading replication server configurations.
DescriptionThe bind password must be the same on all replication and directory servers.
Default ValueNone
Allowed ValuesA string.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
Changes to this property will take effect the next time that the Replication Service Discovery Mechanism is accessed.
AdvancedNo
Read-OnlyNo

bind-password-property

SynopsisSpecifies the name of the Java property that contains the clear-text bind password for periodically reading replication server configurations.
DescriptionThe bind password must be the same on all replication and directory servers.
Default ValueNone
Allowed ValuesA string.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
Changes to this property will take effect the next time that the Replication Service Discovery Mechanism is accessed.
AdvancedNo
Read-OnlyNo

discovery-interval

SynopsisInterval between two replication server configuration discovery queries.
DescriptionSpecifies how frequently to query a replication server configuration in order to discover information about available directory server replicas.
Default Value60s
Allowed ValuesA duration. Lower limit: 1 seconds.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

key-manager-provider

SynopsisSpecifies the name of the key manager that should be used with this Replication Service Discovery Mechanism.
Default ValueNone
Allowed ValuesThe name of an existing Key Manager Provider. The referenced key manager provider must be enabled when the Replication Service Discovery Mechanism is enabled and configured to use SSL or StartTLS.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
Changes to this property take effect immediately, but only for subsequent attempts to access the key manager provider for associated client connections.
AdvancedNo
Read-OnlyNo

primary-group-id

SynopsisReplication domain group ID of preferred directory server replicas.
DescriptionDirectory server replicas with this replication domain group ID will be preferred over other directory server replicas. Secondary server replicas will only be used when all primary server replicas become unavailable.
Default ValueAll the server replicas will be treated the same.
Allowed ValuesAn integer. Lower limit: 0.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

replication-server

SynopsisSpecifies the list of replication servers to contact periodically when discovering server replicas.
DescriptionSince the replication servers will be contacted to perform this administrative task, the administration port should be used to ensure timely responses in all circumstances.
Default ValueNone
Allowed ValuesA host name followed by a ":" and the administration port number.
Multi-valuedYes
RequiredYes
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

ssl-cert-nickname

SynopsisSpecifies the nicknames (also called the aliases) of the keys or key pairs that the Replication Service Discovery Mechanism should use when performing SSL communication. 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.
DescriptionThis is only applicable when the Replication Service Discovery Mechanism is configured to use SSL.
Default ValueLet the server decide.
Allowed ValuesA string.
Multi-valuedYes
RequiredNo
Admin Action RequiredThe object must be disabled and re-enabled for changes to take effect.
AdvancedNo
Read-OnlyNo

trust-manager-provider

SynopsisSpecifies the name of the trust manager that should be used with the Replication Service Discovery Mechanism.
Default ValueNone
Allowed ValuesThe name of an existing Trust Manager Provider. The referenced trust manager provider must be enabled when the Replication Service Discovery Mechanism is enabled.
Multi-valuedNo
RequiredYes
Admin Action RequiredNone
Changes to this property take effect immediately, but only for subsequent attempts to access the trust manager provider for associated client connections.
AdvancedNo
Read-OnlyNo

use-ssl

SynopsisIndicates whether the Replication Service Discovery Mechanism should use SSL.
DescriptionIf enabled, the Replication Service Discovery Mechanism will use SSL to encrypt communication with the clients.
Default Valuefalse
Allowed Valuestrue
false
Multi-valuedNo
RequiredNo
Admin Action RequiredThe object must be disabled and re-enabled for changes to take effect.
AdvancedNo
Read-OnlyNo

use-start-tls

SynopsisIndicates whether the Replication Service Discovery Mechanism should use Start TLS.
DescriptionIf enabled, the Replication Service Discovery Mechanism will use Start TLS to encrypt communication with remote servers.
Default Valuefalse
Allowed Valuestrue
false
Multi-valuedNo
RequiredNo
Admin Action RequiredThe object must be disabled and re-enabled for changes to take effect.
AdvancedNo
Read-OnlyNo

Advanced Properties

java-class

SynopsisSpecifies the fully-qualified name of the Java class that provides the Replication Service Discovery Mechanism implementation.
Default Valueorg.opends.server.discovery.ReplicationServiceDiscoveryMechanism
Allowed ValuesA Java class that extends or implements:
org.opends.server.discovery.ServiceDiscoveryMechanism
Multi-valuedNo
RequiredYes
Admin Action RequiredThe object must be disabled and re-enabled for changes to take effect.
AdvancedYes
Read-OnlyNo