<?xml version="1.0" encoding="UTF-8"?>

<refentry xml:id="restore-1" 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"

xmlns:xlink="http://www.w3.org/1999/xlink"

xmlns:xi="http://www.w3.org/2001/XInclude">

<xi:include href="common.xml" xpointer='xpointer(//info[@name="info"])'/>

<refmeta>

<refentrytitle><application>restore</application></refentrytitle>

<xi:include href="common.xml" xpointer='xpointer(//manvolnum[@name="v1m"])'/>

</refmeta>

<refnamediv>

<refname><application>restore</application></refname>

<refpurpose>restore OpenDJ directory data backups</refpurpose>

</refnamediv>

<refsynopsisdiv>

<cmdsynopsis>

<command>restore</command>

<arg>-d <replaceable class="parameter">backupDir</replaceable></arg>

<arg>-I <replaceable class="parameter">backupId</replaceable></arg>

<arg>-l</arg>

<arg>-n</arg>

<sbr/><sbr/>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="s-remote"]/*)'/>

<sbr/><sbr/>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="s-auth"]/*)'/>

<sbr/><sbr/>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="s-task"]/*[not(@name="sc-stop")])'/>

<sbr/><sbr/>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="s-props"]/*)'/>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="s-general"]/*)'/>

</cmdsynopsis>

</refsynopsisdiv>

<refsection>

<title>Description</title>

<para>

This utility can be used to restore a backup of a directory server backend.

</para>

</refsection>

<refsection>

<title>Options</title>

<para>

The following options are supported.

</para>

<variablelist>

<varlistentry>

<term><option>-d, --backupDirectory</option> <replaceable

class="parameter">path</replaceable></term>

<listitem>

<para>

Path to the target directory for the backup file(s).</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-I, --backupID</option> <replaceable

class="parameter">id</replaceable></term>

<listitem>

<para>

Use the provided identifier for the backup.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-l, --listBackups</option></term>

<listitem>

<para>

List available backups in the backup directory.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-n, --dry-run</option></term>

<listitem>

<para>

Verify the contents of the backup but do not restore it.

</para>

</listitem>

</varlistentry>

</variablelist>

<refsection>

<title>Task Backend Connection Options</title>

<variablelist>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="l-remote"]/*)'/>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="l-auth"]/*)'/>

</variablelist>

</refsection>

<refsection>

<title>Task Scheduling Options</title>

<variablelist>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="l-task"]/*[not(@name="lc-stop")])'/>

</variablelist>

</refsection>

<refsection>

<title>Utility Input/Output Options</title>

<variablelist>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="l-props"]/*)'/>

</variablelist>

</refsection>

<refsection>

<title>General Options</title>

<variablelist>

<xi:include href="common.xml"

xpointer='xpointer(//para[@name="l-general"]/*)'/>

</variablelist>

</refsection>

</refsection>

<refsection>

<title>Examples</title>

<informalexample>

<para>

The following example schedules a restore as a task to begin immediatelywhile

OpenDJ directory server is online.

</para>

<literallayout><prompt

>$ </prompt><command>restore -d $INSTANCE_ROOT/bak -I 20110613080032 -t 0 \

-p 4444 -D "cn=Directory Manager" -w password</command></literallayout>

<screen>

Restore task 20110613155052932 scheduled to start Jun 13, 2011 3:50:52 PM CEST

</screen>

</informalexample>

<informalexample>

<para>

The following example shows, how to get a list of available backups and

how to restores data while OpenDJ is offline.

</para>

<literallayout><prompt

>$ </prompt><command>restore -d $INSTANCE_ROOT/bak/userRoot -l</command></literallayout>

<screen>

Backup ID: 20120928102414Z

Backup Date: 28/Sep/2012:12:24:17 +0200

Is Incremental: false

Is Compressed: false

Is Encrypted: false

Has Unsigned Hash: false

Has Signed Hash: false

Dependent Upon: none

</screen>

<literallayout><prompt

>$ </prompt><command>restore -d $INSTANCE_ROOT/bak/userRoot -I 20120928102414Z</command></literallayout>

<screen>

[28/Sep/2012:12:26:20 +0200] ... msg=Restored: 00000000.jdb (size 355179)

</screen>

</informalexample>

</refsection>

<xi:include href="common.xml" xpointer='xpointer(//refsection[@name="env"])'/>

<refsection>

<title>Exit Codes</title>

<variablelist>

<varlistentry>

<term><errorcode>0</errorcode></term>

<listitem>

<para>

The command completed successfully.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><errorcode>1</errorcode></term>

<listitem>

<para>

An error occurred while parsing the command-line arguments.

</para>

</listitem>

</varlistentry>

</variablelist>

</refsection>

<xi:include href="common.xml" xpointer='xpointer(//refsection[@name="seeAlso"])'/>

</refentry>