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 \ authcid\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 [\c
  54 .IR user ]
  55 .SH DESCRIPTION
  56 .B ldappasswd
  57 is a tool to set the password of an LDAP user.
  58 .LP
  59 .B ldappasswd
  60 sets the password of associated with the user [or an optionally
  61 specified
  62 .IR user ].
  63 If the new
  64 password is not specified on the command line and the user
  65 doesn't enable prompting, the server will be asked to generate
  66 a password for the user.
  67 .LP
  68 .B ldappasswd
  69 is neither designed nor intended to be a replacement for
  70 .BR passwd (1)
  71 and should not be installed as such.
  72 .SH OPTIONS
  73 .TP
  74 .BI \-A
  75 Prompt for old password.
  76 This is used instead of specifying the password on the command line.
  77 .TP
  78 .BI \-a \ oldPasswd
  79 Set the old password to \fIoldPasswd\fP.
  80 .TP
  81 .B \-C
  82 Automatically chase referrals.
  83 .TP
  84 .B \-x
  85 Use simple authentication instead of SASL.
  86 .TP
  87 .BI \-D \ binddn
  88 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
  89 .TP
  90 .BI \-d \ debuglevel
  91 Set the LDAP debugging level to \fIdebuglevel\fP.
  92 .B ldappasswd
  93 must be compiled with LDAP_DEBUG defined for this option to have any effect.
  94 .TP
  95 .BI \-H \ ldapuri
  96 Specify URI(s) referring to the ldap server(s).
  97 .TP
  98 .BI \-h \ ldaphost
  99 Specify an alternate host on which the ldap server is running.
 100 Deprecated in favor of -H.
 101 .TP
 102 .BI \-p \ ldapport
 103 Specify an alternate TCP port where the ldap server is listening.
 104 Deprecated in favor of -H.
 105 .TP
 106 .B \-n
 107 Do not set password. (Can be useful when used in conjunction with
 108 .BR \-v \ or
 109 .BR \-d )
 110 .TP
 111 .BI \-S
 112 Prompt for new password.
 113 This is used instead of specifying the password on the command line.
 114 .TP
 115 .BI \-s \ newPasswd
 116 Set the new password to \fInewPasswd\fP.
 117 .TP
 118 .B \-v
 119 Increase the verbosity of output.  Can be specified multiple times.
 120 .TP
 121 .BI \-W
 122 Prompt for bind password.
 123 This is used instead of specifying the password on the command line.
 124 .TP
 125 .BI \-w \ passwd
 126 Use \fIpasswd\fP as the password to bind with.
 127 .TP
 128 .BI \-O \ security-properties
 129 Specify SASL security properties.
 130 .TP
 131 .B \-I
 132 Enable SASL Interactive mode.  Always prompt.  Default is to prompt
 133 only as needed.
 134 .TP
 135 .B \-Q
 136 Enable SASL Quiet mode.  Never prompt.
 137 .TP
 138 .BI \-U \ authcid
 139 Specify the authentication ID for SASL bind. The form of the ID
 140 depends on the actual SASL mechanism used.
 141 .TP
 142 .BI \-X \ authzid
 143 Specify the requested authorization ID for SASL bind.
 144 .I authzid
 145 must be one of the following formats:
 146 .BI dn: <distinguished name>
 147 or
 148 .BI u: <username>\fP.
 149 .TP
 150 .BI \-Y \ mech
 151 Specify the SASL mechanism to be used for authentication. If it's not
 152 specified, the program will choose the best mechanism the server knows.
 153 .TP
 154 .B \-Z[Z]
 155 Issue StartTLS (Transport Layer Security) extended operation. If you use
 156 .BR \-ZZ ,
 157 the command will require the operation to be successful
 158 .SH SEE ALSO
 159 .BR ldap_sasl_bind (3)
 160 .BR ldap_extended_operation (3)
 161 .BR ldap_start_tls (3)
 162 .SH AUTHOR
 163 The OpenLDAP Project <http://www.openldap.org/>
 164 .SH ACKNOWLEDGEMENTS
 165 .B      OpenLDAP
 166 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 167 .B      OpenLDAP
 168 is derived from University of Michigan LDAP 3.3 Release.