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 Data Sync 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.
Start the sync pipes named "Sync Pipe 1" and "Sync Pipe 2" on the Data Sync Server. Do not prompt for connection arguments:
realtime-sync start --pipe-name "Sync Pipe 1" --pipe-name "Sync Pipe 2" \
--bindPassword password --no-prompt
Stop synchronization globally, i.e. for all Sync Pipes:
realtime-sync stop --port 389 --bindDN "cn=Directory Manager" \
--bindPassword password
Set the startpoint for the Sync Pipe named "Sync Pipe 1" to the end of the changelog at the source servers. Changes made prior to the current time will be ignored. Once synchronization is started, only changes made after this command was run will be detected at the Sync Source and applied at the Sync Destination:
realtime-sync set-startpoint --end-of-changelog --pipe-name "Sync Pipe 1" \
--port 389 --bindDN "cn=Directory Manager" --bindPassword password
Set the startpoint for the Sync Pipe named "Sync Pipe 1" to change number 1234 at "External Server 1". Changes made prior to this change at any source server will be ignored by this Sync Pipe:
realtime-sync set-startpoint --change-number 1234 \
--server-name "External Server 1" --pipe-name "Sync Pipe 1" \
--bindPassword password --no-prompt
Set the startpoint for the Sync Pipe named "Sync Pipe 1" to 2 hours and 30 minutes ago at the first available source server. Changes made prior to that point at any source server will be ignored by this Sync Pipe:
realtime-sync set-startpoint --startpoint-rewind 2h30m \
--pipe-name "Sync Pipe 1" --bindPassword password --no-prompt
For examples and help with LDAP options see LDAP Option Help. For help with SASL authentication, see SASL Option Help
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
--pipe-name {sync-pipe-name}
| Description | The name of the Sync Pipe that the command applies to |
| Required | Yes |
| Multi-Valued | No |
--beginning-of-changelog
| Description | Set the startpoint to the beginning of the changelog at all source servers |
--end-of-changelog
| Description | Set the startpoint to the end of the changelog at all source servers |
--change-number {change-number}
| Description | A change number corresponding to an entry in the changelog. Synchronization will pick up with this change when the Sync Pipe is started |
| Required | No |
| Multi-Valued | No |
--change-sequence-number {CSN}
| Description | A replication change sequence number corresponding to a the change in the changelog. Synchronization will pick up with this change when the Sync Pipe is started |
| Required | No |
| Multi-Valued | No |
--startpoint-rewind {startpoint-rewind-duration}
| Description | Allows you to specify a specific amount of time to rewind the startpoint in the changelog. This is a duration string that indicates how far back in the changelog (relative to the current time) that real-time synchronization should begin. The duration string must specify the unit (e.g. "10m"). The value can be comprised of multiple duration specifiers, for example "1d15m25s" |
| Required | No |
| Multi-Valued | No |
--server-name {server-name}
| Description | The name of the External Server to which the --change-number or --startpoint-rewind arguments apply. This must be first available server in the list of source servers for the Sync Source. The tool will verify this for you |
| Required | No |
| Multi-Valued | No |
Start synchronization either globally or for the specified Sync Pipes
--pipe-name {sync-pipe-name}
| Description | The name of the Sync Pipe that the command applies to |
| Required | No |
| Multi-Valued | Yes |
--applyChangeTo [server-group|single-server]
| Description | Controls whether changes apply to a single server or all servers in the configuration server group |
| Allowed Values |
single-server server-group |
| Required | No |
| Multi-Valued | No |
Stop synchronization either globally or for the specified Sync Pipes
--pipe-name {sync-pipe-name}
| Description | The name of the Sync Pipe that the command applies to |
| Required | No |
| Multi-Valued | Yes |
--applyChangeTo [server-group|single-server]
| Description | Controls whether changes apply to a single server or all servers in the configuration server group |
| Allowed Values |
single-server server-group |
| Required | No |
| Multi-Valued | No |
-V
--version
| Description | Display Data Sync Server version information |
-H
--help
| Description | Display general usage information |
--help-ldap
| Description | Display help for using LDAP options |
--help-sasl
| Description | Display help for using SASL options |
--help-debug
| Description | Display help for using debug options |
| Advanced | Yes |
-Z
--useSSL
| Description | Use SSL for secure communication with the server |
-q
--useStartTLS
| Description | Use StartTLS to secure communication with the server |
--useNoSecurity
| Description | Use no security when communicating with the server |
-h {host}
--hostname {host}
| Description | Data Sync Server hostname or IP address |
| Default Value | localhost |
| Required | No |
| Multi-Valued | No |
-p {port}
--port {port}
| Description | Data Sync Server port number |
| Default Value | 389 |
| Required | No |
| Multi-Valued | No |
-D {bindDN}
--bindDN {bindDN}
| Description | DN used to bind to the server |
| Default Value | cn=Directory Manager |
| Required | No |
| Multi-Valued | No |
-w {bindPassword}
--bindPassword {bindPassword}
| Description | Password used to bind to the server |
| Required | No |
| Multi-Valued | No |
-j {bindPasswordFile}
--bindPasswordFile {bindPasswordFile}
| Description | Bind password file |
| Required | No |
| Multi-Valued | No |
-o {name=value}
--saslOption {name=value}
| Description | SASL bind options |
| Required | No |
| Multi-Valued | Yes |
-X
--trustAll
| Description | Trust all server SSL certificates |
-P {truststorePath}
--trustStorePath {truststorePath}
| Description | Certificate truststore path |
| Default Value | /home/rocky/workspace/Core-Release-Pipeline/build/package/PingDataSync/config/truststore |
| Required | No |
| Multi-Valued | No |
-T {truststorePassword}
--trustStorePassword {truststorePassword}
| Description | Certificate truststore PIN |
| Required | No |
| Multi-Valued | No |
-U {path}
--trustStorePasswordFile {path}
| Description | Certificate truststore PIN file |
| Required | No |
| Multi-Valued | No |
--trustStoreFormat {trustStoreFormat}
| Description | Certificate truststore format |
| Required | No |
| Multi-Valued | No |
-K {keystorePath}
--keyStorePath {keystorePath}
| Description | Certificate keystore path |
| Required | No |
| Multi-Valued | No |
-W {keystorePassword}
--keyStorePassword {keystorePassword}
| Description | Certificate keystore PIN |
| Required | No |
| Multi-Valued | No |
-u {keystorePasswordFile}
--keyStorePasswordFile {keystorePasswordFile}
| Description | Certificate keystore PIN file |
| Required | No |
| Multi-Valued | No |
--keyStoreFormat {keyStoreFormat}
| Description | Certificate keystore format |
| Required | No |
| Multi-Valued | No |
-N {nickname}
--certNickname {nickname}
| Description | Nickname of the certificate for SSL client authentication |
| Required | No |
| Multi-Valued | No |
--propertiesFilePath {propertiesFilePath}
| Description | Path to the file that contains default property values used for command-line arguments |
| Required | No |
| Multi-Valued | No |
--usePropertiesFile
| Description | Specify that a properties file will be used to get default command-line argument values |
--script-friendly
| Description | Use script-friendly mode |
--task
| Description | Indicates that this tool should be invoked as a task which runs inside the Data Sync Server rather than as a separate process. At present, this argument is optional, but in a future release it may be required for running as a task |
-t {startTime}
--start {startTime}
| Description | Indicates the date/time, expressed in format 'YYYYMMDDhhmmss', when the operation starts when scheduled as a server task. A value of '0' causes the task to be scheduled for immediate execution. When this option is specified, the operation is scheduled to start at the specified time, after which this utility will exit immediately |
| Required | No |
| Multi-Valued | No |
--startAlert
| Description | Generate an administrative alert when the task starts running |
--successAlert
| Description | Generate an administrative alert when the task completes successfully |
--errorAlert
| Description | Generate an administrative alert when the task fails to complete successfully |
--startNotify {emailAddress}
| Description | Email address of a recipient to be notified when this task starts running |
| Required | No |
| Multi-Valued | Yes |
--completionNotify {emailAddress}
| Description | Email address of a recipient to be notified when the task completes, regardless of whether it succeeded or failed |
| Required | No |
| Multi-Valued | Yes |
--successNotify {emailAddress}
| Description | Email address of a recipient to be notified when this task completes successfully |
| Required | No |
| Multi-Valued | Yes |
--errorNotify {emailAddress}
| Description | Email address of a recipient to be notified if an error occurs when this task executes |
| Required | No |
| Multi-Valued | Yes |
--dependency {taskID}
| Description | ID of a task upon which this task depends. A task will not start execution until all its dependencies have completed execution |
| Required | No |
| Multi-Valued | Yes |
--failedDependencyAction {action}
| Description | Action this task will take should one of its dependent tasks fail. The value must be one of the following: PROCESS,CANCEL,DISABLE. If not specified, the default value is CANCEL |
| Required | No |
| Multi-Valued | Yes |
-Q
--quiet
| Description | Use quiet mode |
--noPropertiesFile
| Description | Specify that no properties file will be used to get default command-line argument values |
--help-subcommands
| Description | Display all available subcommands for use with this tool |
-n
--no-prompt
| Description | Use non-interactive mode. If data in the command is missing, you will not be prompted and the tool will fail |