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

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