822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington<?xml version="1.0" encoding="UTF-8"?>
70e5a7403f0e0a3bd292b8287c5fed5772c15270Automatic Updater<!--
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews ! CCPL HEADER START
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence !
ec5347e2c775f027573ce5648b910361aa926c01Automatic Updater ! This work is licensed under the Creative Commons
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington ! To view a copy of this license, visit
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence ! http://creativecommons.org/licenses/by-nc-nd/3.0/
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews ! or send a letter to Creative Commons, 444 Castro Street,
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews ! Suite 900, Mountain View, California, 94041, USA.
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews !
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews ! You can also obtain a copy of the license at
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews ! See the License for the specific language governing permissions
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews ! and limitations under the License.
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington !
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington ! If applicable, add the following below this CCPL HEADER, with the fields
8ec993c774d7c996cb266d0ff5f1282fa3940f09Evan Hunt ! enclosed by brackets "[]" replaced with your own identifying information:
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein ! Portions Copyright [yyyy] [name of copyright owner]
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein !
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington ! CCPL HEADER END
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington !
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington ! Copyright 2011-2014 ForgeRock AS
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington !
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington-->
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington<refentry xml:id='ldappasswordmodify-1'
1a69a1a78cfaa86f3b68bbc965232b7876d4da2aDavid Lawrence xmlns='http://docbook.org/ns/docbook'
364a82f7c25b62967678027043425201a5e5171aBob Halley version='5.0' xml:lang='en'
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington xsi:schemaLocation='http://docbook.org/ns/docbook
600cfa2ba4c50017581b6c14e3a688a82ecebbe0David Lawrence http://docbook.org/xml/5.0/xsd/docbook.xsd'
600cfa2ba4c50017581b6c14e3a688a82ecebbe0David Lawrence xmlns:xlink='http://www.w3.org/1999/xlink'>
600cfa2ba4c50017581b6c14e3a688a82ecebbe0David Lawrence <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <refmeta>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <refentrytitle>ldappasswordmodify</refentrytitle><manvolnum>1</manvolnum>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <refmiscinfo class="software">OpenDJ</refmiscinfo>
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein </refmeta>
1a69a1a78cfaa86f3b68bbc965232b7876d4da2aDavid Lawrence <refnamediv>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <refname>ldappasswordmodify</refname>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <refpurpose>perform LDAP password modifications</refpurpose>
87cafc5e70f79f2586d067fbdd64f61bbab069d2David Lawrence </refnamediv>
87cafc5e70f79f2586d067fbdd64f61bbab069d2David Lawrence <refsynopsisdiv>
87cafc5e70f79f2586d067fbdd64f61bbab069d2David Lawrence <cmdsynopsis>
87cafc5e70f79f2586d067fbdd64f61bbab069d2David Lawrence <command>ldappasswordmodify</command>
87cafc5e70f79f2586d067fbdd64f61bbab069d2David Lawrence <arg choice="req">options</arg>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington </cmdsynopsis>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington </refsynopsisdiv>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <refsect1>
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein <title>Description</title>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <para>This utility can be used to perform LDAP password modify operations in
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington the directory.</para>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson </refsect1>
87cafc5e70f79f2586d067fbdd64f61bbab069d2David Lawrence <refsect1>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson <title>Options</title>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <para>The following options are supported.</para>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson <variablelist>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson <varlistentry>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson <term><option>-a, --authzID {authzID}</option></term>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson <listitem>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <para>Authorization ID for the user entry whose password should be changed</para>
91cd0f93ad34d23e8b09dca337120f64fbe8f0a1Andreas Gustafsson <para>The authorization ID is a string having either the prefix
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <literal>dn:</literal> followed by the user's distinguished name, or
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington the prefix <literal>u:</literal> followed by a user identifier that
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington depends on the identity mapping used to match the user identifier to
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington an entry in the directory. Examples include
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <literal>dn:uid=bjensen,ou=People,dc=example,dc=com</literal>, and, if
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington we assume that <literal>bjensen</literal> is mapped to Barbara Jensen's
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington entry, <literal>u:bjensen</literal>.</para>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington </listitem>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington </varlistentry>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson <varlistentry>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson <term><option>-A, --provideDNForAuthzID</option></term>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson <listitem>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson <para>Use the bind DN as the authorization ID for the password modify
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson operation</para>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington </listitem>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson </varlistentry>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <varlistentry>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <term><option>-c, --currentPassword {currentPassword}</option></term>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <listitem>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <para>Current password for the target user</para>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington </listitem>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington </varlistentry>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <varlistentry>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <term><option>-C, --currentPasswordFile {file}</option></term>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <listitem>
8ec993c774d7c996cb266d0ff5f1282fa3940f09Evan Hunt <para>Path to a file containing the current password for the target user</para>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington </listitem>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington </varlistentry>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <varlistentry>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <term><option>-J, --control {controloid[:criticality[:value|::b64value|:&lt;filePath]]}</option></term>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <listitem>
8ec993c774d7c996cb266d0ff5f1282fa3940f09Evan Hunt <para>Use a request control with the provided information</para>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington </listitem>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington </varlistentry>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <varlistentry>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <term><option>-n, --newPassword {newPassword}</option></term>
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein <listitem>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <para>New password to provide for the target user</para>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson </listitem>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson </varlistentry>
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein <varlistentry>
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein <term><option>-N, --newPasswordFile {file}</option></term>
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein <listitem>
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein <para>Path to a file containing the new password to provide for the
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson target user</para>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson </listitem>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson </varlistentry>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson </variablelist>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <refsect2>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <title>LDAP Connection Options</title>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <variablelist>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <varlistentry>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <term><option>--certNickname {nickname}</option></term>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <listitem>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <para>Nickname of certificate for SSL client authentication</para>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson </listitem>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson </varlistentry>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <varlistentry>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <term><option>--connectTimeout {timeout}</option></term>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <listitem>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <para>Maximum length of time (in milliseconds) that can be taken to
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson establish a connection. Use '0' to specify no time out.</para>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <para>Default: 30000</para>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson </listitem>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson </varlistentry>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <varlistentry>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <term><option>-D, --bindDN {bindDN}</option></term>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <listitem>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <para>DN to use to bind to the server</para>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <para>Default value: cn=Directory Manager</para>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson </listitem>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson </varlistentry>
f5af519ab547bc80c51387529103e4e852a1171eMark Andrews <varlistentry>
f5af519ab547bc80c51387529103e4e852a1171eMark Andrews <term><option>-h, --hostname {host}</option></term>
f5af519ab547bc80c51387529103e4e852a1171eMark Andrews <listitem>
f5af519ab547bc80c51387529103e4e852a1171eMark Andrews <para>Directory server hostname or IP address</para>
f5af519ab547bc80c51387529103e4e852a1171eMark Andrews <para>Default value: localhost.localdomain</para>
f5af519ab547bc80c51387529103e4e852a1171eMark Andrews </listitem>
f5af519ab547bc80c51387529103e4e852a1171eMark Andrews </varlistentry>
f5af519ab547bc80c51387529103e4e852a1171eMark Andrews <varlistentry>
f5af519ab547bc80c51387529103e4e852a1171eMark Andrews <term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>
f5af519ab547bc80c51387529103e4e852a1171eMark Andrews <listitem>
f5af519ab547bc80c51387529103e4e852a1171eMark Andrews <para>Bind password file</para>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson </listitem>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson </varlistentry>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <varlistentry>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <term><option>-K, --keyStorePath {keyStorePath}</option></term>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <listitem>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <para> Certificate key store path</para>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson </listitem>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson </varlistentry>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <varlistentry>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <term><option>-p, --port {port}</option></term>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <listitem>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <para>Directory server port number</para>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <para>Default value: 389</para>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson </listitem>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson </varlistentry>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <varlistentry>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <term><option>-P, --trustStorePath {trustStorePath}</option></term>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <listitem>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <para>Certificate trust store path</para>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson </listitem>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson </varlistentry>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <varlistentry>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <term><option>-q, --useStartTLS</option></term>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <listitem>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <para>Use StartTLS to secure communication with the server</para>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson </listitem>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson </varlistentry>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <varlistentry>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <term><option>--trustStorePassword {trustStorePassword}</option></term>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <listitem>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <para>Certificate trust store PIN</para>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson </listitem>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson </varlistentry>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <varlistentry>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <listitem>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <para>Certificate key store PIN file</para>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington </listitem>
add4043305ca411202ed9cf1929a4179016515ceBrian Wellington </varlistentry>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <varlistentry>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <term><option>-U, --trustStorePasswordFile {path}</option></term>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <listitem>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <para>Certificate trust store PIN file</para>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson </listitem>
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence </varlistentry>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <varlistentry>
add4043305ca411202ed9cf1929a4179016515ceBrian Wellington <term><option>-w, --bindPassword {bindPassword}</option></term>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <listitem>
add4043305ca411202ed9cf1929a4179016515ceBrian Wellington <para>Password to use to bind to the server</para>
add4043305ca411202ed9cf1929a4179016515ceBrian Wellington </listitem>
add4043305ca411202ed9cf1929a4179016515ceBrian Wellington </varlistentry>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <varlistentry>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <listitem>
a2b8bb87775ed6c7cd245cd615fca4529ec18ae0Mark Andrews <para>Certificate key store PIN</para>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson </listitem>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington </varlistentry>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <varlistentry>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <term><option>-X, --trustAll</option></term>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <listitem>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <para>Trust all server SSL certificates</para>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington </listitem>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington </varlistentry>
9bf765ab3a5203b854d32266e6162e547791383cDavid Lawrence <varlistentry>
734ae1f7c6abafe1f1ca164aad7a3dd01ee82cbdBrian Wellington <term><option>-Z, --useSSL</option></term>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <listitem>
9bf765ab3a5203b854d32266e6162e547791383cDavid Lawrence <para>Use SSL for secure communication with the server</para>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson </listitem>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson </varlistentry>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson </variablelist>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson </refsect2>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <refsect2>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <title>Utility Input/Output Options</title>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <variablelist>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <varlistentry>
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence <term><option>--noPropertiesFile</option></term>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <listitem>
2c9c7c5bb5975a18925c30aeb33a26094902f1c1Andreas Gustafsson <para>No properties file will be used to get default command line
9bf765ab3a5203b854d32266e6162e547791383cDavid Lawrence argument values</para>
9bf765ab3a5203b854d32266e6162e547791383cDavid Lawrence </listitem>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington </varlistentry>
87cafc5e70f79f2586d067fbdd64f61bbab069d2David Lawrence <varlistentry>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <term><option>--propertiesFilePath {propertiesFilePath}</option></term>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <listitem>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <para>Path to the file containing default property values used for
6e49e91bd08778d7eae45a2229dcf41ed97cc636David Lawrence command line arguments</para>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington </listitem>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington </varlistentry>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <varlistentry>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <term><option>-?, -H, --help</option></term>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <listitem>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <para>Display usage information</para>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington </listitem>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington </varlistentry>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <varlistentry>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <term><option>-V, --version</option></term>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <listitem>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <para>Display directory server version information</para>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington </listitem>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington </varlistentry>
6e49e91bd08778d7eae45a2229dcf41ed97cc636David Lawrence </variablelist>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington </refsect2>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <refsect2>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <title>General Options</title>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <variablelist>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <varlistentry>
822f6cdabb1edd44472c7a758b5cae71376fa9beBrian Wellington <term><option>--version</option></term>
<listitem>
<para>Display version information</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-?, -H, --help</option></term>
<listitem>
<para>Display usage information</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1>
<title>Exit Codes</title>
<variablelist>
<varlistentry>
<term>0</term>
<listitem>
<para>The command completed successfully.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>ldap-error</replaceable></term>
<listitem>
<para>An LDAP error occurred while processing the operation.</para>
<para>LDAP result codes are described in <link
xlink:href="http://tools.ietf.org/html/rfc4511#appendix-A">RFC
4511</link>. Also see the additional information for details.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>89</term>
<listitem>
<para>An error occurred while parsing the command-line arguments.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Files</title>
<para>You can use <filename>~/.opendj/tools.properties</filename> to set
the defaults for bind DN, host name, and port number as in the following
example.</para>
<programlisting language="ini">
hostname=directory.example.com
port=1389
bindDN=uid=kvaughan,ou=People,dc=example,dc=com
ldapcompare.port=1389
ldapdelete.port=1389
ldapmodify.port=1389
ldappasswordmodify.port=1389
ldapsearch.port=1389
</programlisting>
</refsect1>
<refsect1>
<title>Examples</title>
<para>The following example demonstrates a user changing the password
for her entry.</para>
<screen>
$ <userinput>cat /tmp/currpwd.txt /tmp/newpwd.txt</userinput>
<computeroutput>bribery
secret12</computeroutput>
$ <userinput>ldappasswordmodify -p 1389 -C /tmp/currpwd.txt -N /tmp/newpwd.txt \
-A -D uid=kvaughan,ou=people,dc=example,dc=com -w bribery</userinput>
<computeroutput>The LDAP password modify operation was successful</computeroutput>
</screen>
</refsect1>
</refentry>