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

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