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.
ec40cc0dc62425cea5d63fd9d984f8614479de25mark xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>OpenDJ server software installs with a cross-platform, Java Swing-based
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark Control Panel for many day-to-day tasks. OpenDJ server software also installs
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark command-line tools for configuration and management tasks.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>This chapter is one of the few to include screen shots of the control
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark panel. Most examples make use of the command-line tools. Once you understand
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark the concepts, and how to perform a task using the command-line tools, you
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark no doubt need no more than to know where to start in the Control Panel to
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark accomplish what you set out to do.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>At a protocol level, administration tools and interfaces connect to
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark servers through a different network port than that used to listen for traffic
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark from other client applications.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>This chapter takes a quick look at the tools for managing directory
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark services.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <indexterm><primary>Control panel</primary></indexterm>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>OpenDJ Control Panel offers a graphical user interface for
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark managing both local and remote servers. You choose the server to manage
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark when you start the Control Panel. The Control Panel connects to the
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark administration server port, making a secure LDAPS connection.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <itemizedlist>
ec40cc0dc62425cea5d63fd9d984f8614479de25mark Start OpenDJ Control Panel by running the
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
429cb4af0dd170c44fe076f66fb43338d1820073mark <para>(Linux, Solaris) Run <command>/path/to/opendj/bin/control-panel</command>.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
429cb4af0dd170c44fe076f66fb43338d1820073mark <para>(Windows) Double-click <filename>C:\path\to\opendj\bat\control-panel.bat</filename>.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
429cb4af0dd170c44fe076f66fb43338d1820073mark <para>(Mac OS X) Double-click <filename>/path/to/opendj/bin/ControlPanel.app</filename>.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </itemizedlist>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>When you login to OpenDJ Control Panel, you authenticate over LDAP.
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark This means that if users can run the Control Panel, they can use it to manage
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark a running server. Yet, to start and stop the server process through OpenDJ
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark Control Panel, you must start the Control Panel on the system where OpenDJ
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark runs, as the user who owns the OpenDJ server files (such as the user who
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark installed OpenDJ). In other words, the OpenDJ Control Panel does not do
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark remote process management.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <imageobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <imagedata fileref="images/OpenDJ-Control-Panel.png" format="PNG" />
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </imageobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <caption><para>OpenDJ Control Panel displays key information about the
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </mediaobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <variablelist>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Down the left side of OpenDJ Control Panel, notice what you can
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark configure.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Directory data provisioning is typically not something you do
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark by hand in most deployments. Usually entries are created, modified, and
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark deleted through specific directory client applications. The Manage
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark Entries window can be useful, however, both in the lab as you design
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark and test directory data, and also if you modify individual ACIs or
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark debug issues with particular entries.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <imageobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <imagedata fileref="images/Manage-Entries.png" format="PNG" />
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </imageobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <caption><para>The Manage Entries window can check that your changes are
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark valid before sending the request to the directory.</para></caption>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </mediaobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Additionally, the Directory Data list makes it easy to create
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark a new base DN, and then import user data for the new base DN from LDIF.
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark You can also use the tools in the list to export user data to LDIF,
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark and to backup and restore user data.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>The Manage Schema window lets you browse and modify the rules
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark that define how data is stored in the directory. You can add new schema
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark definitions such as new attribute types and new object classes while the
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark server is running, and the changes you make take effect immediately.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>The Manage Indexes window gives you a quick overview of all
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark the indexes currently maintained for directory attributes. To protect
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark your directory resources from being absorbed by costly searches on
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark unindexed attributes, you may choose to keep the default behavior,
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark preventing unindexed searches, instead adding indexes required by specific
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark applications. (Notice that if the number of user data entries is smaller
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark than the default resource limits, you can still perform what appear
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark to be unindexed searches. That is because the <literal>dn2id</literal>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark index returns all user data entries without hitting a resource limit that
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark would make the search unindexed.)</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>OpenDJ Control Panel also allows you to verify and rebuild
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark existing indexes, which you may have to do after an upgrade operation,
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark or if you have reason to suspect index corruption.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>The Monitoring list gives you windows to observe information
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark about the system, the JVM used, and indications about how the cache is
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark used, whether the work queue has been filling up, as well as details
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark about the database. You can also view the numbers and types of requests
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark arriving over the connection handlers, and the current tasks in progress
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark as well.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>If you did not set appropriate JVM runtime options during the
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark installation process, this is the list that allows you to do so through
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark the Control Panel.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </variablelist>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </section>
429cb4af0dd170c44fe076f66fb43338d1820073mark <para>Before you try the examples in this guide, set your PATH to include
429cb4af0dd170c44fe076f66fb43338d1820073mark the OpenDJ directory server tools. Where the tools are located depends on
429cb4af0dd170c44fe076f66fb43338d1820073mark the operating system and on the packages used to install OpenDJ.</para>
2ac4d9073bf18e65be47a6421bf43f91323ad963mark <entry>Apple Mac OS X, Linux distributions, Oracle Solaris</entry>
2ac4d9073bf18e65be47a6421bf43f91323ad963mark <entry><filename>/path/to/opendj/bin</filename></entry>
2ac4d9073bf18e65be47a6421bf43f91323ad963mark <entry><filename>C:\path\to\opendj\bat</filename></entry>
ec40cc0dc62425cea5d63fd9d984f8614479de25mark You find the installation and upgrade tools,
ec40cc0dc62425cea5d63fd9d984f8614479de25mark in the parent directory of the other tools,
ec40cc0dc62425cea5d63fd9d984f8614479de25mark as these tools are not used for everyday administration.
ec40cc0dc62425cea5d63fd9d984f8614479de25mark For example, if the path to most tools is
ec40cc0dc62425cea5d63fd9d984f8614479de25mark you can find these tools in
ec40cc0dc62425cea5d63fd9d984f8614479de25mark For instructions on how to use the installation and upgrade tools, see the
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>All OpenDJ command-line tools take the <option>--help</option> option.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>All commands call Java programs and therefore involve starting a
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark JVM.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>The following list uses the UNIX names for the tools. On Windows
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark all command-line tools have the extension .bat.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <variablelist>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xlink:role="http://docbook.org/xlink/role/olink">backup</link></term>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Backup or schedule backup of directory data.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xlink:role="http://docbook.org/xlink/role/olink">base64</link></term>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Base64 encoding represents binary data in ASCII, and can be used to
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark encode character strings in LDIF, for example.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xlink:role="http://docbook.org/xlink/role/olink">create-rc-script</link>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark (UNIX)</term>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Generate a script you can use to start, stop, and restart the server
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark either directly or at system boot and shutdown. Use <command>create-rc-script -f
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <replaceable>script-file</replaceable></command>.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xlink:role="http://docbook.org/xlink/role/olink">dbtest</link></term>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xlink:role="http://docbook.org/xlink/role/olink">dsconfig</link></term>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>The <command>dsconfig</command> command is the primary command-line
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark tool for viewing and editing OpenDJ configuration. When started without
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark arguments, <command>dsconfig</command> prompts you for administration
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark connection information. Once connected it presents you with a menu-driven
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark interface to the server configuration.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>When you pass connection information, subcommands, and additional
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark options to <command>dsconfig</command>, the command runs in script mode
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark and so is not interactive.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>You can prepare <command>dsconfig</command> batch scripts by running
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark the tool with the <option>--commandFilePath</option> option in interactive
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark mode, then reading from the batch file with the
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <option>--batchFile</option> option in script mode. Batch files can be
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark useful when you have many <command>dsconfig</command> commands to run
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark and want to avoid starting the JVM and setting up a new connection for
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark each command.</para>
57d6342a74476c0bf2200992e778229d62ab1fa6mark <para>In addition to the <link xlink:href="reference#dsconfig-1"
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xlink:role="http://docbook.org/xlink/role/olink">dsconfig</link> reference
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ><citetitle>Configuration Reference</citetitle></link> covers the
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark properties you can set using the <command>dsconfig</command>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark command.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <term><link xlink:href="admin-guide#dsframework-1"
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xlink:role="http://docbook.org/xlink/role/olink">dsframework</link></term>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Manage server registration, server groups, and administrative
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark users.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xlink:role="http://docbook.org/xlink/role/olink">dsjavaproperties</link></term>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Apply changes you make to
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <filename>opendj/config/java.properties</filename>, which sets Java
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark runtime options.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xlink:role="http://docbook.org/xlink/role/olink">dsreplication</link></term>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Configure data replication between directory servers to keep their
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark contents in sync.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xlink:role="http://docbook.org/xlink/role/olink">encode-password</link></term>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Encode a clear text password according to one of the available
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark storage schemes.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xlink:role="http://docbook.org/xlink/role/olink">export-ldif</link></term>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Export directory data to LDAP Data Interchange Format, a standard,
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark portable, text-based representation of directory content.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xlink:role="http://docbook.org/xlink/role/olink">import-ldif</link></term>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Load LDIF content into the directory, overwriting existing
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark data.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xlink:role="http://docbook.org/xlink/role/olink">ldapcompare</link></term>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Compare the attribute values you specify with those stored on
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark entries in the directory.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xlink:role="http://docbook.org/xlink/role/olink">ldapdelete</link></term>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Delete one entry or an entire branch of subordinate entries in the
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark directory.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xlink:role="http://docbook.org/xlink/role/olink">ldapmodify</link></term>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Modify the specified attribute values for the specified
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark entries.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Use the <command>ldapmodify</command> command with the
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
57d6342a74476c0bf2200992e778229d62ab1fa6mark <term><link xlink:href="reference#ldappasswordmodify-1"
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xlink:role="http://docbook.org/xlink/role/olink">ldappasswordmodify</link></term>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xlink:role="http://docbook.org/xlink/role/olink">ldapsearch</link></term>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Search a branch of directory data for entries matching the LDAP
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark filter that you specify.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xlink:role="http://docbook.org/xlink/role/olink">ldif-diff</link></term>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Display differences between two LDIF files, with the resulting output
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark having LDIF format.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xlink:role="http://docbook.org/xlink/role/olink">ldifmodify</link></term>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Similar to the <command>ldapmodify</command> command, modify
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark specified attribute values for specified entries in an LDIF file.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xlink:role="http://docbook.org/xlink/role/olink">ldifsearch</link></term>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Similar to the <command>ldapsearch</command> command, search a branch
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark of data in LDIF for entries matching the LDAP filter you specify.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xlink:role="http://docbook.org/xlink/role/olink">list-backends</link></term>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>List backends and base DNs served by OpenDJ.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xlink:role="http://docbook.org/xlink/role/olink">make-ldif</link></term>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Generate directory data in LDIF, based on templates that define how
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark the data should appear.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>The <command>make-ldif</command> command is designed to help you
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark quickly generate test data that mimics data you expect to have in
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark production, but without compromising private information.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xlink:role="http://docbook.org/xlink/role/olink">manage-account</link></term>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Lock and unlock user accounts, and view and manipulate password
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark policy state information.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xlink:role="http://docbook.org/xlink/role/olink">manage-tasks</link></term>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>View information about tasks scheduled to run in the server, and
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark cancel specified tasks.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xlink:role="http://docbook.org/xlink/role/olink">rebuild-index</link></term>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xlink:role="http://docbook.org/xlink/role/olink">restore</link></term>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xlink:role="http://docbook.org/xlink/role/olink">start-ds</link></term>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xlink:role="http://docbook.org/xlink/role/olink">status</link></term>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xlink:role="http://docbook.org/xlink/role/olink">stop-ds</link></term>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xlink:role="http://docbook.org/xlink/role/olink">verify-index</link></term>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Verify that an index stored in a JE backend is not corrupt.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <varlistentry>
429cb4af0dd170c44fe076f66fb43338d1820073mark xlink:role="http://docbook.org/xlink/role/olink">windows-service</link>
429cb4af0dd170c44fe076f66fb43338d1820073mark (Windows only)</term>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </varlistentry>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </variablelist>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </section>