backup

Description

Back up one or more Synchronization Server backends.

Each backend backup is stored in a separate backend backup directory. A backend backup directory may contain multiple backups of the backend. Each backend backup directory contains a backup.info file providing information about each backup in the directory and an archive file for each backup. The name of the archive file includes both the backend ID and the backup ID. The backup ID may be provided to the backup command, or an ID is generated from a current timestamp.

Backups may be full or incremental. The archive file for incremental backups contains the incremental changes since a previous backup. Each backup can be optionally compressed, encrypted, hashed or signed. A backup taken on one system can be restored on another sytem. This is often the easiest way to initialize a new replica.

This tool features both an offline mode of operation as well as the ability to schedule an operation to run within the Synchronization Server's process. To schedule an operation supply LDAP connection options 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

backup --backupDirectory backups --backUpAll

backup --backupDirectory backups/userRoot --backendID userRoot \
     --backupID monday

backup --backupDirectory backups/userRoot --backendID userRoot --incremental \
     --incrementalBaseID monday

backup --task --hostname server1 --port 389 \
     --bindDN uid=admin,dc=example,dc=com --bindPassword password \
     --backupDirectory backups --backUpAll

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}

--useAdministrativeSession

--propertiesFilePath {propertiesFilePath}

--usePropertiesFile

--script-friendly

--task

-t {startTime}
--start {startTime}

--completionNotify {emailAddress}

--errorNotify {emailAddress}

--dependency {taskID}

--failedDependencyAction {action}

-Q
--quiet

-n {backendName}
--backendID {backendName}

-a
--backUpAll

-I {backupID}
--backupID {backupID}

-d {backupDir}
--backupDirectory {backupDir}

-i
--incremental

-B {backupID}
--incrementalBaseID {backupID}

-c
--compress

-y
--encrypt

-A
--hash

-s
--signHash

--logFilePath {logFilePath}