338N/A<?
xml version="1.0" encoding="UTF-8"?>
338N/A ! This work is licensed under the Creative Commons 338N/A ! Attribution-NonCommercial-NoDerivs 3.0 Unported License. 338N/A ! To view a copy of this license, visit 338N/A ! or send a letter to Creative Commons, 444 Castro Street, 338N/A ! Suite 900, Mountain View, California, 94041, USA. 338N/A ! You can also obtain a copy of the license at 338N/A ! See the License for the specific language governing permissions 338N/A ! and limitations under the License. 338N/A ! If applicable, add the following below this CCPL HEADER, with the fields 338N/A ! enclosed by brackets "[]" replaced with your own identifying information: 873N/A ! Portions Copyright [yyyy] [name of copyright owner] 338N/A ! Copyright 2011-2012 ForgeRock AS 338N/A ! Portions Copyright 2013 Jens Elkner 338N/A version="5.0" xml:
lang="en" 338N/A <
xi:
include href="common.xml" xpointer='xpointer(//info[@name="info"])'/>
338N/A <
refentrytitle><
application>import-ldif</
application></
refentrytitle>
338N/A <
xi:
include href="common.xml" xpointer='xpointer(//manvolnum[@name="v1m"])'/>
338N/A <
refname><
application>import-ldif</
application></
refname>
338N/A <
refpurpose>import OpenDJ directory data from LDIF</
refpurpose>
338N/A <
command>import-ldif</
command>
338N/A <
arg>-R <
replaceable class="parameter">rejectFile</
replaceable></
arg>
338N/A <
arg>-s <
replaceable class="parameter">seed</
replaceable></
arg>
338N/A <
arg>-A <
replaceable class="parameter">templFile</
replaceable></
arg>
338N/A <
arg>-n <
replaceable class="parameter">backendName</
replaceable></
arg>
338N/A <
arg>-b <
replaceable class="parameter">incBranchDN</
replaceable></
arg>
338N/A <
arg>-B <
replaceable class="parameter">excBranchDN</
replaceable></
arg>
338N/A <
arg>-i <
replaceable class="parameter">incAttr</
replaceable></
arg>
338N/A <
arg>-e <
replaceable class="parameter">excAttr</
replaceable></
arg>
338N/A <
arg>-I <
replaceable class="parameter">incFilter</
replaceable></
arg>
338N/A <
arg>-E <
replaceable class="parameter">excFilter</
replaceable></
arg>
338N/A <
arg>-l <
replaceable class="parameter">infile</
replaceable></
arg>
338N/A <
arg>--countRejects</
arg>
338N/A <
arg>--skipDNValidation</
arg>
338N/A <
arg>--skipFile <
replaceable class="parameter">logFile</
replaceable></
arg>
338N/A <
arg>--threadCount <
replaceable class="parameter">count</
replaceable></
arg>
<
arg>--tmpdirectory <
replaceable class="parameter">path</
replaceable></
arg>
xpointer='xpointer(//para[@name="s-remote"]/*)'/>
xpointer='xpointer(//para[@name="s-auth"]/*)'/>
xpointer='xpointer(//para[@name="s-task"]/*)'/>
xpointer='xpointer(//para[@name="s-props"]/*)'/>
xpointer='xpointer(//para[@name="s-misc"]/*[@name="sc-quiet"])'/>
xpointer='xpointer(//para[@name="s-general"]/*)'/>
<
title>Description</
title>
This utility can be used to import LDIF data into a directory server backend.
The following options are supported.
<
term><
option>-a, --append</
option></
term>
Add to the given backend. If not specified, all entries in the backend get
deleted first unless it contains more than one baseDN.
<
term><
option>-A, --templateFile</
option> <
replaceable class="parameter">file</
replaceable></
term>
Path to a MakeLDIF template to use to generate the import data.
<
term><
option>-b, --includeBranch</
option> <
replaceable class="parameter">branchDN</
replaceable></
term>
Base DN of a branch to include in the LDIF import.
<
term><
option>-B, --excludeBranch</
option> <
replaceable class="parameter">branchDN</
replaceable></
term>
Base DN of a branch to exclude from the LDIF import.
<
term><
option>-c, --isCompressed</
option></
term>
<
term><
option>--countRejects</
option></
term>
Count the number of entries rejected by the server and return that value as the
exit code (values > 255 will be reduced to 255 due to exit code restrictions).
<
term><
option>-e, --excludeAttribute</
option> <
replaceable class="parameter">attribute</
replaceable></
term>
Attribute to exclude from the LDIF import.
<
term><
option>-E, --excludeFilter</
option> <
replaceable class="parameter">filter</
replaceable></
term>
Filter to identify entries to exclude from the LDIF import.
<
term><
option>-F, --clearBackend</
option></
term>
Remove all entries for all base DNs in the backend before importing.
<
term><
option>-i, --includeAttribute</
option> <
replaceable class="parameter">attribute</
replaceable></
term>
Attribute to include in the LDIF import.
<
term><
option>-I, --includeFilter</
option> <
replaceable class="parameter">filter</
replaceable></
term>
Filter to identify entries to include in the LDIF import.
<
term><
option>-l, --ldifFile</
option> <
replaceable class="parameter">file</
replaceable></
term>
Path to the LDIF file to be imported.
<
term><
option>-n, --backendID</
option> <
replaceable class="parameter">backendName</
replaceable></
term>
Backend ID the target backend for the import.
<
term><
option>-O, --overwrite</
option></
term>
Overwrite an existing rejectFile and skipFile rather than appending to it.
<
term><
option>-r, --replaceExisting</
option></
term>
Replace existing entries when appending to a backend.
<
term><
option>-R, --rejectFile</
option> <
replaceable class="parameter">rejectFile</
replaceable></
term>
Write rejected entries to the specified file.
<
term><
option>-s, --randomSeed</
option> <
replaceable class="parameter">seed</
replaceable></
term>
Seed for the MakeLDIF random number generator (Default: 0).
<
term><
option>-S, --skipSchemaValidation</
option></
term>
Skip schema validation during the LDIF import.
<
term><
option>--skipDNValidation</
option></
term>
Perform DN validation during later part of LDIF import.
<
term><
option>--skipFile</
option> <
replaceable class="parameter">file</
replaceable></
term>
Write skipped entries to the specified file.
<
term><
option>--threadCount</
option> <
replaceable class="parameter">count</
replaceable></
term>
Number of threads used to read LDIF file during import. (Default: 0, implies
<
term><
option>--tmpdirectory</
option> <
replaceable class="parameter">path</
replaceable></
term>
Path to temporary directory for index scratch files during LDIF import (Default:
<
varname>$INSTANCE_ROOT</
varname><
filename>/import-tmp/</
filename>).
<
title>Task Backend Connection Options</
title>
xpointer='xpointer(//para[@name="l-remote"]/*)'/>
xpointer='xpointer(//para[@name="l-auth"]/*)'/>
<
title>Task Scheduling Options</
title>
xpointer='xpointer(//para[@name="l-task"]/*[not(@name="lc-stop")])'/>
xpointer='xpointer(//para[@name="l-props"]/*)'/>
xpointer='xpointer(//para[@name="l-misc"]/*[@name="lc-quiet"])'/>
<
title>General Options</
title>
xpointer='xpointer(//para[@name="l-general"]/*)'/>
The following example imports the content of the LDIF file,
>$ </
prompt><
command>import-ldif -b dc=example,dc=com -n userRoot \
[
21/
Jun/
2011:13:38:03 +0200] category=RUNTIME_INFORMATION severity=NOTICE...
... msg=Import LDIF environment close took 0 seconds
<
xi:
include href="common.xml" xpointer='xpointer(//refsection[@name="env"])'/>
<
xi:
include href="common.xml" xpointer='xpointer(//refsection[@name="exit-0-gt0"])'/>
<
xi:
include href="common.xml" xpointer='xpointer(//refsection[@name="seeAlso"])'/>