backup-examples.xml revision 73adb2e3dbaa8a9f6448cefccb7933f68c3c7348
<?xml version="1.0" encoding="UTF-8"?>
<!--
! CDDL HEADER START
!
! The contents of this file are subject to the terms of the
! Common Development and Distribution License, Version 1.0 only
! (the "License"). You may not use this file except in compliance
! with the License.
!
! You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
! or http://forgerock.org/license/CDDLv1.0.html.
! See the License for the specific language governing permissions
! and limitations under the License.
!
! When distributing Covered Code, include this CDDL HEADER in each
! file and include the License file at legal-notices/CDDLv1_0.txt.
! If applicable, add the following below this CDDL HEADER, with the
! fields enclosed by brackets "[]" replaced with your own identifying
! information:
! Portions Copyright [yyyy] [name of copyright owner]
!
! CDDL HEADER END
!
! Copyright 2015 ForgeRock AS.
!
-->
<refsect1 xmlns="http://docbook.org/ns/docbook"
version="5.0" xml:lang="en"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://docbook.org/ns/docbook
http://docbook.org/xml/5.0/xsd/docbook.xsd">
<title>Examples</title>
<para>
The following example backs up all user data while the server is online.
</para>
<screen>
$ <userinput>backup -p 4444 -D "cn=Directory Manager" -w password \
-a -d /path/to/opendj/bak -t 0</userinput>
<computeroutput>Backup task 20110613143801866 scheduled to start ...</computeroutput>
</screen>
<para>
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.
</para>
<screen>
$ <userinput>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</userinput>
<computeroutput>Recurring Backup task BackupTask-988d6adf-4d65-44bf-8546-6ea74a2480b0
scheduled successfully</computeroutput>
</screen>
<para>
The following example backs up all user data while the server is offline.
</para>
<screen>
$ <userinput>stop-ds</userinput>
<computeroutput>Stopping Server...
...</computeroutput>
$ <userinput>backup --backupAll --backupDirectory /path/to/opendj/bak</userinput>
<computeroutput>... msg=The backup process completed successfully</computeroutput>
$ <userinput>start-ds</userinput>
<computeroutput>... The Directory Server has started successfully</computeroutput>
</screen>
</refsect1>