6330N/A<?xml version="1.0" encoding="UTF-8"?>
6330N/A<!--
6330N/A ! CCPL HEADER START
6330N/A !
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 ! http://creativecommons.org/licenses/by-nc-nd/3.0/
6330N/A ! or send a letter to Creative Commons, 444 Castro Street,
6330N/A ! Suite 900, Mountain View, California, 94041, USA.
6330N/A !
6330N/A ! You can also obtain a copy of the license at
6330N/A ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
6330N/A ! See the License for the specific language governing permissions
6330N/A ! and limitations under the License.
6330N/A !
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 !
6330N/A ! CCPL HEADER END
6330N/A !
6330N/A ! Copyright 2011-2012 ForgeRock AS
6330N/A ! Portions Copyright 2013 Jens Elkner
6330N/A !
6330N/A-->
6330N/A<refentry xml:id="export-ldif-1" xmlns="http://docbook.org/ns/docbook"
6330N/A version="5.0" xml:lang="en"
6330N/A xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6330N/A xsi:schemaLocation="http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd"
6330N/A xmlns:xlink="http://www.w3.org/1999/xlink"
6330N/A xmlns:xi="http://www.w3.org/2001/XInclude">
6330N/A <xi:include href="common.xml" xpointer='xpointer(//info[@name="info"])'/>
6330N/A <refmeta>
6330N/A <refentrytitle><application>export-ldif</application></refentrytitle>
6330N/A <xi:include href="common.xml" xpointer='xpointer(//manvolnum[@name="v1m"])'/>
6330N/A </refmeta>
6330N/A <refnamediv>
6330N/A <refname><application>export-ldif</application></refname>
6330N/A <refpurpose>export OpenDJ directory data in LDIF</refpurpose>
6330N/A </refnamediv>
6330N/A <refsynopsisdiv>
6330N/A <cmdsynopsis>
6330N/A <command>export-ldif</command>
6330N/A <arg>-a</arg>
6330N/A <arg>-c</arg>
6330N/A <arg>-O</arg>
6330N/A <arg>-n <replaceable class="parameter">backendName</replaceable></arg>
6330N/A <arg>-b <replaceable class="parameter">incBranchDN</replaceable></arg>
6330N/A <arg>-B <replaceable class="parameter">excBranchDN</replaceable></arg>
6330N/A <arg>-i <replaceable class="parameter">incAttr</replaceable></arg>
6330N/A <arg>-e <replaceable class="parameter">excAttr</replaceable></arg>
6330N/A <arg>-I <replaceable class="parameter">incFilter</replaceable></arg>
6330N/A <arg>-E <replaceable class="parameter">excFilter</replaceable></arg>
6330N/A <arg>-l <replaceable class="parameter">outfile</replaceable></arg>
6330N/A <arg>--wrapColumn <replaceable class="parameter">colNum</replaceable></arg>
6330N/A <sbr/><sbr/>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="s-remote"]/*)'/>
6330N/A <sbr/><sbr/>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="s-auth"]/*)'/>
6330N/A <sbr/><sbr/>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="s-task"]/*)'/>
6330N/A <sbr/><sbr/>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="s-props"]/*)'/>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="s-general"]/*)'/>
6330N/A </cmdsynopsis>
6330N/A </refsynopsisdiv>
6330N/A <refsection>
6330N/A <title>Description</title>
6330N/A <para>
6330N/AThis utility can be used to export data from a directory server backend in LDIF
6330N/Aform.
6330N/A </para>
6330N/A </refsection>
6330N/A <refsection>
6330N/A <title>Options</title>
6330N/A <para>
6330N/AThe following options are supported.
6330N/A </para>
6330N/A <variablelist>
6330N/A <varlistentry>
6330N/A <term><option>-a, --appendToLDIF</option></term>
6330N/A <listitem>
6330N/A <para>
6330N/AAppend an existing LDIF file rather than overwriting it.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <varlistentry>
6330N/A <term><option>-b, --includeBranch</option> <replaceable
6330N/A class="parameter">branchDN</replaceable></term>
6330N/A <listitem>
6330N/A <para>
6330N/ABase DN of a branch to include in the LDIF export.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <varlistentry>
6330N/A <term><option>-B, --excludeBranch</option> <replaceable
6330N/A class="parameter">branchDN</replaceable></term>
6330N/A <listitem>
6330N/A <para>
6330N/ABase DN of a branch to exclude from the LDIF export.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <varlistentry>
6330N/A <term><option>-c, --compress</option></term>
6330N/A <listitem>
6330N/A <para>
6330N/ACompress the LDIF data as it is exported.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <varlistentry>
6330N/A <term><option>-e, --excludeAttribute</option> <replaceable
6330N/A class="parameter">attribute</replaceable></term>
6330N/A <listitem>
6330N/A <para>
6330N/AAttribute to exclude from the LDIF export.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <varlistentry>
6330N/A <term><option>-E, --excludeFilter</option> <replaceable
6330N/A class="parameter">filter</replaceable></term>
6330N/A <listitem>
6330N/A <para>
6330N/AFilter to identify entries to exclude from the LDIF export.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <varlistentry>
6330N/A <term><option>-i, --includeAttribute</option> <replaceable
6330N/A class="parameter">attribute</replaceable></term>
6330N/A <listitem>
6330N/A <para>
6330N/AAttribute to include in the LDIF export.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <varlistentry>
6330N/A <term><option>-I, --includeFilter</option> <replaceable
6330N/A class="parameter">filter</replaceable></term>
6330N/A <listitem>
6330N/A <para>
6330N/AFilter to identify entries to include in the LDIF export.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <varlistentry>
6330N/A <term><option>-l, --ldifFile</option> <replaceable
6330N/A class="parameter">file</replaceable></term>
6330N/A <listitem>
6330N/A <para>
6330N/APath to the LDIF file to be written.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <varlistentry>
6330N/A <term><option>-n, --backendID</option> <replaceable
6330N/A class="parameter">backendName</replaceable></term>
6330N/A <listitem>
6330N/A <para>
6330N/ABackend ID for the backend to export.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <varlistentry>
6330N/A <term><option>-O, --excludeOperational</option></term>
6330N/A <listitem>
6330N/A <para>
6330N/AExclude operational attributes from the LDIF export.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <varlistentry>
6330N/A <term><option>--wrapColumn</option> <replaceable
6330N/A class="parameter">column</replaceable></term>
6330N/A <listitem>
6330N/A <para>
6330N/AColumn at which to wrap long lines (Default: 0, i.e. no wrapping).
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A </variablelist>
6330N/A <refsection>
6330N/A <title>Task Backend Connection Options</title>
6330N/A <variablelist>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="l-remote"]/*)'/>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="l-auth"]/*)'/>
6330N/A </variablelist>
6330N/A </refsection>
6330N/A <refsection>
6330N/A <title>Task Scheduling Options</title>
6330N/A <variablelist>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="l-task"]/*[not(@name="lc-stop")])'/>
6330N/A </variablelist>
6330N/A </refsection>
6330N/A <refsection>
6330N/A <title>Utility Input/Output Options</title>
6330N/A <variablelist>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="l-props"]/*)'/>
6330N/A </variablelist>
6330N/A </refsection>
6330N/A <refsection>
6330N/A <title>General Options</title>
6330N/A <variablelist>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="l-general"]/*)'/>
6330N/A </variablelist>
6330N/A </refsection>
6330N/A </refsection>
6330N/A <refsection>
6330N/A <title>Examples</title>
6330N/A <informalexample>
6330N/A <para>
6330N/AThe following example exports data to a file, <filename>Example.ldif</filename>,
6330N/Awith the server offline.
6330N/A </para>
6330N/A <literallayout><prompt
6330N/A>$ </prompt><command>export-ldif -b dc=example,dc=com -n userRoot \
6330N/A -l /ldif/Example.ldif</command></literallayout>
6330N/A <screen>
6330N/A[21/Jun/2011:13:40:49 +0200] category=BACKEND severity=INFORMATION ...
6330N/A...Exported 160 entries and skipped 0 in 0 seconds (average rate 1428.6/sec)
6330N/A</screen>
6330N/A </informalexample>
6330N/A </refsection>
6330N/A <xi:include href="common.xml" xpointer='xpointer(//refsection[@name="env"])'/>
6330N/A <xi:include href="common.xml" xpointer='xpointer(//refsection[@name="exit-0-gt0"])'/>
6330N/A <xi:include href="common.xml" xpointer='xpointer(//refsection[@name="seeAlso"])'/>
6330N/A</refentry>