6330N/A<?
xml version="1.0" encoding="UTF-8"?>
6330N/A ! This work is licensed under the Creative Commons 6330N/A ! Attribution-NonCommercial-NoDerivs 3.0 Unported License. 6330N/A ! To view a copy of this license, visit 6330N/A ! or send a letter to Creative Commons, 444 Castro Street, 6330N/A ! Suite 900, Mountain View, California, 94041, USA. 6330N/A ! You can also obtain a copy of the license at 6330N/A ! See the License for the specific language governing permissions 6330N/A ! and limitations under the License. 6330N/A ! If applicable, add the following below this CCPL HEADER, with the fields 6330N/A ! enclosed by brackets "[]" replaced with your own identifying information: 6330N/A ! Portions Copyright [yyyy] [name of copyright owner] 6330N/A ! Copyright 2011-2012 ForgeRock AS 6330N/A ! Portions Copyright 2013 Jens Elkner 6330N/A <
refentrytitle><
application>backup</
application></
refentrytitle>
6330N/A <
xi:
include href="common.xml" xpointer='xpointer(//manvolnum[@name="v1m"])'/>
6330N/A <
refname><
application>backup</
application></
refname>
6330N/A <
refpurpose>back up OpenDJ directory data</
refpurpose>
6330N/A <
arg>-n <
replaceable class="parameter">backendName</
replaceable></
arg>
6330N/A xpointer='xpointer(//para[@name="s-task"]/*)'/>
6330N/A xpointer='xpointer(//para[@name="s-remote"]/*)'/>
6330N/A xpointer='xpointer(//para[@name="s-auth"]/*)'/>
6330N/A xpointer='xpointer(//para[@name="s-props"]/*)'/>
6330N/A xpointer='xpointer(//para[@name="s-general"]/*)'/>
6330N/AThis utility can be used to back up one or more directory server backends.
6330N/AThe following options are supported.
6330N/A <
term><
option>-a, --backUpAll</
option></
term>
6330N/ABack up all backends in the server.
6330N/A <
term><
option>-n, --backendID</
option> <
replaceable class="parameter">backendName</
replaceable></
term>
6330N/ABackend ID for the backend to archive.
6330N/A <
term><
option>-d, --backupDirectory</
option> <
replaceable 6330N/A class="parameter">backupDir</
replaceable></
term>
6330N/APath to the target directory for the backup file(s).
6330N/A <
term><
option>-I, --backupID</
option> <
replaceable 6330N/A class="parameter">backupID</
replaceable></
term>
6330N/AUse the provided identifier for the backup.
6330N/A <
term><
option>-i, --incremental</
option></
term>
6330N/APerform an incremental backup rather than a full backup.
6330N/A <
term><
option>-B, --incrementalBaseID</
option> <
replaceable 6330N/A class="parameter">backupID</
replaceable></
term>
6330N/ABackup ID of the source archive for an incremental backup.
6330N/A <
term><
option>-c, --compress</
option></
term>
6330N/ACompress the backup content.
6330N/A <
term><
option>-y, --encrypt</
option></
term>
6330N/AEncrypt the backup contents.
6330N/A <
term><
option>-A, --hash</
option></
term>
6330N/AGenerate a hash of the backup contents.
6330N/A <
term><
option>-s, --signHash</
option></
term>
6330N/ASign the hash of the backup contents.
6330N/A <
title>Task Backend Connection Options</
title>
6330N/A xpointer='xpointer(//para[@name="l-remote"]/*")])'/>
6330N/A xpointer='xpointer(//para[@name="l-auth"]/*)'/>
6330N/A <
title>Task Scheduling Options</
title>
6330N/A xpointer='xpointer(//para[@name="l-task"]/*[not(@name="lc-stop")])'/>
6330N/A xpointer='xpointer(//para[@name="l-props"]/*)'/>
6330N/A <
title>General Options</
title>
6330N/A xpointer='xpointer(//para[@name="l-general"]/*)'/>
6330N/AThe following example backs up all user data while the server is online.
6330N/A>$ </
prompt><
command>backup -p 4444 -D "cn=Directory Manager" -w password -a \
6330N/ABackup task 20110613143801866 scheduled to start Jun 13, 2011 2:38:01 PM CEST
6330N/AThe following example schedules back up of all user data every night at 2 AM
6330N/Awhen the server is online, and notifies diradmin@example.com when finished, or
6330N/A>$ </
prompt><
command>backup -p 4444 -D "cn=Directory Manager" -w password -a \
6330N/A --completionNotify diradmin@example.com \
6330N/A --errorNotify diradmin@example.com</
command></
literallayout>
6330N/ARecurring Backup task BackupTask-988d6adf-4d65-44bf-8546-6ea74a2480b0 scheduled successfully
6330N/AThe following example backs up all user data while the server is offline.
6330N/A[
28/
Sep/
2012:12:14:22 +0200] ... msg=The backup process completed successfully
6330N/A <
xi:
include href="common.xml" xpointer='xpointer(//refsection[@name="env"])'/>
6330N/A <
term><
errorcode>0</
errorcode></
term>
6330N/AThe command completed successfully.
6330N/A <
term><
errorcode>1</
errorcode></
term>
6330N/AAn error occurred while parsing the command-line arguments.
6330N/A <
refentrytitle>opendj</
refentrytitle><
manvolnum>5</
manvolnum>
6330N/A</
citerefentry>, <
citerefentry>
6330N/A xpointer='xpointer(//manvolnum[@name="crontab"])'/>