openldap/doc/man/man1/ldappasswd.1

158 lines
3.5 KiB
Groff
Raw Normal View History

2000-07-14 06:54:45 +08:00
.TH LDAPPASSWD 1 "12 July 2000" "LDAPPasswd"
1999-09-12 12:41:47 +08:00
.\" $OpenLDAP$
2000-05-13 10:47:56 +08:00
.\" Copyright 1998-2000 The OpenLDAP Foundation All Rights Reserved.
1999-09-12 12:41:47 +08:00
.\" Copying restrictions apply. See COPYRIGHT/LICENSE.
.SH NAME
ldappasswd \- change the password of an LDAP entry
.SH SYNOPSIS
.B ldappasswd
1999-12-10 12:59:28 +08:00
[\c
.BR \-A ]
[\c
.BI \-a \ oldPasswd\fR]
2000-06-26 04:29:20 +08:00
[\c
.BR \-C ]
[\c
.BI \-D \ binddn\fR
[\c
.BI \-d \ debuglevel\fR]
[\c
.BI \-h \ ldaphost\fR]
[\c
.BR \-n ]
[\c
.BI \-p \ ldapport\fR]
[\c
1999-12-10 12:59:28 +08:00
.BR \-S ]
[\c
.BI \-s \ newPasswd\fR]
[\c
.BR \-v ]
[\c
.BR \-W ]
[\c
.BI \-w \ passwd\fR]
[\c
2000-07-14 06:54:45 +08:00
.BR \-O \ security-properties ]
[\c
2000-07-17 10:43:41 +08:00
.BR \-I ]
[\c
.BR \-Q ]
[\c
.BI \-U \ username\fR]
[\c
2000-07-16 08:52:04 +08:00
.BR \-x ]
[\c
.BI \-X \ authzid\fR]
[\c
.BI \-Y \ mech\fR]
[\c
.BR \-Z[Z] ]
.SH DESCRIPTION
.B ldappasswd
is a tool to set the password of an LDAP user.
.LP
.B ldappasswd
1999-12-10 12:59:28 +08:00
sets the password of associated with the user. If the new
password is not specified on the command line or the user
doesn't enable prompting, the server will be asked to generate
a password for the user.
2000-07-18 05:54:20 +08:00
.LP
.B ldappasswd
is neither designed nor intended to be a replacement for
.BR passwd (1)
and should not be installed as such.
.SH OPTIONS
.TP
1999-12-10 12:59:28 +08:00
.BI \-A
Prompt for old password.
This is used instead of specifying the password on the command line.
.TP
.BI \-a \ oldPasswd
Set the old password to \fIoldPasswd\fP.
.TP
2000-06-26 04:29:20 +08:00
.B \-C
Automatically chase referrals.
.TP
2000-07-16 08:52:04 +08:00
.B \-x
Use simple authentication instead of SASL.
.TP
.BI \-D \ binddn
Use \fIbinddn\fP to bind to the LDAP directory. \fIbinddn\fP should
be a string-represented DN as defined in RFC 2253.
1999-12-10 12:59:28 +08:00
This flag is not optional. The user DN will be used if the
bind DN is not provided.
.TP
.BI \-d \ debuglevel
Set the LDAP debugging level to \fIdebuglevel\fP.
.B ldappasswd
must be compiled with LDAP_DEBUG defined for this option to have any effect.
.TP
.BI \-h \ ldaphost
Specify an alternate host on which the ldap server is running.
.TP
.B \-n
Do not set password. (Can be useful when used in conjunction with
.BR \-v \ or
.BR \-d )
.TP
1999-12-10 12:59:28 +08:00
.BI \-S
Prompt for new password.
This is used instead of specifying the password on the command line.
.TP
.BI \-s \ newPasswd
1999-12-10 12:59:28 +08:00
Set the new password to \fInewPasswd\fP.
1998-12-27 22:08:46 +08:00
.TP
.BI \-p \ ldapport
Specify an alternate port on which the ldap server is running.
.TP
.B \-v
Increase the verbosity of output. Can be specified multiple times.
.TP
.BI \-W
Prompt for bind password.
This is used instead of specifying the password on the command line.
.TP
.BI \-w \ passwd
Use \fIpasswd\fP as the password to bind with.
.TP
2000-07-14 06:54:45 +08:00
.BI \-O \ security-properties
Specify SASL security properties.
.TP
2000-07-17 10:43:41 +08:00
.B \-I
Enable SASL Interactive mode. Always prompt. Default is to prompt
only as needed.
.TP
.B \-Q
Enable SASL Quiet mode. Never prompt.
.TP
.BI \-U \ username
Specify the username for SASL bind. The syntax of the username depends on the
actual SASL mechanism used.
.TP
.BI \-X \ authzid
Specify the requested authorization ID for SASL bind.
.I authzid
must be one of the following formats:
2000-07-18 05:54:20 +08:00
.BI dn: <distinguished name>
or
2000-07-18 05:54:20 +08:00
.BI u: <username>\fP.
.TP
.BI \-Y \ mech
Specify the SASL mechanism to be used for authentication. If it's not
specified, the program will choose the best mechanism the server knows.
.TP
.B \-Z[Z]
Issue StartTLS (Transport Layer Security) extended operation. If you use
2000-07-18 05:54:20 +08:00
.BR \-ZZ ,
the command will require the operation to be successful
.SH SEE ALSO
.BR ldap_bind (3)
2000-07-14 06:54:45 +08:00
.SH AUTHOR
The OpenLDAP Project <http://www.openldap.org/>
.SH ACKNOWLEDGEMENTS
.B OpenLDAP
is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
.B OpenLDAP
is derived from University of Michigan LDAP 3.3 Release.