7321N/A<?
xml version="1.0" encoding="UTF-8"?>
7321N/A ! This work is licensed under the Creative Commons 7321N/A ! Attribution-NonCommercial-NoDerivs 3.0 Unported License. 7321N/A ! To view a copy of this license, visit 7321N/A ! or send a letter to Creative Commons, 444 Castro Street, 7321N/A ! Suite 900, Mountain View, California, 94041, USA. 7321N/A ! You can also obtain a copy of the license at 7321N/A ! See the License for the specific language governing permissions 7321N/A ! and limitations under the License. 7321N/A ! If applicable, add the following below this CCPL HEADER, with the fields 7321N/A ! enclosed by brackets "[]" replaced with your own identifying information: 7321N/A ! Portions Copyright [yyyy] [name of copyright owner] 7321N/A ! Copyright 2011-2014 ForgeRock AS 7321N/A<
refentry xml:
id='dsreplication-1' 7321N/A version='5.0' xml:
lang='en' 7321N/A <
info><
copyright><
year>2011-2014</
year><
holder>ForgeRock AS</
holder></
copyright></
info>
7321N/A <
refentrytitle>dsreplication</
refentrytitle><
manvolnum>1</
manvolnum>
7321N/A <
refmiscinfo class="software">OpenDJ</
refmiscinfo>
7321N/A <
refmiscinfo class="version"><?
eval ${
docTargetVersion}?></
refmiscinfo>
7321N/A <
refname>dsreplication</
refname>
7321N/A <
refpurpose>manage OpenDJ directory data replication</
refpurpose>
7321N/A <
command>dsreplication</
command>
7321N/A <
command><
replaceable>subcommand</
replaceable></
command>
7321N/A <
para>This utility can be used to configure replication between servers so
7321N/A that the data of the servers is synchronized. For replication to work you
7321N/A must first enable replication using the <
command>enable</
command> subcommand
7321N/A and then initialize the contents of one of the servers with the contents of
7321N/A the other using the <
command>initialize</
command> subcommand.</
para>
7321N/A <
title>Global Options</
title>
7321N/A <
para>The following options are supported.</
para>
7321N/A <
term><
option>--advanced</
option></
term>
7321N/A <
para>Access advanced settings when running this command in interactive
7321N/A <
term><
option>-b, --baseDN {baseDN}</
option></
term>
7321N/A <
para>Base DN of the data to be replicated, initialized or for which you
7321N/A want to disable replication. Multiple base DNs can be provided by using
7321N/A this option multiple times.</
para>
7321N/A <
title>LDAP Connection Options</
title>
7321N/A <
term><
option>--connectTimeout {timeout}</
option></
term>
7321N/A <
para>Maximum length of time (in milliseconds) that can be taken to
7321N/A establish a connection. Use '0' to specify no time out.</
para>
7321N/A <
para>Default value: 30000</
para>
7321N/A <
term><
option>-h, --hostname {host}</
option></
term>
7321N/A <
para>Directory server hostname or IP address</
para>
7321N/A <
term><
option>-I, --adminUID {adminUID}</
option></
term>
7321N/A <
para>User ID of the global administrator to use to bind to the server.
7321N/A For the <
command>enable</
command> subcommand, if no global administrator
7321N/A was defined previously for any servers, the global administrator will be
7321N/A created using the UID provided.</
para>
7321N/A <
para>Default value: admin</
para>
7321N/A <
term><
option>-j, --adminPasswordFile {bindPasswordFile}</
option></
term>
7321N/A <
para>Global administrator password file</
para>
7321N/A <
term><
option>-K, --keyStorePath {keyStorePath}</
option></
term>
7321N/A <
para> Certificate key store path</
para>
7321N/A <
term><
option>-N, --certNickname {nickname}</
option></
term>
7321N/A <
para>Nickname of certificate for SSL client authentication</
para>
7321N/A <
term><
option>-o, --saslOption {name=value}</
option></
term>
7321N/A <
para>SASL bind options</
para>
7321N/A <
term><
option>-p, --port {port}</
option></
term>
7321N/A <
para>Directory server administration port number</
para>
7321N/A <
para>Default value: 4444</
para>
7321N/A <
term><
option>-P, --trustStorePath {trustStorePath}</
option></
term>
7321N/A <
para>Certificate trust store path</
para>
7321N/A <
term><
option>-T, --trustStorePassword {trustStorePassword}</
option></
term>
7321N/A <
para>Certificate trust store PIN</
para>
7321N/A <
term><
option>-u, --keyStorePasswordFile {keyStorePasswordFile}</
option></
term>
7321N/A <
para>Certificate key store PIN file</
para>
7321N/A <
term><
option>-U, --trustStorePasswordFile {path}</
option></
term>
7321N/A <
para>Certificate trust store PIN file</
para>
7321N/A <
term><
option>-w, --adminPassword {bindPassword}</
option></
term>
7321N/A <
para>Password for the global administrator</
para>
7321N/A <
term><
option>-W, --keyStorePassword {keyStorePassword}</
option></
term>
7321N/A <
para>Certificate key store PIN</
para>
7321N/A <
term><
option>-X, --trustAll</
option></
term>
7321N/A <
para>Trust all server SSL certificates</
para>
7321N/A <
term><
option>--commandFilePath {path}</
option></
term>
7321N/A <
para>The full path to the file where the equivalent non-interactive
7321N/A commands will be written when this command is run in interactive
7321N/A <
term><
option>--displayCommand</
option></
term>
7321N/A <
para>Display the equivalent non-interactive option on standard output
7321N/A when this command is run in interactive mode.</
para>
7321N/A <
term><
option>-n, --no-prompt</
option></
term>
7321N/A <
para>Use non-interactive mode. If data in the command is missing, the
7321N/A user is not prompted and the command exits with an error.</
para>
7321N/A <
term><
option>--noPropertiesFile</
option></
term>
7321N/A <
para>No properties file will be used to get default command line
7321N/A <
term><
option>--propertiesFilePath {propertiesFilePath}</
option></
term>
7321N/A <
para>Path to the file containing default property values used for
7321N/A command line arguments</
para>
7321N/A <
term><
option>-Q, --quiet</
option></
term>
7321N/A <
para>Do not write progress information to standard output</
para>
7321N/A <
title>General Options</
title>
7321N/A <
term><
option>--version</
option></
term>
7321N/A <
para>Display version information</
para>
7321N/A <
term><
option>-?, -H, --help</
option></
term>
7321N/A <
para>Display usage information</
para>
7321N/A <
para>The command completed successfully.</
para>
7321N/A <
para>An error occurred.</
para>
7321N/A <
para>The following subcommands are supported.</
para>
7321N/A <
term><
command>disable</
command></
term>
7321N/A <
para>Disable replication on the specified server for the provided base
7321N/A DN and removes references in the other servers with which it is
7321N/A <
title>Subcommand Options</
title>
7321N/A In addition to global options, these subcommand options are supported.
7321N/A <
term><
option>-a, --disableAll</
option></
term>
7321N/A Disable the replication configuration on the specified server. The
7321N/A contents of the server are no longer replicated and the replication server
7321N/A (changelog and replication port) is disabled if it is configured.
7321N/A <
term><
option>-D, --bindDN {bindDN}</
option></
term>
7321N/A DN to use to bind to the server where we want to disable replication. This
7321N/A option must be used when no Global Administrator has been defined on the
7321N/A server or if the user does not want to remove references in the other
7321N/A replicated servers. The password provided for the Global Administrator
7321N/A will be used when specifying this option.
7321N/A Default value: cn=Directory Manager
7321N/A <
term><
option>--disableReplicationServer</
option></
term>
7321N/A Disable the replication server. The replication port and change log are
7321N/A disabled on the specified server.
7321N/A <
term><
option>-h, --hostname {host}</
option></
term>
7321N/A Directory server hostname or IP address
7321N/A Default value: <
replaceable>configured-hostname</
replaceable>
7321N/A <
term><
option>-p, --port {port}</
option></
term>
7321N/A Directory server administration port number
7321N/A Default value: <
replaceable>configured-admin-port</
replaceable>
7321N/A <
term><
command>enable</
command></
term>
7321N/A <
para>Update the configuration of the servers to replicate the data
7321N/A under the specified base DN. If one of the specified servers is already
7321N/A replicating the data under the base DN with other servers, executing this
7321N/A subcommand will update the configuration of all the servers. Thus it is
7321N/A sufficient to execute the command line once for each server added to the
7321N/A replication topology.</
para>
7321N/A <
title>Subcommand Options</
title>
7321N/A In addition to global options, these subcommand options are supported.
7321N/A <
term><
option>-h, --host1 {host}</
option></
term>
7321N/A Fully qualified host name or IP address of the first server whose contents
7321N/A Default value: <
replaceable>configured-hostname</
replaceable>
7321N/A <
term><
option>-p, --port1 {port}</
option></
term>
7321N/A Directory server administration port number of the first server whose
7321N/A contents will be replicated.
7321N/A Default value: <
replaceable>configured-admin-port</
replaceable>
7321N/A <
term><
option>-D, --bindDN1 {bindDN}</
option></
term>
7321N/A DN to use to bind to the first server whose contents will be replicated.
7321N/A If not specified the global administrator will be used to bind.
7321N/A Default value: cn=Directory Manager
7321N/A <
term><
option>--bindPassword1 {bindPassword}</
option></
term>
7321N/A Password to use to bind to the first server whose contents will be
7321N/A replicated. If no bind DN was specified for the first server the password
7321N/A of the global administrator will be used to bind.
7321N/A <
term><
option>--bindPasswordFile1 {bindPasswordFile}</
option></
term>
7321N/A File containing the password to use to bind to the first server whose
7321N/A contents will be replicated. If no bind DN was specified for the first
7321N/A server the password of the global administrator will be used to bind.
7321N/A <
term><
option>-r, --replicationPort1 {port}</
option></
term>
7321N/A Port that will be used by the replication mechanism in the first server to
7321N/A communicate with the other servers. You have to specify this option only
7321N/A if replication was not previously configured in the first server.
7321N/A <
term><
option>--secureReplication1</
option></
term>
7321N/A Specifies whether or not the communication through the replication port of
7321N/A the first server is encrypted or not. This option will only be taken into
7321N/A account the first time replication is configured on the first server.
7321N/A <
term><
option>--noReplicationServer1</
option></
term>
7321N/A Do not configure a replication port or change log on the first server. The
7321N/A first server will contain replicated data but will not contain a change log
7321N/A of modifications made to the replicated data. Note that each replicated
7321N/A topology must contain at least two servers with a change log to avoid a
7321N/A <
term><
option>--onlyReplicationServer1</
option></
term>
7321N/A Configure only a change log and replication port on the first server. The
7321N/A first server will not contain replicated data, but will contain a change
7321N/A log of the modifications made to the replicated data on other servers.
7321N/A <
term><
option>-O, --host2 {host}</
option></
term>
7321N/A Fully qualified host name or IP address of the second server whose contents
7321N/A Default value: <
replaceable>configured-hostname</
replaceable>
7321N/A <
term><
option>--port2 {port}</
option></
term>
7321N/A Directory server administration port number of the second server whose
7321N/A contents will be replicated.
7321N/A Default value: <
replaceable>configured-admin-port</
replaceable>
7321N/A <
term><
option>--bindDN2 {bindDN}</
option></
term>
7321N/A DN to use to bind to the second server whose contents will be replicated.
7321N/A If not specified the global administrator will be used to bind.
7321N/A Default value: cn=Directory Manager
7321N/A <
term><
option>--bindPassword2 {bindPassword}</
option></
term>
7321N/A Password to use to bind to the second server whose contents will be
7321N/A replicated. If no bind DN was specified for the second server the password
7321N/A of the global administrator will be used to bind.
7321N/A <
term><
option>-F, --bindPasswordFile2 {bindPasswordFile}</
option></
term>
7321N/A File containing the password to use to bind to the second server whose
7321N/A contents will be replicated. If no bind DN was specified for the second
7321N/A server the password of the global administrator will be used to bind.
7321N/A <
term><
option>-R, --replicationPort2 {port}</
option></
term>
7321N/A Port that will be used by the replication mechanism in the second server to
7321N/A communicate with the other servers. You have to specify this option only
7321N/A if replication was not previously configured in the second server.
7321N/A <
term><
option>--secureReplication2</
option></
term>
7321N/A Specifies whether or not the communication through the replication port of
7321N/A the second server is encrypted or not. This option will only be taken into
7321N/A account the first time replication is configured on the second server.
7321N/A <
term><
option>--noReplicationServer2</
option></
term>
7321N/A Do not configure a replication port or change log on the second server. The
7321N/A second server will contain replicated data but will not contain a change
7321N/A log of modifications made to the replicated data. Note that each replicated
7321N/A topology must contain at least two servers with a change log to avoid a
7321N/A <
term><
option>--onlyReplicationServer2</
option></
term>
7321N/A Configure only a change log and replication port on the second server. The
7321N/A second server will not contain replicated data, but will contain a change
7321N/A log of the modifications made to the replicated data on other servers.
7321N/A <
term><
option>-S, --skipPortCheck</
option></
term>
7321N/A Skip the check to determine whether the specified replication ports are
7321N/A <
term><
option>--noSchemaReplication</
option></
term>
7321N/A Do not replicate the schema between the servers.
7321N/A <
term><
option>--useSecondServerAsSchemaSource</
option></
term>
7321N/A Use the second server to initialize the schema of the first server. If
7321N/A this option nor option --noSchemaReplication are specified the schema of
7321N/A the first server will be used to initialize the schema of the second server.
7321N/A <
term><
command>initialize</
command></
term>
7321N/A <
para>Initialize the contents of the data under the specified base DN
7321N/A on the destination server with the contents on the source server. This
7321N/A operation is required after enabling replication in order replication to
7321N/A work. <
command>initialize-all</
command> can also be used for this
7321N/A <
title>Subcommand Options</
title>
7321N/A In addition to global options, these subcommand options are supported.
7321N/A <
term><
option>-h, --hostSource {host}</
option></
term>
7321N/A Fully qualified host name or IP address of the source server whose contents
7321N/A will be used to initialize the destination server.
7321N/A Default value: <
replaceable>configured-hostname</
replaceable>
7321N/A <
term><
option>-p, --portSource {port}</
option></
term>
7321N/A Directory server administration port number of the source server whose
7321N/A contents will be used to initialize the destination server.
7321N/A Default value: <
replaceable>configured-admin-port</
replaceable>
7321N/A <
term><
option>-O, --hostDestination {host}</
option></
term>
7321N/A Fully qualified host name or IP address of the destination server whose
7321N/A contents will be initialized.
7321N/A Default value: <
replaceable>configured-hostname</
replaceable>
7321N/A <
term><
option>--portDestination {port}</
option></
term>
7321N/A Directory server administration port number of the destination server whose
7321N/A contents will be initialized.
7321N/A Default value: <
replaceable>configured-admin-port</
replaceable>
7321N/A <
term><
command>initialize-all</
command></
term>
7321N/A <
para>Initialize the contents of the data under the specified base DN
7321N/A on all the servers whose contents are being replicated with the contents
7321N/A on the specified server. This operation is required after enabling
7321N/A replication for replication to work. Run <
command>initialize</
command>
7321N/A for each server to achieve the same effect.</
para>
7321N/A <
title>Subcommand Options</
title>
7321N/A In addition to global options, these subcommand options are supported.
7321N/A <
term><
option>-h, --hostname {host}</
option></
term>
7321N/A Directory server hostname or IP address
7321N/A Default value: <
replaceable>configured-hostname</
replaceable>
7321N/A <
term><
option>-p, --port {port}</
option></
term>
7321N/A Directory server administration port number
7321N/A Default value: <
replaceable>configured-admin-port</
replaceable>
7321N/A <
term><
command>post-external-initialization</
command></
term>
7321N/A <
para>This subcommand must be called after initializing the contents of
7321N/A all the replicated servers using the <
command>import-ldif</
command>
7321N/A command, or by copying the database. You must specify the list of base DNs
7321N/A that have been initialized, and you must provide the credentials of any
7321N/A of the servers that are being replicated. See
7321N/A <
command>pre-external-initialization --help</
command> for more
7321N/A <
title>Subcommand Options</
title>
7321N/A In addition to global options, these subcommand options are supported.
7321N/A <
term><
option>-h, --hostname {host}</
option></
term>
7321N/A Directory server hostname or IP address
7321N/A Default value: <
replaceable>configured-hostname</
replaceable>
7321N/A <
term><
option>-p, --port {port}</
option></
term>
7321N/A Directory server administration port number
7321N/A Default value: <
replaceable>configured-admin-port</
replaceable>
7321N/A <
term><
command>pre-external-initialization</
command></
term>
7321N/A <
para>This subcommand must be called before initializing the contents
7321N/A of all the replicated servers using the <
command>import-ldif</
command>
7321N/A command, or by copying the database. You must specify the list of base DNs
7321N/A that have been initialized, and you must provide the credentials of any
7321N/A of the servers that are being replicated. After calling this subcommand,
7321N/A initialize the contents of all the servers in the topology, either by
7321N/A using the same LDIF file or by copying the database to each of the
7321N/A servers, then call the <
command>post-external-initialization</
command>
7321N/A <
title>Subcommand Options</
title>
7321N/A In addition to global options, these subcommand options are supported.
7321N/A <
term><
option>-h, --hostname {host}</
option></
term>
7321N/A Directory server hostname or IP address
7321N/A Default value: <
replaceable>configured-hostname</
replaceable>
7321N/A <
term><
option>-p, --port {port}</
option></
term>
7321N/A Directory server administration port number
7321N/A Default value: <
replaceable>configured-admin-port</
replaceable>
7321N/A <
term><
command>purge-historical</
command></
term>
7321N/A <
para>Launch a purge processing of the historical information stored
7321N/A in the user entries by replication. Since this processing may take a
7321N/A while, you must specify a maximum duration.</
para>
7321N/A <
title>Subcommand Options</
title>
7321N/A In addition to global options, these subcommand options are supported.
7321N/A <
term><
option>-h, --hostname {host}</
option></
term>
7321N/A Directory server hostname or IP address
7321N/A Default value: <
replaceable>configured-hostname</
replaceable>
7321N/A <
term><
option>-p, --port {port}</
option></
term>
7321N/A Directory server administration port number
7321N/A Default value: <
replaceable>configured-admin-port</
replaceable>
7321N/A <
term><
option>--maximumDuration {maximum duration}</
option></
term>
7321N/A This argument specifies the maximum duration the purge processing must last
7321N/A <
term><
option>-t, --start {startTime}</
option></
term>
7321N/A Indicates the
date/
time at which this operation will start when scheduled
7321N/A as a server task expressed in YYYYMMDDhhmmssZ format for UTC time or
7321N/A YYYYMMDDhhmmss for local time. A value of '0' will cause the task to be
7321N/A scheduled for immediate execution. When this option is specified the
7321N/A operation will be scheduled to start at the specified time after which this
7321N/A utility will exit immediately.
7321N/A <
term><
option>--recurringTask {schedulePattern}</
option></
term>
7321N/A Indicates the task is recurring and will be scheduled according to the
7321N/A value argument expressed in crontab(5) compatible
time/
date pattern
7321N/A <
term><
option>--completionNotify {emailAddress}</
option></
term>
7321N/A Email address of a recipient to be notified when the task completes. This
7321N/A option may be specified more than once.
7321N/A <
term><
option>--errorNotify {emailAddress}</
option></
term>
7321N/A Email address of a recipient to be notified if an error occurs when this
7321N/A task executes. This option may be specified more than once.
7321N/A <
term><
option>--dependency {taskID}</
option></
term>
7321N/A ID of a task upon which this task depends. A task will not start execution
7321N/A until all its dependencies have completed execution.
7321N/A <
term><
option>--failedDependencyAction {action}</
option></
term>
7321N/A Action this task will take should one if its dependent tasks fail. The
7321N/A value must be one of PROCESS,CANCEL,DISABLE. If not specified defaults to
7321N/A <
term><
command>status</
command></
term>
7321N/A <
para>Display a list with the basic replication configuration of the
7321N/A base DNs of the servers defined in the registration information. If
7321N/A no base DNs are specified as parameter, information for all base DNs
7321N/A <
title>Subcommand Options</
title>
7321N/A In addition to global options, these subcommand options are supported.
7321N/A <
term><
option>-h, --hostname {host}</
option></
term>
7321N/A Directory server hostname or IP address
7321N/A Default value: <
replaceable>configured-hostname</
replaceable>
7321N/A <
term><
option>-p, --port {port}</
option></
term>
7321N/A Directory server administration port number
7321N/A Default value: <
replaceable>configured-admin-port</
replaceable>
7321N/A <
term><
option>-s, --script-friendly</
option></
term>
7321N/A <
para>The following example enables and then initializes replication
7321N/A$ <
userinput>dsreplication enable -I admin -w password -X -n -b dc=example,dc=com \
7321N/A --bindPassword1 password --replicationPort1 8989 \
7321N/A --bindPassword2 password --replicationPort2 8989</
userinput>
7321N/A<
computeroutput>Establishing connections ..... Done.
7321N/AChecking registration information ..... Done.
7321N/AUpdating replication configuration for baseDN dc=example,dc=com on server
7321N/AUpdating replication configuration for baseDN dc=example,dc=com on server
7321N/AUpdating registration configuration on server
7321N/AUpdating registration configuration on server
7321N/AUpdating replication configuration for baseDN cn=schema on server
7321N/AUpdating replication configuration for baseDN cn=schema on server
7321N/AReplication has been successfully enabled. Note that for replication to
7321N/A work you must initialize the contents of the base DN's that are being
7321N/A replicated (use dsreplication initialize to do so).
7321N/Afor a detailed log of this operation.</
computeroutput>
7321N/A$ <
userinput>dsreplication initialize-all -I admin -w password -X -n -b dc=example,dc=com \
7321N/A<
computeroutput>Initializing base DN dc=example,dc=com with the contents from
7321N/ABase DN initialized successfully.
7321N/Afor a detailed log of this operation.</
computeroutput>