<?xml version="1.0" encoding="UTF-8"?>

<refentry xml:id='ldappasswordmodify-1'

xmlns='http://docbook.org/ns/docbook'

version='5.0' xml:lang='en'

xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'

xsi:schemaLocation='http://docbook.org/ns/docbook

xmlns:xlink='http://www.w3.org/1999/xlink'>

<info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>

<refmeta>

<refentrytitle>ldappasswordmodify</refentrytitle><manvolnum>1</manvolnum>

<refmiscinfo class="software">OpenDJ</refmiscinfo>

<refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>

</refmeta>

<refnamediv>

<refname>ldappasswordmodify</refname>

<refpurpose>perform LDAP password modifications</refpurpose>

</refnamediv>

<refsynopsisdiv>

<cmdsynopsis>

<command>ldappasswordmodify</command>

<arg choice="req">options</arg>

</cmdsynopsis>

</refsynopsisdiv>

<refsect1>

<title>Description</title>

<para>This utility can be used to perform LDAP password modify operations in

the directory.</para>

</refsect1>

<refsect1>

<title>Options</title>

<para>The following options are supported.</para>

<variablelist>

<varlistentry>

<term><option>-a, --authzID {authzID}</option></term>

<listitem>

<para>Authorization ID for the user entry whose password should be changed</para>

<para>The authorization ID is a string having either the prefix

<literal>dn:</literal> followed by the user's distinguished name, or

the prefix <literal>u:</literal> followed by a user identifier that

depends on the identity mapping used to match the user identifier to

an entry in the directory. Examples include

<literal>dn:uid=bjensen,ou=People,dc=example,dc=com</literal>, and, if

we assume that <literal>bjensen</literal> is mapped to Barbara Jensen's

entry, <literal>u:bjensen</literal>.</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-A, --provideDNForAuthzID</option></term>

<listitem>

<para>Use the bind DN as the authorization ID for the password modify

operation</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-c, --currentPassword {currentPassword}</option></term>

<listitem>

<para>Current password for the target user</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-C, --currentPasswordFile {file}</option></term>

<listitem>

<para>Path to a file containing the current password for the target user</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-J, --control {controloid[:criticality[:value|::b64value|:&lt;filePath]]}</option></term>

<listitem>

<para>Use a request control with the provided information</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-n, --newPassword {newPassword}</option></term>

<listitem>

<para>New password to provide for the target user</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-N, --newPasswordFile {file}</option></term>

<listitem>

<para>Path to a file containing the new password to provide for the

target user</para>

</listitem>

</varlistentry>

</variablelist>

<refsect2>

<title>LDAP Connection Options</title>

<variablelist>

<varlistentry>

<term><option>--certNickname {nickname}</option></term>

<listitem>

<para>Nickname of certificate for SSL client authentication</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>--connectTimeout {timeout}</option></term>

<listitem>

<para>Maximum length of time (in milliseconds) that can be taken to

establish a connection. Use '0' to specify no time out.</para>

<para>Default: 30000</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-D, --bindDN {bindDN}</option></term>

<listitem>

<para>DN to use to bind to the server</para>

<para>Default value: cn=Directory Manager</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-h, --hostname {host}</option></term>

<listitem>

<para>Directory server hostname or IP address</para>

<para>Default value: localhost.localdomain</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>

<listitem>

<para>Bind password file</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-K, --keyStorePath {keyStorePath}</option></term>

<listitem>

<para> Certificate key store path</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-p, --port {port}</option></term>

<listitem>

<para>Directory server port number</para>

<para>Default value: 389</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-P, --trustStorePath {trustStorePath}</option></term>

<listitem>

<para>Certificate trust store path</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-q, --useStartTLS</option></term>

<listitem>

<para>Use StartTLS to secure communication with the server</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>--trustStorePassword {trustStorePassword}</option></term>

<listitem>

<para>Certificate trust store PIN</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>

<listitem>

<para>Certificate key store PIN file</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-U, --trustStorePasswordFile {path}</option></term>

<listitem>

<para>Certificate trust store PIN file</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-w, --bindPassword {bindPassword}</option></term>

<listitem>

<para>Password to use to bind to the server</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-W, --keyStorePassword {keyStorePassword}</option></term>

<listitem>

<para>Certificate key store PIN</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-X, --trustAll</option></term>

<listitem>

<para>Trust all server SSL certificates</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-Z, --useSSL</option></term>

<listitem>

<para>Use SSL for secure communication with the server</para>

</listitem>

</varlistentry>

</variablelist>

</refsect2>

<refsect2>

<title>Utility Input/Output Options</title>

<variablelist>

<varlistentry>

<term><option>--noPropertiesFile</option></term>

<listitem>

<para>No properties file will be used to get default command line

argument values</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>--propertiesFilePath {propertiesFilePath}</option></term>

<listitem>

<para>Path to the file containing default property values used for

command line arguments</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-?, -H, --help</option></term>

<listitem>

<para>Display usage information</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-V, --version</option></term>

<listitem>

<para>Display directory server version information</para>

</listitem>

</varlistentry>

</variablelist>

</refsect2>

<refsect2>

<title>General Options</title>

<variablelist>

<varlistentry>

<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>