t
Title: dsreplication
Author:
Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
Date: 01/17/2014
Manual: Tools Reference
Source: OpenDJ 2.7.0-SNAPSHOT
Language: English

"DSREPLICATION" "1" "01/17/2014" "OpenDJ 2.7.0-SNAPSHOT" "Tools Reference"
-----------------------------------------------------------------
* Define some portability stuff
-----------------------------------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
http://bugs.debian.org/507673
http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-----------------------------------------------------------------
* set default formatting
-----------------------------------------------------------------
disable hyphenation
disable justification (adjust text to left margin only)
-----------------------------------------------------------------
* MAIN CONTENT STARTS HERE *
-----------------------------------------------------------------
"NAME"
dsreplication - manage OpenDJ directory data replication
"SYNOPSIS"

\w'dsreplicationsubcommand 'u dsreplicationsubcommand [options]

"DESCRIPTION"

This utility can be used to configure replication between servers so that the data of the servers is synchronized. For replication to work you must first enable replication using the enable subcommand and then initialize the contents of one of the servers with the contents of the other using the initialize subcommand.

"GLOBAL OPTIONS"

The following options are supported.

--advanced

Access advanced settings when running this command in interactive mode.

-b, --baseDN {baseDN}

Base DN of the data to be replicated, initialized or for which you want to disable replication. Multiple base DNs can be provided by using this option multiple times.

"LDAP Connection Options"

--connectTimeout {timeout}

Maximum length of time (in milliseconds) that can be taken to establish a connection. Use \*(Aq0\*(Aq to specify no time out. Default value: 30000

-h, --hostname {host}

Directory server hostname or IP address Default value: localhost.localdomain

-I, --adminUID {adminUID}

User ID of the global administrator to use to bind to the server. For the enable subcommand, if no global administrator was defined previously for any servers, the global administrator will be created using the UID provided. Default value: admin

-j, --adminPasswordFile {bindPasswordFile}

Global administrator password file

-K, --keyStorePath {keyStorePath}

Certificate key store path

-N, --certNickname {nickname}

Nickname of certificate for SSL client authentication

-o, --saslOption {name=value}

SASL bind options

-p, --port {port}

Directory server administration port number Default value: 4444

-P, --trustStorePath {trustStorePath}

Certificate trust store path Default value: /path/to/opendj/config/admin-truststore

-T, --trustStorePassword {trustStorePassword}

Certificate trust store PIN

-u, --keyStorePasswordFile {keyStorePasswordFile}

Certificate key store PIN file

-U, --trustStorePasswordFile {path}

Certificate trust store PIN file

-w, --adminPassword {bindPassword}

Password for the global administrator

-W, --keyStorePassword {keyStorePassword}

Certificate key store PIN

-X, --trustAll

Trust all server SSL certificates

"Utility Input/Output Options"

--commandFilePath {path}

The full path to the file where the equivalent non-interactive commands will be written when this command is run in interactive mode.

--displayCommand

Display the equivalent non-interactive option on standard output when this command is run in interactive mode.

-n, --no-prompt

Use non-interactive mode. If data in the command is missing, the user is not prompted and the command exits with an error.

--noPropertiesFile

No properties file will be used to get default command line argument values

--propertiesFilePath {propertiesFilePath}

Path to the file containing default property values used for command line arguments

-Q, --quiet

Do not write progress information to standard output

"General Options"

--version

Display version information

-?, -H, --help

Display usage information

"EXIT CODES"

0

The command completed successfully.

> 0

An error occurred.

"SUBCOMMANDS"

The following subcommands are supported.

disable

Disable replication on the specified server for the provided base DN and removes references in the other servers with which it is replicating data. In addition to global options, these subcommand options are supported.

-a, --disableAll

Disable the replication configuration on the specified server. The contents of the server are no longer replicated and the replication server (changelog and replication port) is disabled if it is configured.

-D, --bindDN {bindDN}

DN to use to bind to the server where we want to disable replication. This option must be used when no Global Administrator has been defined on the server or if the user does not want to remove references in the other replicated servers. The password provided for the Global Administrator will be used when specifying this option. Default value: cn=Directory Manager

--disableReplicationServer

Disable the replication server. The replication port and change log are disabled on the specified server.

-h, --hostname {host}

Directory server hostname or IP address Default value: configured-hostname

-p, --port {port}

Directory server administration port number Default value: configured-admin-port

enable

Update the configuration of the servers to replicate the data under the specified base DN. If one of the specified servers is already replicating the data under the base DN with other servers, executing this subcommand will update the configuration of all the servers. Thus it is sufficient to execute the command line once for each server added to the replication topology. In addition to global options, these subcommand options are supported.

-h, --host1 {host}

Fully qualified host name or IP address of the first server whose contents will be replicated. Default value: configured-hostname

-p, --port1 {port}

Directory server administration port number of the first server whose contents will be replicated. Default value: configured-admin-port

-D, --bindDN1 {bindDN}

DN to use to bind to the first server whose contents will be replicated. If not specified the global administrator will be used to bind. Default value: cn=Directory Manager

--bindPassword1 {bindPassword}

Password to use to bind to the first server whose contents will be replicated. If no bind DN was specified for the first server the password of the global administrator will be used to bind.

--bindPasswordFile1 {bindPasswordFile}

File containing the password to use to bind to the first server whose contents will be replicated. If no bind DN was specified for the first server the password of the global administrator will be used to bind.

-r, --replicationPort1 {port}

Port that will be used by the replication mechanism in the first server to communicate with the other servers. You have to specify this option only if replication was not previously configured in the first server. Default value: 8989

--secureReplication1

Specifies whether or not the communication through the replication port of the first server is encrypted or not. This option will only be taken into account the first time replication is configured on the first server.

--noReplicationServer1

Do not configure a replication port or change log on the first server. The first server will contain replicated data but will not contain a change log of modifications made to the replicated data. Note that each replicated topology must contain at least two servers with a change log to avoid a single point of failure.

--onlyReplicationServer1

Configure only a change log and replication port on the first server. The first server will not contain replicated data, but will contain a change log of the modifications made to the replicated data on other servers.

-O, --host2 {host}

Fully qualified host name or IP address of the second server whose contents will be replicated. Default value: configured-hostname

--port2 {port}

Directory server administration port number of the second server whose contents will be replicated. Default value: configured-admin-port

--bindDN2 {bindDN}

DN to use to bind to the second server whose contents will be replicated. If not specified the global administrator will be used to bind. Default value: cn=Directory Manager

--bindPassword2 {bindPassword}

Password to use to bind to the second server whose contents will be replicated. If no bind DN was specified for the second server the password of the global administrator will be used to bind.

-F, --bindPasswordFile2 {bindPasswordFile}

File containing the password to use to bind to the second server whose contents will be replicated. If no bind DN was specified for the second server the password of the global administrator will be used to bind.

-R, --replicationPort2 {port}

Port that will be used by the replication mechanism in the second server to communicate with the other servers. You have to specify this option only if replication was not previously configured in the second server. Default value: 8989

--secureReplication2

Specifies whether or not the communication through the replication port of the second server is encrypted or not. This option will only be taken into account the first time replication is configured on the second server.

--noReplicationServer2

Do not configure a replication port or change log on the second server. The second server will contain replicated data but will not contain a change log of modifications made to the replicated data. Note that each replicated topology must contain at least two servers with a change log to avoid a single point of failure.

--onlyReplicationServer2

Configure only a change log and replication port on the second server. The second server will not contain replicated data, but will contain a change log of the modifications made to the replicated data on other servers.

-S, --skipPortCheck

Skip the check to determine whether the specified replication ports are usable.

--noSchemaReplication

Do not replicate the schema between the servers.

--useSecondServerAsSchemaSource

Use the second server to initialize the schema of the first server. If this option nor option --noSchemaReplication are specified the schema of the first server will be used to initialize the schema of the second server.

initialize

Initialize the contents of the data under the specified base DN on the destination server with the contents on the source server. This operation is required after enabling replication in order replication to work. initialize-all can also be used for this purpose. In addition to global options, these subcommand options are supported.

-h, --hostSource {host}

Fully qualified host name or IP address of the source server whose contents will be used to initialize the destination server. Default value: configured-hostname

-p, --portSource {port}

Directory server administration port number of the source server whose contents will be used to initialize the destination server. Default value: configured-admin-port

-O, --hostDestination {host}

Fully qualified host name or IP address of the destination server whose contents will be initialized. Default value: configured-hostname

--portDestination {port}

Directory server administration port number of the destination server whose contents will be initialized. Default value: configured-admin-port

initialize-all

Initialize the contents of the data under the specified base DN on all the servers whose contents are being replicated with the contents on the specified server. This operation is required after enabling replication for replication to work. Run initialize for each server to achieve the same effect. In addition to global options, these subcommand options are supported.

-h, --hostname {host}

Directory server hostname or IP address Default value: configured-hostname

-p, --port {port}

Directory server administration port number Default value: configured-admin-port

post-external-initialization

This subcommand must be called after initializing the contents of all the replicated servers using the import-ldif command, or by copying the database. You must specify the list of base DNs that have been initialized, and you must provide the credentials of any of the servers that are being replicated. See pre-external-initialization --help for more information. In addition to global options, these subcommand options are supported.

-h, --hostname {host}

Directory server hostname or IP address Default value: configured-hostname

-p, --port {port}

Directory server administration port number Default value: configured-admin-port

pre-external-initialization

This subcommand must be called before initializing the contents of all the replicated servers using the import-ldif command, or by copying the database. You must specify the list of base DNs that have been initialized, and you must provide the credentials of any of the servers that are being replicated. After calling this subcommand, initialize the contents of all the servers in the topology, either by using the same LDIF file or by copying the database to each of the servers, then call the post-external-initialization subcommand. In addition to global options, these subcommand options are supported.

-h, --hostname {host}

Directory server hostname or IP address Default value: configured-hostname

-p, --port {port}

Directory server administration port number Default value: configured-admin-port

purge-historical

Launch a purge processing of the historical information stored in the user entries by replication. Since this processing may take a while, you must specify a maximum duration. In addition to global options, these subcommand options are supported.

-h, --hostname {host}

Directory server hostname or IP address Default value: configured-hostname

-p, --port {port}

Directory server administration port number Default value: configured-admin-port

--maximumDuration {maximum duration}

This argument specifies the maximum duration the purge processing must last expressed in seconds. Default value: 3600

-t, --start {startTime}

Indicates the date/time at which this operation will start when scheduled as a server task expressed in YYYYMMDDhhmmssZ format for UTC time or YYYYMMDDhhmmss for local time. A value of \*(Aq0\*(Aq will cause the task to be scheduled for immediate execution. When this option is specified the operation will be scheduled to start at the specified time after which this utility will exit immediately.

--recurringTask {schedulePattern}

Indicates the task is recurring and will be scheduled according to the value argument expressed in crontab(5) compatible time/date pattern

--completionNotify {emailAddress}

Email address of a recipient to be notified when the task completes. This option may be specified more than once.

--errorNotify {emailAddress}

Email address of a recipient to be notified if an error occurs when this task executes. This option may be specified more than once.

--dependency {taskID}

ID of a task upon which this task depends. A task will not start execution until all its dependencies have completed execution.

--failedDependencyAction {action}

Action this task will take should one if its dependent tasks fail. The value must be one of PROCESS,CANCEL,DISABLE. If not specified defaults to CANCEL.

status

Display a list with the basic replication configuration of the base DNs of the servers defined in the registration information. If no base DNs are specified as parameter, information for all base DNs is displayed. In addition to global options, these subcommand options are supported.

-h, --hostname {host}

Directory server hostname or IP address Default value: configured-hostname

-p, --port {port}

Directory server administration port number Default value: configured-admin-port

-s, --script-friendly

Use script-friendly mode.

"EXAMPLES"

The following example enables and then initializes replication for a new replica on opendj2.example.com from an existing replica on opendj.example.com.

.\}

$ dsreplication enable -I admin -w password -X -n -b dc=example,dc=com
 --host1 opendj.example.com --port1 4444 --bindDN1 "cn=Directory Manager"
 --bindPassword1 password --replicationPort1 8989
 --host2 opendj2.example.com --port2 4444 --bindDN2 "cn=Directory Manager"
 --bindPassword2 password --replicationPort2 8989

Establishing connections ..... Done.
Checking registration information ..... Done.
Updating remote references on server opendj.example.com:4444 ..... Done.
Configuring Replication port on server opendj2.example.com:4444 ..... Done.
Updating replication configuration for baseDN dc=example,dc=com on server
 opendj.example.com:4444 ..... Done.
Updating replication configuration for baseDN dc=example,dc=com on server
 opendj2.example.com:4444 ..... Done.
Updating registration configuration on server
 opendj.example.com:4444 ..... Done.
Updating registration configuration on server
 opendj2.example.com:4444 ..... Done.
Updating replication configuration for baseDN cn=schema on server
 opendj.example.com:4444 ..... Done.
Updating replication configuration for baseDN cn=schema on server
 opendj2.example.com:4444 ..... Done.
Initializing registration information on server opendj2.example.com:4444 with
 the contents of server opendj.example.com:4444 ..... Done.
Initializing schema on server opendj2.example.com:4444 with the contents of
 server opendj.example.com:4444 ..... Done.

Replication has been successfully enabled. Note that for replication to
 work you must initialize the contents of the base DN\*(Aqs that are being
 replicated (use dsreplication initialize to do so).

See
/var/.../opends-replication-7958637258600693490.log
for a detailed log of this operation.
$ dsreplication initialize-all -I admin -w password -X -n -b dc=example,dc=com
 -h opendj.example.com -p 4444

Initializing base DN dc=example,dc=com with the contents from
 opendj.example.com:4444: 160 entries processed (100 % complete).
Base DN initialized successfully.

See
/var/.../opends-replication-5020375834904394170.log
for a detailed log of this operation.
.\}
"COPYRIGHT"

Copyright \(co 2011-2014 ForgeRock AS