realtime-sync

Description

Control real-time synchronization including starting and stopping synchronization globally or for individual Sync Pipes; and setting the start point for real-time synchronization so that changes made before a specified time are ignored.

The 'start' and 'stop' subcommands can be used to pause or unpause synchronization. If synchronization is stopped and then restarted, then changes made at the Sync Source while synchronization was stopped will still be detected and applied. Synchronization for individual Sync Pipes can be started or stopped using the --pipe-name argument (starting synchronization for a Sync Pipe that is already started has no effect, as does stopping synchronization for a Sync Pipe that is already stopped). If the --pipe-name argument is omitted, then synchronization is started or stopped globally.

The 'set-startpoint' subcommand is run while a Sync Pipe is stopped. It instructs the Sync Pipe to ignore all changes made prior to a specific point in the changelog. Once synchronization is started, only changes made after that point will be detected at the Sync Source and applied at the Sync Destination. This command is often run during the initial setup before starting real-time synchronization for the first time. It should be run prior to initializing the data in the Sync Destination, which is usually done either by using the 'resync' command or by exporting data from the Sync Source, running 'translate-ldif', and then importing the data into the Sync Destination.

This tool schedules an operation to run within the Synchronization Server's process. LDAP connection options must be supplied that allow this tool to communicate with the server through its task interface. Tasks can be scheduled to run immediately or at a later time (see Task Scheduling Options below). Once scheduled, tasks can be managed using the manage-tasks tool.

Examples

realtime-sync start --pipe-name "Sync Pipe 1" --pipe-name "Sync Pipe 2" \
     --bindPassword password --no-prompt

realtime-sync stop --port 389 --bindDN "cn=Directory Manager" \
     --bindPassword password

realtime-sync set-startpoint --end-of-changelog --pipe-name "Sync Pipe 1" \
     --port 389 --bindDN "cn=Directory Manager" --bindPassword password

realtime-sync set-startpoint --change-number 1234 \
     --server-name "External Server 1" --pipe-name "Sync Pipe 1" \
     --bindPassword password --no-prompt

realtime-sync set-startpoint --startpoint-rewind 2h30m \
     --pipe-name "Sync Pipe 1" --bindPassword password --no-prompt

Subcommands

Set the startpoint for where real-time synchronization should begin when synchronization is started for the specified Sync Pipe. The startpoint can be set at the beginning or end of the changelog, or at a specific change number, or even a specific time in the past

Start synchronization either globally or for the specified Sync Pipes

Stop synchronization either globally or for the specified Sync Pipes

Arguments

-V
--version

-H
--help

--help-ldap

--help-sasl

--help-debug

-Z
--useSSL

-q
--useStartTLS

--useNoSecurity

-h {host}
--hostname {host}

-p {port}
--port {port}

-D {bindDN}
--bindDN {bindDN}

-w {bindPassword}
--bindPassword {bindPassword}

-j {bindPasswordFile}
--bindPasswordFile {bindPasswordFile}

-o {name=value}
--saslOption {name=value}

-X
--trustAll

-P {trustStorePath}
--trustStorePath {trustStorePath}

-T {trustStorePassword}
--trustStorePassword {trustStorePassword}

-U {path}
--trustStorePasswordFile {path}

-K {keyStorePath}
--keyStorePath {keyStorePath}

-W {keyStorePassword}
--keyStorePassword {keyStorePassword}

-u {keyStorePasswordFile}
--keyStorePasswordFile {keyStorePasswordFile}

-N {nickname}
--certNickname {nickname}

--propertiesFilePath {propertiesFilePath}

--usePropertiesFile

--script-friendly

--task

-t {startTime}
--start {startTime}

--completionNotify {emailAddress}

--errorNotify {emailAddress}

--dependency {taskID}

--failedDependencyAction {action}

-Q
--quiet

--noPropertiesFile

--help-subcommands

-n
--no-prompt