git.sur5r.net Git - openldap/blob - doc/man/man1/ldappasswd.1

   1 .TH LDAPPASSWD 1 "20 August 2000" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2000 The OpenLDAP Foundation All Rights Reserved.
   4 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   5 .SH NAME
   6 ldappasswd \- change the password of an LDAP entry
   7 .SH SYNOPSIS
   8 .B ldappasswd
   9 [\c
  10 .BR \-A ]
  11 [\c
  12 .BI \-a \ oldPasswd\fR]
  13 [\c
  14 .BR \-C ]
  15 [\c
  16 .BI \-D \ binddn\fR
  17 [\c
  18 .BI \-d \ debuglevel\fR]
  19 [\c
  20 .BI \-H \ ldapuri\fR]
  21 [\c
  22 .BI \-h \ ldaphost\fR]
  23 [\c
  24 .BR \-n ]
  25 [\c
  26 .BI \-p \ ldapport\fR]
  27 [\c
  28 .BR \-S ]
  29 [\c
  30 .BI \-s \ newPasswd\fR]
  31 [\c
  32 .BR \-v ]
  33 [\c
  34 .BR \-W ]
  35 [\c
  36 .BI \-w \ passwd\fR]
  37 [\c
  38 .BR \-O \ security-properties ]
  39 [\c
  40 .BR \-I ]
  41 [\c
  42 .BR \-Q ]
  43 [\c
  44 .BI \-U \ username\fR]
  45 [\c
  46 .BR \-x ]
  47 [\c
  48 .BI \-X \ authzid\fR]
  49 [\c
  50 .BI \-Y \ mech\fR]
  51 [\c
  52 .BR \-Z[Z] ]
  53 .SH DESCRIPTION
  54 .B ldappasswd
  55 is a tool to set the password of an LDAP user.
  56 .LP
  57 .B ldappasswd
  58 sets the password of associated with the user.  If the new
  59 password is not specified on the command line or the user
  60 doesn't enable prompting, the server will be asked to generate
  61 a password for the user.
  62 .LP
  63 .B ldappasswd
  64 is neither designed nor intended to be a replacement for
  65 .BR passwd (1)
  66 and should not be installed as such.
  67 .SH OPTIONS
  68 .TP
  69 .BI \-A
  70 Prompt for old password.
  71 This is used instead of specifying the password on the command line.
  72 .TP
  73 .BI \-a \ oldPasswd
  74 Set the old password to \fIoldPasswd\fP.
  75 .TP
  76 .B \-C
  77 Automatically chase referrals.
  78 .TP
  79 .B \-x
  80 Use simple authentication instead of SASL.
  81 .TP
  82 .BI \-D \ binddn
  83 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
  84 This flag is not optional.  The user DN will be used if the
  85 bind DN is not provided.
  86 .TP
  87 .BI \-d \ debuglevel
  88 Set the LDAP debugging level to \fIdebuglevel\fP.
  89 .B ldappasswd
  90 must be compiled with LDAP_DEBUG defined for this option to have any effect.
  91 .TP
  92 .BI \-H \ ldapuri
  93 Specify URI(s) referring to the ldap server(s).
  94 .TP
  95 .BI \-h \ ldaphost
  96 Specify an alternate host on which the ldap server is running.
  97 Deprecated in favor of -H.
  98 .TP
  99 .BI \-p \ ldapport
 100 Specify an alternate TCP port where the ldap server is listening.
 101 Deprecated in favor of -H.
 102 .TP
 103 .B \-n
 104 Do not set password. (Can be useful when used in conjunction with
 105 .BR \-v \ or
 106 .BR \-d )
 107 .TP
 108 .BI \-S
 109 Prompt for new password.
 110 This is used instead of specifying the password on the command line.
 111 .TP
 112 .BI \-s \ newPasswd
 113 Set the new password to \fInewPasswd\fP.
 114 .TP
 115 .B \-v
 116 Increase the verbosity of output.  Can be specified multiple times.
 117 .TP
 118 .BI \-W
 119 Prompt for bind password.
 120 This is used instead of specifying the password on the command line.
 121 .TP
 122 .BI \-w \ passwd
 123 Use \fIpasswd\fP as the password to bind with.
 124 .TP
 125 .BI \-O \ security-properties
 126 Specify SASL security properties.
 127 .TP
 128 .B \-I
 129 Enable SASL Interactive mode.  Always prompt.  Default is to prompt
 130 only as needed.
 131 .TP
 132 .B \-Q
 133 Enable SASL Quiet mode.  Never prompt.
 134 .TP
 135 .BI \-U \ username
 136 Specify the username for SASL bind. The syntax of the username depends on the
 137 actual SASL mechanism used.
 138 .TP
 139 .BI \-X \ authzid
 140 Specify the requested authorization ID for SASL bind.
 141 .I authzid
 142 must be one of the following formats:
 143 .BI dn: <distinguished name>
 144 or
 145 .BI u: <username>\fP.
 146 .TP
 147 .BI \-Y \ mech
 148 Specify the SASL mechanism to be used for authentication. If it's not
 149 specified, the program will choose the best mechanism the server knows.
 150 .TP
 151 .B \-Z[Z]
 152 Issue StartTLS (Transport Layer Security) extended operation. If you use
 153 .BR \-ZZ ,
 154 the command will require the operation to be successful
 155 .SH SEE ALSO
 156 .BR ldap_sasl_bind (3)
 157 .BR ldap_extended_operation (3)
 158 .BR ldap_start_tls (3)
 159 .SH AUTHOR
 160 The OpenLDAP Project <http://www.openldap.org/>
 161 .SH ACKNOWLEDGEMENTS
 162 .B      OpenLDAP
 163 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 164 .B      OpenLDAP
 165 is derived from University of Michigan LDAP 3.3 Release.