51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! CCPL HEADER START
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! This work is licensed under the Creative Commons
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! To view a copy of this license, visit
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! or send a letter to Creative Commons, 444 Castro Street,
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! Suite 900, Mountain View, California, 94041, USA.
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! You can also obtain a copy of the license at
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! See the License for the specific language governing permissions
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! and limitations under the License.
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! If applicable, add the following below this CCPL HEADER, with the fields
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! enclosed by brackets "[]" replaced with your own identifying information:
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! Portions Copyright [yyyy] [name of copyright owner]
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! CCPL HEADER END
57d6342a74476c0bf2200992e778229d62ab1fa6mark ! Copyright 2011-2015 ForgeRock AS.
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <indexterm><primary>Importing data</primary></indexterm>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <indexterm>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </indexterm>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <indexterm><primary>Exporting data</primary></indexterm>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <indexterm>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </indexterm>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <indexterm>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </indexterm>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>LDAP Data Interchange Format provides a mechanism for representing
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark directory data in text format. LDIF data is typically used to initialize
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark directory databases, but also may be used to move data between different
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark directories that cannot replicate directly, or even as an alternative
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark backup format.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>This chapter shows you how to import and export LDIF.
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark This chapter also covers creating test data in LDIF format, and manipulating
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark LDIF data with command-line tools.</para>
ec40cc0dc62425cea5d63fd9d984f8614479de25mark When you install OpenDJ,
ec40cc0dc62425cea5d63fd9d984f8614479de25mark you have the option of importing sample data
ec40cc0dc62425cea5d63fd9d984f8614479de25mark that is generated during the installation.
ec40cc0dc62425cea5d63fd9d984f8614479de25mark This procedure demonstrates how to generate LDIF by using the
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <indexterm>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </indexterm>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>The <command>make-ldif</command> command uses templates to provide
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark sample data. Default templates are located in the
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <filename>OpenDJ/config/MakeLDIF/</filename> directory. The
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <filename>example.template</filename> file can be used to create
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark a suffix with entries of the type <literal>inetOrgPerson</literal>. You can
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark do the equivalent in OpenDJ Control Panel (Directory Data > New Base
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark DN... > Import Automatically Generated Example Data).</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Write a file to act as the template for your generated LDIF.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>The resulting test data template depends on what data you expect to
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark encounter in production. Base your work on your knowledge of the production
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark data, and on the sample template,
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <filename>OpenDJ/config/MakeLDIF/example.template</filename>, and
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark associated data.</para>
57d6342a74476c0bf2200992e778229d62ab1fa6mark <para>See <link xlink:href="reference#make-ldif-template-5"
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xlink:role="http://docbook.org/xlink/role/olink" xlink:show="new"><citetitle
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark >make-ldif.template</citetitle></link> for reference information about
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark template files.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Create additional data files for the content in your template to be
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark selected randomly from a file, rather than generated by an expression.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Additional data files are located in the same directory as your
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark template file.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Decide whether you want to generate the same test data each time
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark you run the <command>make-ldif</command> command with your template.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>If so, provide the same <literal>randomSeed</literal> integer each
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark time you run the command.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Before generating a very large LDIF file, make sure you have enough
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark space on disk.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Run the <command>make-ldif</command> command to generate your
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark LDIF file.</para>
08248b5c5b494aff8d1922e8e0b5777796d7450dmark$ <userinput>make-ldif \
08248b5c5b494aff8d1922e8e0b5777796d7450dmark --randomSeed 0 \
08248b5c5b494aff8d1922e8e0b5777796d7450dmark<computeroutput>Processed 1000 entries
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmarkProcessed 2000 entries
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmarkProcessed 10000 entries
08248b5c5b494aff8d1922e8e0b5777796d7450dmarkLDIF processing complete. 10003 entries written</computeroutput>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </procedure>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </section>
ec40cc0dc62425cea5d63fd9d984f8614479de25mark You can use OpenDJ Control Panel
ec40cc0dc62425cea5d63fd9d984f8614479de25mark to import data (Directory Data > Import LDIF)
ec40cc0dc62425cea5d63fd9d984f8614479de25mark and to export data (Directory Data > Export LDIF).
ec40cc0dc62425cea5d63fd9d984f8614479de25mark The following procedures demonstrate how to use the
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>The most efficient method of importing LDIF data is to take the
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark OpenDJ server offline. Alternatively, you can schedule a task to import
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark the data while the server is online.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>If you do not want to use the default <literal>userRoot</literal>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark backend, create a new JE backend for your data.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>See <xref linkend="create-database-backend" /> for details.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>The following example imports <literal>dc=example,dc=org</literal>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark data into the <literal>userRoot</literal> backend, overwriting existing
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark data.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <stepalternatives>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>If you want to speed up the process—for example because you
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark have millions of directory entries to import—first shut down the
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark server, and then run the <command>import-ldif</command> command.</para>
08248b5c5b494aff8d1922e8e0b5777796d7450dmark$ <userinput>import-ldif \
08248b5c5b494aff8d1922e8e0b5777796d7450dmark --includeBranch dc=example,dc=org \
08248b5c5b494aff8d1922e8e0b5777796d7450dmark --backendID userRoot \
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>If not, schedule a task to import the data while online.</para>
08248b5c5b494aff8d1922e8e0b5777796d7450dmark$ <userinput>import-ldif \
08248b5c5b494aff8d1922e8e0b5777796d7450dmark --port 4444 \
08248b5c5b494aff8d1922e8e0b5777796d7450dmark --bindDN "cn=Directory Manager" \
08248b5c5b494aff8d1922e8e0b5777796d7450dmark --bindPassword password \
08248b5c5b494aff8d1922e8e0b5777796d7450dmark --includeBranch dc=example,dc=org \
08248b5c5b494aff8d1922e8e0b5777796d7450dmark --backendID userRoot \
08248b5c5b494aff8d1922e8e0b5777796d7450dmark --trustAll</userinput>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Notice that the task is scheduled through communication over SSL on
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark the administration port, by default <literal>4444</literal>. You can
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark schedule the import task to start at a particular time using the
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>The <option>--trustAll</option> option trusts all SSL certificates,
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark such as a default self-signed certificate used for testing.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </stepalternatives>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </procedure>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>The following example exports <literal>dc=example,dc=org</literal>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark data from the <literal>userRoot</literal> backend.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <stepalternatives>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>If you want to speed up export, first shut down the server, and then
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark export data using the <command>export-ldif</command> command.</para>
08248b5c5b494aff8d1922e8e0b5777796d7450dmark$ <userinput>export-ldif \
08248b5c5b494aff8d1922e8e0b5777796d7450dmark --includeBranch dc=example,dc=org \
08248b5c5b494aff8d1922e8e0b5777796d7450dmark --backendID userRoot \
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>If not, schedule a task to export the data while online.</para>
08248b5c5b494aff8d1922e8e0b5777796d7450dmark$ <userinput>export-ldif \
08248b5c5b494aff8d1922e8e0b5777796d7450dmark --port 4444 \
08248b5c5b494aff8d1922e8e0b5777796d7450dmark --bindDN "cn=Directory Manager" \
08248b5c5b494aff8d1922e8e0b5777796d7450dmark --bindPassword password \
08248b5c5b494aff8d1922e8e0b5777796d7450dmark --includeBranch dc=example,dc=org \
08248b5c5b494aff8d1922e8e0b5777796d7450dmark --backendID userRoot \
08248b5c5b494aff8d1922e8e0b5777796d7450dmark --start 20111221230000 \
08248b5c5b494aff8d1922e8e0b5777796d7450dmark --trustAll</userinput>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>The <option>--start 20111221230000</option> option tells OpenDJ to
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark start the export at 11 PM on December 21, 2012.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>If OpenDJ is stopped at this time, then when you start OpenDJ again,
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark the server attempts to perform the task after starting up.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </stepalternatives>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </procedure>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </section>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <indexterm>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </indexterm>
ec40cc0dc62425cea5d63fd9d984f8614479de25mark This section demonstrates the
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <title>Searching in LDIF With <command>ldifsearch</command></title>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>The <command>ldifsearch</command> command lets you search LDIF files
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark in a similar way to how you search LDAP directories with the
08248b5c5b494aff8d1922e8e0b5777796d7450dmark$ <userinput>ldifsearch \
08248b5c5b494aff8d1922e8e0b5777796d7450dmark --baseDN dc=example,dc=org \
08248b5c5b494aff8d1922e8e0b5777796d7450dmark "(sn=Grenier)" \
08248b5c5b494aff8d1922e8e0b5777796d7450dmark mobile</userinput>
08248b5c5b494aff8d1922e8e0b5777796d7450dmark<computeroutput>dn: uid=user.4630,ou=People,dc=example,dc=org
08248b5c5b494aff8d1922e8e0b5777796d7450dmarkmobile: +1 728 983 6669</computeroutput>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>The <option>--ldifFile <replaceable>ldif-file</replaceable></option>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark option replaces the <option>--hostname</option> and <option>--port</option>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark options used to connect to an LDAP directory. Otherwise the command syntax
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark and LDIF output is familiar to <command>ldapsearch</command> users.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </section>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <title>Updating LDIF With <command>ldifmodify</command></title>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>The <command>ldifmodify</command> command lets you apply changes to
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark LDIF files, generating a new, changed version of the original file.</para>
08248b5c5b494aff8d1922e8e0b5777796d7450dmark<computeroutput>dn: uid=user.0,ou=People,dc=example,dc=org
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmarkchangetype: modify
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmarkreplace: description
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmarkdescription: This is the new description for Aaccf Amar.
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmarkreplace: initials
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmarkinitials: AAA
08248b5c5b494aff8d1922e8e0b5777796d7450dmark</computeroutput>
08248b5c5b494aff8d1922e8e0b5777796d7450dmark$ <userinput>ldifmodify \
08248b5c5b494aff8d1922e8e0b5777796d7450dmark --sourceLDIF generated.ldif \
08248b5c5b494aff8d1922e8e0b5777796d7450dmark --changesLDIF changes.ldif \
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Notice that the resulting new LDIF file is likely to be about the
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark same size as the source LDIF file.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </section>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <title>Comparing LDIF With <command>ldif-diff</command></title>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>The <command>ldif-diff</command> command reports differences between
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark two LDIF files in LDIF format.</para>
08248b5c5b494aff8d1922e8e0b5777796d7450dmark$ <userinput>ldif-diff --sourceLDIF old.ldif --targetLDIF new.ldif</userinput>
08248b5c5b494aff8d1922e8e0b5777796d7450dmark<computeroutput>dn: uid=user.0,ou=People,dc=example,dc=org
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmarkchangetype: modify
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmarkadd: initials
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmarkinitials: AAA
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmarkdelete: initials
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmarkinitials: ASA
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmarkadd: description
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmarkdescription: This is the new description for Aaccf Amar.
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmarkdelete: description
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmarkdescription: This is the description for Aaccf Amar.
08248b5c5b494aff8d1922e8e0b5777796d7450dmark</computeroutput>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>As the <command>ldif-diff</command> command reads both files into
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark memory, constructing tree maps to perform the comparison, the command
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark is designed to work with small files and fragments. The command can quickly
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark run out of memory when calculating differences between large files.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </section>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </section>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <indexterm>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </indexterm>
02f907dad5f11dd22aa0123293c89be4f5499576mark OpenDJ stores your directory data in a <firstterm>backend</firstterm>.
02f907dad5f11dd22aa0123293c89be4f5499576mark Backends are what you backup and restore.
02f907dad5f11dd22aa0123293c89be4f5499576mark By default, OpenDJ stores your data in a backend named <literal>userRoot</literal>.
ec40cc0dc62425cea5d63fd9d984f8614479de25mark You can create new backends using the
ec40cc0dc62425cea5d63fd9d984f8614479de25mark ><command>dsconfig create-backend</command></link> command.
02f907dad5f11dd22aa0123293c89be4f5499576mark The following example creates a local backend named <literal>testData</literal>.
08248b5c5b494aff8d1922e8e0b5777796d7450dmark$ <userinput>dsconfig create-backend --backend-name testData --type local-db</userinput>
08248b5c5b494aff8d1922e8e0b5777796d7450dmark<computeroutput>
08248b5c5b494aff8d1922e8e0b5777796d7450dmark>>>> Configuring the "base-dn" property
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark Specifies the base DN(s) for the data that the backend handles.
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark A single backend may be responsible for one or more base DNs. Note that no
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark two backends may have the same base DN although one backend may have a
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark base DN that is below a base DN provided by another backend (similar to
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark the use of sub-suffixes in the Sun Java System Directory Server). If any
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark of the base DNs is subordinate to a base DN for another backend, then all
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark base DNs for that backend must be subordinate to that same base DN.
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark Syntax: DN
08248b5c5b494aff8d1922e8e0b5777796d7450dmarkEnter a value for the "base-dn" property:</computeroutput> <userinput>dc=example,dc=org</userinput>
08248b5c5b494aff8d1922e8e0b5777796d7450dmark<computeroutput>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmarkEnter another value for the "base-dn" property [continue]:
08248b5c5b494aff8d1922e8e0b5777796d7450dmark>>>> Configuring the "enabled" property
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark Indicates whether the backend is enabled in the server.
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark If a backend is not enabled, then its contents are not accessible when
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark processing operations.
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmarkSelect a value for the "enabled" property:
08248b5c5b494aff8d1922e8e0b5777796d7450dmark<computeroutput>
08248b5c5b494aff8d1922e8e0b5777796d7450dmark>>>> Configure the properties of the Local DB Backend
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark Property Value(s)
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark --------------------------------------
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark 1) backend-id testData
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark 2) base-dn "dc=example,dc=org"
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark 3) compact-encoding true
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark 4) db-cache-percent 10
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark 5) db-cache-size 0 b
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark 6) db-directory db
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark 7) enabled true
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark 8) index-entry-limit 4000
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark 9) writability-mode enabled
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark f) finish - create the new Local DB Backend
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmarkEnter choice [f]:
08248b5c5b494aff8d1922e8e0b5777796d7450dmarkThe Local DB Backend was created successfully</computeroutput>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Alternatively, you can create a new backend in OpenDJ Control Panel
08248b5c5b494aff8d1922e8e0b5777796d7450dmark (Directory Data > New Base DN > Backend > New Backend:
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </section>
4446f63b058277925e2db449e3e1dd76c47ad9d6mark <section xml:id="set-database-backend-disk-thresholds">
4446f63b058277925e2db449e3e1dd76c47ad9d6mark <title>Setting Disk Space Thresholds For Database Backends</title>
4446f63b058277925e2db449e3e1dd76c47ad9d6mark <indexterm>
4446f63b058277925e2db449e3e1dd76c47ad9d6mark </indexterm>
4446f63b058277925e2db449e3e1dd76c47ad9d6mark Directory data growth depends on applications that use the directory.
4446f63b058277925e2db449e3e1dd76c47ad9d6mark As a result, when directory applications add more data than they delete,
4446f63b058277925e2db449e3e1dd76c47ad9d6mark the local database backend grows until it fills the available disk space.
4446f63b058277925e2db449e3e1dd76c47ad9d6mark The system can end up in an unrecoverable state if no disk space is available.
4446f63b058277925e2db449e3e1dd76c47ad9d6mark Local database backends therefore have advanced properties,
4446f63b058277925e2db449e3e1dd76c47ad9d6mark xlink:href="${configRefBase}/local-db-backend.html#disk-low-threshold"
4446f63b058277925e2db449e3e1dd76c47ad9d6mark xlink:href="${configRefBase}/local-db-backend.html#disk-full-threshold"
4446f63b058277925e2db449e3e1dd76c47ad9d6mark When available disk space falls below <literal>disk-low-threshold</literal>,
4446f63b058277925e2db449e3e1dd76c47ad9d6mark OpenDJ server only allows updates from users and applications
4446f63b058277925e2db449e3e1dd76c47ad9d6mark that have the privilege to
4446f63b058277925e2db449e3e1dd76c47ad9d6mark When available space falls below <literal>disk-full-threshold</literal>,
4446f63b058277925e2db449e3e1dd76c47ad9d6mark OpenDJ server stops allowing updates,
4446f63b058277925e2db449e3e1dd76c47ad9d6mark instead returning an <literal>UNWILLING_TO_PERFORM</literal> error
4446f63b058277925e2db449e3e1dd76c47ad9d6mark to each update request.
4446f63b058277925e2db449e3e1dd76c47ad9d6mark <emphasis>
4446f63b058277925e2db449e3e1dd76c47ad9d6mark OpenDJ server continues to apply replication updates
4446f63b058277925e2db449e3e1dd76c47ad9d6mark without regard to the thresholds.
4446f63b058277925e2db449e3e1dd76c47ad9d6mark </emphasis>
4446f63b058277925e2db449e3e1dd76c47ad9d6mark OpenDJ server can therefore fill available disk space despite the thresholds,
4446f63b058277925e2db449e3e1dd76c47ad9d6mark by accepting replication updates made on other servers.
4446f63b058277925e2db449e3e1dd76c47ad9d6mark You can give yourself more time to react to the situation
4446f63b058277925e2db449e3e1dd76c47ad9d6mark both by monitoring directory data growth
4446f63b058277925e2db449e3e1dd76c47ad9d6mark and also by increasing the thresholds.
4446f63b058277925e2db449e3e1dd76c47ad9d6mark If growth across the directory service tends to happen quickly,
4446f63b058277925e2db449e3e1dd76c47ad9d6mark set the thresholds higher than the defaults
4446f63b058277925e2db449e3e1dd76c47ad9d6mark to allow more time to react when growth threatens to fill the disk.
4446f63b058277925e2db449e3e1dd76c47ad9d6mark The following example sets <literal>disk-low-threshold</literal> to 2 GB
4446f63b058277925e2db449e3e1dd76c47ad9d6mark$ <userinput>dsconfig \
4446f63b058277925e2db449e3e1dd76c47ad9d6mark set-backend-prop \
4446f63b058277925e2db449e3e1dd76c47ad9d6mark --port 4444 \
4446f63b058277925e2db449e3e1dd76c47ad9d6mark --bindDN "cn=Directory Manager" \
4446f63b058277925e2db449e3e1dd76c47ad9d6mark --bindPassword password \
4446f63b058277925e2db449e3e1dd76c47ad9d6mark --backend-name userRoot \
4446f63b058277925e2db449e3e1dd76c47ad9d6mark --set "disk-low-threshold:2 GB" \
4446f63b058277925e2db449e3e1dd76c47ad9d6mark --set "disk-full-threshold:1 GB" \
4446f63b058277925e2db449e3e1dd76c47ad9d6mark --trustAll \
4446f63b058277925e2db449e3e1dd76c47ad9d6mark --no-prompt</userinput>
4446f63b058277925e2db449e3e1dd76c47ad9d6mark The properties
4446f63b058277925e2db449e3e1dd76c47ad9d6mark <literal>disk-low-threshold</literal> and <literal>disk-full-threshold</literal>
4446f63b058277925e2db449e3e1dd76c47ad9d6mark are listed as "advanced" properties.
4446f63b058277925e2db449e3e1dd76c47ad9d6mark To examine their values with the <command>dsconfig</command> command,
4446f63b058277925e2db449e3e1dd76c47ad9d6mark as shown in the following example.
4446f63b058277925e2db449e3e1dd76c47ad9d6mark$ <userinput>dsconfig \
4446f63b058277925e2db449e3e1dd76c47ad9d6mark get-backend-prop \
4446f63b058277925e2db449e3e1dd76c47ad9d6mark --advanced \
4446f63b058277925e2db449e3e1dd76c47ad9d6mark --port 4444 \
4446f63b058277925e2db449e3e1dd76c47ad9d6mark --bindDN "cn=Directory Manager" \
4446f63b058277925e2db449e3e1dd76c47ad9d6mark --bindPassword password \
4446f63b058277925e2db449e3e1dd76c47ad9d6mark --backend-name userRoot \
4446f63b058277925e2db449e3e1dd76c47ad9d6mark --property disk-low-threshold \
4446f63b058277925e2db449e3e1dd76c47ad9d6mark --property disk-full-threshold \
4446f63b058277925e2db449e3e1dd76c47ad9d6mark --trustAll \
4446f63b058277925e2db449e3e1dd76c47ad9d6mark --no-prompt</userinput>
4446f63b058277925e2db449e3e1dd76c47ad9d6mark<computeroutput>Property : Value(s)
4446f63b058277925e2db449e3e1dd76c47ad9d6mark--------------------:---------
4446f63b058277925e2db449e3e1dd76c47ad9d6markdisk-full-threshold : 1 gb
4446f63b058277925e2db449e3e1dd76c47ad9d6markdisk-low-threshold : 2 gb</computeroutput>
4446f63b058277925e2db449e3e1dd76c47ad9d6mark </section>
02f907dad5f11dd22aa0123293c89be4f5499576mark <title>Updating an Existing Backend to Add a New Base DN</title>
02f907dad5f11dd22aa0123293c89be4f5499576mark <indexterm>
02f907dad5f11dd22aa0123293c89be4f5499576mark </indexterm>
02f907dad5f11dd22aa0123293c89be4f5499576mark In addition to letting you create new backends as described in
02f907dad5f11dd22aa0123293c89be4f5499576mark OpenDJ lets you add a new base DN to an existing backend.
02f907dad5f11dd22aa0123293c89be4f5499576mark The following example adds the suffix <literal>o=example</literal>
02f907dad5f11dd22aa0123293c89be4f5499576mark$ <userinput>dsconfig \
02f907dad5f11dd22aa0123293c89be4f5499576mark set-backend-prop \
02f907dad5f11dd22aa0123293c89be4f5499576mark --port 4444 \
02f907dad5f11dd22aa0123293c89be4f5499576mark --bindDN "cn=Directory Manager" \
02f907dad5f11dd22aa0123293c89be4f5499576mark --bindPassword password \
02f907dad5f11dd22aa0123293c89be4f5499576mark --backend-name userRoot \
02f907dad5f11dd22aa0123293c89be4f5499576mark --add base-dn:o=example \
02f907dad5f11dd22aa0123293c89be4f5499576mark --trustAll \
02f907dad5f11dd22aa0123293c89be4f5499576mark --no-prompt</userinput>
02f907dad5f11dd22aa0123293c89be4f5499576mark$ <userinput>dsconfig \
02f907dad5f11dd22aa0123293c89be4f5499576mark get-backend-prop \
02f907dad5f11dd22aa0123293c89be4f5499576mark --port 4444 \
02f907dad5f11dd22aa0123293c89be4f5499576mark --bindDN "cn=Directory Manager" \
02f907dad5f11dd22aa0123293c89be4f5499576mark --bindPassword password \
02f907dad5f11dd22aa0123293c89be4f5499576mark --backend-name userRoot \
02f907dad5f11dd22aa0123293c89be4f5499576mark --property base-dn \
02f907dad5f11dd22aa0123293c89be4f5499576mark --trustAll \
02f907dad5f11dd22aa0123293c89be4f5499576mark --no-prompt</userinput>
02f907dad5f11dd22aa0123293c89be4f5499576mark<computeroutput>Property : Value(s)
02f907dad5f11dd22aa0123293c89be4f5499576mark---------:-------------------------------
02f907dad5f11dd22aa0123293c89be4f5499576markbase-dn : "dc=example,dc=com", o=example</computeroutput>
02f907dad5f11dd22aa0123293c89be4f5499576mark Alternatively, you can update an existing backend in OpenDJ Control Panel
02f907dad5f11dd22aa0123293c89be4f5499576mark (Directory Data > New Base DN,
02f907dad5f11dd22aa0123293c89be4f5499576mark then select the existing backend from the dropdown Backend list,
02f907dad5f11dd22aa0123293c89be4f5499576mark and enter the new Base DN name).
02f907dad5f11dd22aa0123293c89be4f5499576mark </section>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <indexterm>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </indexterm>
ec40cc0dc62425cea5d63fd9d984f8614479de25mark You delete a database backend by using the
ec40cc0dc62425cea5d63fd9d984f8614479de25mark ><command>dsconfig delete-backend</command></link> command.
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>When you delete a database backend by using the <command>dsconfig
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark delete-backend</command> command, OpenDJ does not actually remove the
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark database files for two reasons. First, a mistake could potentially cause
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark lots of data to be lost. Second, deleting a large database backend could
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark cause severe service degradation due to a sudden increase in I/O load.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Instead, after you run the <command>dsconfig delete-backend</command>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark command you must also manually remove the database backend files.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>If you do run the <command>dsconfig delete-backend</command> command by
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark mistake and have not yet deleted the actual files, then you can recover from
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark the mistake by creating the backend again, reconfiguring the indexes that
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark were removed, and rebuilding the indexes as described in the section on <link
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xlink:role="http://docbook.org/xlink/role/olink"><citetitle>Configuring &
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </section>