backup
Prev | Directory Server Tools | Next

## Name

backup — back up OpenDJ directory data

## Synopsis

`backup`

## Description

This utility can be used to back up one or more Directory Server backends.

## Options

The backup command takes the following options:

Command options:

`-a | --backUpAll`

  Back up all backends in the server.

  Default: false

`-A | --hash`

  Generate a hash of the backup contents.

  Default: false

`-B | --incrementalBaseID {backupID}`

  Backup ID of the source archive for an incremental backup.

`-c | --compress`

  Compress the backup contents.

  Default: false

`-d | --backupDirectory {backupDir}`

  Path to the target directory for the backup file(s).

`-i | --incremental`

  Perform an incremental backup rather than a full backup.

  Default: false

`-I | --backupID {backupID}`

  Use the provided identifier for the backup.

`-n | --backendID {backendName}`

  Backend ID for the backend to archive.

`--offline`

  Indicates that the command must be run in offline mode.

  Default: false

`-s | --signHash`

  Sign the hash of the backup contents.

  Default: false

`-y | --encrypt`

  Encrypt the backup contents.

  Default: false

Task Backend Connection Options

`--connectTimeout {timeout}`

  Maximum length of time (in milliseconds) that can be taken to establish a connection. Use '0' to specify no time out.

  Default: 30000

`-D | --bindDN {bindDN}`

  DN to use to bind to the server.

  Default: cn=Directory Manager

`-h | --hostname {host}`

  The fully-qualified directory server host name that will be used when generating self-signed certificates for LDAP SSL/StartTLS, the administration connector, and replication.

  Default: localhost.localdomain

`-j | --bindPasswordFile {bindPasswordFile}`

  Bind password file.

`-K | --keyStorePath {keyStorePath}`

  Certificate key store path.

`-N | --certNickname {nickname}`

  Nickname of the certificate that the server should use when accepting SSL-based connections or performing StartTLS negotiation.

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

  SASL bind options.

`-p | --port {port}`

  Directory server administration port number.

  Default: 4444

`-P | --trustStorePath {trustStorePath}`

  Certificate trust store path.

`-T | --trustStorePassword {trustStorePassword}`

  Certificate trust store PIN.

`-u | --keyStorePasswordFile {keyStorePasswordFile}`

  Certificate key store PIN file. A PIN is required when you specify to use an existing certificate as server certificate.

`-U | --trustStorePasswordFile {path}`

  Certificate trust store PIN file.

`-w | --bindPassword {bindPassword}`

  Password to use to bind to the server. Use -w - to ensure that the command prompts for the password, rather than entering the password as a command argument.

`-W | --keyStorePassword {keyStorePassword}`

  Certificate key store PIN. A PIN is required when you specify to use an existing certificate as server certificate.

`-X | --trustAll`

  Trust all server SSL certificates.

  Default: false

Task Scheduling Options

`--completionNotify {emailAddress}`

  Email address of a recipient to be notified when the task completes. 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.

`--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.

`--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.

`--recurringTask {schedulePattern}`

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

`-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 '0' 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.

Utility input/output options:

`--noPropertiesFile`

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

  Default: false

`--propertiesFilePath {propertiesFilePath}`

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

General options:

`-V | --version`

  Display Directory Server version information.

  Default: false

`-H | --help`

  Display this usage information.

  Default: false

## Exit Codes

0

  The command completed successfully.

1

  An error occurred.

## Examples

The following example backs up all user data while the server is online.

    $ backup -p 4444 -D "cn=Directory Manager" -w password \
     -a -d /path/to/opendj/bak -t 0
    Backup task 20110613143801866 scheduled to start ...

The following example schedules back up of all user data every night at 2 AM when the server is online, and notifies diradmin@example.com when finished, or on error.

    $ backup -p 4444 -D "cn=Directory Manager" -w password -a \
     -d /path/to/opendj/bak --recurringTask "00 02 * * *" \
     --completionNotify diradmin@example.com --errorNotify diradmin@example.com
    Recurring Backup task BackupTask-988d6adf-4d65-44bf-8546-6ea74a2480b0
    scheduled successfully

The following example backs up all user data while the server is offline.

    $ stop-ds
    Stopping Server...
    ...

    $ backup --backupAll --backupDirectory /path/to/opendj/bak
    ... msg=The backup process completed successfully

    $ start-ds
    ... The Directory Server has started successfully

Prev | Up | Next
Directory Server Tools | Home | backendstat