mirror of https://github.com/OpenIdentityPlatform/OpenDJ.git

Mark Craig
14.11.2012 2dba9b9beb52a409bb9d3a5c947704008e8d724e
opendj3/src/main/docbkx/shared/man-ldappasswordmodify.xml
@@ -20,7 +20,7 @@
  !
  ! CCPL HEADER END
  !
  !      Copyright 2011 ForgeRock AS
  !      Copyright 2011-2012 ForgeRock AS
  !    
-->
<refentry xml:id='ldappasswordmodify-1'
@@ -30,7 +30,7 @@
 xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
 xmlns:xlink='http://www.w3.org/1999/xlink'
 xmlns:xinclude='http://www.w3.org/2001/XInclude'>
 <info><copyright><year>2011</year><holder>ForgeRock AS</holder></copyright></info>
 <info><copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright></info>
 <refmeta>
  <refentrytitle>ldappasswordmodify</refentrytitle><manvolnum>1</manvolnum>
  <refmiscinfo class="software">OpenDJ</refmiscinfo>
@@ -70,6 +70,13 @@
    </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>
@@ -82,12 +89,6 @@
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-F, --newPasswordFile {file}</option></term>
    <listitem>
     <para>Path to a file containing the new password to provide 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>
@@ -98,12 +99,33 @@
    <listitem>
     <para>New password to provide for the target user</para>
    </listitem>
   </varlistentry>
   </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>
@@ -111,12 +133,6 @@
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-E, --reportAuthzID</option></term>
     <listitem>
      <para>Use the authorization identity control</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-h, --hostname {host}</option></term>
     <listitem>
      <para>Directory server hostname or IP address</para>
@@ -136,18 +152,6 @@
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-N, --certNickname {nickname}</option></term>
     <listitem>
      <para>Nickname of certificate for SSL client authentication</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-o, --saslOption {name=value}</option></term>
     <listitem>
      <para>SASL bind options</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-p, --port {port}</option></term>
     <listitem>
      <para>Directory server port number</para>
@@ -167,7 +171,7 @@
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-T, --trustStorePassword {trustStorePassword}</option></term>
     <term><option>--trustStorePassword {trustStorePassword}</option></term>
     <listitem>
      <para>Certificate trust store PIN</para>
     </listitem>
@@ -185,19 +189,6 @@
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>--usePasswordPolicyControl</option></term>
     <listitem>
      <para>Use the password policy request control</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-V, --ldapVersion {version}</option></term>
     <listitem>
      <para>LDAP protocol version number</para>
      <para>Default value: 3</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-w, --bindPassword {bindPassword}</option></term>
     <listitem>
      <para>Password to use to bind to the server</para>
@@ -241,9 +232,15 @@
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-v, --verbose</option></term>
     <term><option>-?, -H, --help</option></term>
     <listitem>
      <para>Use verbose mode</para>
      <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>
@@ -311,10 +308,10 @@
  <title>Examples</title>
  <para>The following example demonstrates a user changing the password
  for her entry.</para>
  <screen>$ cat /tmp/currpwd.txt /tmp/newpwd.txt
  <screen>$ cat /tmp/currpwd.txt /tmp/newpwd.txt
bribery
secret12
$ ldappasswordmodify -p 1389 -C /tmp/currpwd.txt -F /tmp/newpwd.txt
$ ldappasswordmodify -p 1389 -C /tmp/currpwd.txt -N /tmp/newpwd.txt
 -a "dn:uid=kvaughan,ou=people,dc=example,dc=com"
 -D uid=kvaughan,ou=people,dc=example,dc=com -w bribery
The LDAP password modify operation was successful</screen>