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="import-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>import-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>import-ldif</application></refname>
6330N/A <refpurpose>import OpenDJ directory data from LDIF</refpurpose>
6330N/A </refnamediv>
6330N/A <refsynopsisdiv>
6330N/A <cmdsynopsis>
6330N/A <command>import-ldif</command>
6330N/A <arg>-a</arg>
6330N/A <arg>-c</arg>
6330N/A <arg>-O</arg>
6330N/A <arg>-F</arg>
6330N/A <arg>-S</arg>
6330N/A <arg>-R <replaceable class="parameter">rejectFile</replaceable></arg>
6330N/A <arg>-s <replaceable class="parameter">seed</replaceable></arg>
6330N/A <arg>-A <replaceable class="parameter">templFile</replaceable></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">infile</replaceable></arg>
6330N/A <arg>--countRejects</arg>
6330N/A <arg>--skipDNValidation</arg>
6330N/A <arg>--skipFile <replaceable class="parameter">logFile</replaceable></arg>
6330N/A <arg>--threadCount <replaceable class="parameter">count</replaceable></arg>
6330N/A <arg>--tmpdirectory <replaceable class="parameter">path</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-misc"]/*[@name="sc-quiet"])'/>
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 import LDIF data into a directory server backend.
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>
6417N/A <term><option>-a, --append</option></term>
6330N/A <listitem>
6330N/A <para>
6417N/AAdd to the given backend. If not specified, all entries in the backend get
6417N/Adeleted first unless it contains more than one baseDN.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <varlistentry>
6330N/A <term><option>-A, --templateFile</option> <replaceable
6330N/A class="parameter">file</replaceable></term>
6330N/A <listitem>
6330N/A <para>
6330N/APath to a MakeLDIF template to use to generate the import data.
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 import.
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 import.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <varlistentry>
6330N/A <term><option>-c, --isCompressed</option></term>
6330N/A <listitem>
6330N/A <para>
6330N/ALDIF file is compressed.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <varlistentry>
6330N/A <term><option>--countRejects</option></term>
6330N/A <listitem>
6330N/A <para>
6330N/ACount the number of entries rejected by the server and return that value as the
6330N/Aexit code (values &gt; 255 will be reduced to 255 due to exit code restrictions).
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 import.
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 import.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <varlistentry>
6330N/A <term><option>-F, --clearBackend</option></term>
6330N/A <listitem>
6330N/A <para>
6330N/ARemove all entries for all base DNs in the backend before importing.
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 import.
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 import.
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 imported.
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>
6417N/ABackend ID the target backend for the import.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <varlistentry>
6330N/A <term><option>-O, --overwrite</option></term>
6330N/A <listitem>
6330N/A <para>
6417N/AOverwrite an existing rejectFile and skipFile rather than appending to it.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <varlistentry>
6330N/A <term><option>-r, --replaceExisting</option></term>
6330N/A <listitem>
6330N/A <para>
6417N/AReplace existing entries when appending to a backend.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <varlistentry>
6330N/A <term><option>-R, --rejectFile</option> <replaceable
6330N/A class="parameter">rejectFile</replaceable></term>
6330N/A <listitem>
6330N/A <para>
6330N/AWrite rejected entries to the specified file.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <varlistentry>
6330N/A <term><option>-s, --randomSeed</option> <replaceable
6330N/A class="parameter">seed</replaceable></term>
6330N/A <listitem>
6330N/A <para>
6330N/ASeed for the MakeLDIF random number generator (Default: 0).
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <varlistentry>
6330N/A <term><option>-S, --skipSchemaValidation</option></term>
6330N/A <listitem>
6330N/A <para>
6330N/ASkip schema validation during the LDIF import.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <varlistentry>
6330N/A <term><option>--skipDNValidation</option></term>
6330N/A <listitem>
6330N/A <para>
6330N/APerform DN validation during later part of LDIF import.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <varlistentry>
6330N/A <term><option>--skipFile</option> <replaceable
6330N/A class="parameter">file</replaceable></term>
6330N/A <listitem>
6330N/A <para>
6330N/AWrite skipped entries to the specified file.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <varlistentry>
6330N/A <term><option>--threadCount</option> <replaceable
6330N/A class="parameter">count</replaceable></term>
6330N/A <listitem>
6330N/A <para>
6330N/ANumber of threads used to read LDIF file during import. (Default: 0, implies
6330N/A2 x (number of CPUs)).
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A <varlistentry>
6330N/A <term><option>--tmpdirectory</option> <replaceable
6330N/A class="parameter">path</replaceable></term>
6330N/A <listitem>
6330N/A <para>
6330N/APath to temporary directory for index scratch files during LDIF import (Default:
6330N/A<varname>$INSTANCE_ROOT</varname><filename>/import-tmp/</filename>).
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 <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="l-misc"]/*[@name="lc-quiet"])'/>
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 imports the content of the LDIF file,
6330N/A<filename>Example.ldif</filename>, with the server offline.
6330N/A </para>
6330N/A <literallayout><prompt
6330N/A>$ </prompt><command>import-ldif -b dc=example,dc=com -n userRoot \
6330N/A -l /tmp/Example.ldif</command></literallayout>
6330N/A <screen>
6330N/A [21/Jun/2011:13:38:03 +0200] category=RUNTIME_INFORMATION severity=NOTICE...
6330N/A ... msg=Import LDIF environment close took 0 seconds
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>