'\" t
|
.\" Title: ldappasswordmodify
|
.\" Author:
|
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
|
.\" Date: 03/21/2012
|
.\" Manual: Tools Reference
|
.\" Source: OpenDJ 2.5.0
|
.\" Language: English
|
.\"
|
.TH "LDAPPASSWORDMODIFY" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
|
.\" -----------------------------------------------------------------
|
.\" * Define some portability stuff
|
.\" -----------------------------------------------------------------
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
.\" http://bugs.debian.org/507673
|
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
.ie \n(.g .ds Aq \(aq
|
.el .ds Aq '
|
.\" -----------------------------------------------------------------
|
.\" * set default formatting
|
.\" -----------------------------------------------------------------
|
.\" disable hyphenation
|
.nh
|
.\" disable justification (adjust text to left margin only)
|
.ad l
|
.\" -----------------------------------------------------------------
|
.\" * MAIN CONTENT STARTS HERE *
|
.\" -----------------------------------------------------------------
|
.SH "NAME"
|
ldappasswordmodify \- perform LDAP password modifications
|
.SH "SYNOPSIS"
|
.HP \w'\fBldappasswordmodify\fR\ 'u
|
\fBldappasswordmodify\fR {options}
|
.SH "DESCRIPTION"
|
.PP
|
This utility can be used to perform LDAP password modify operations in the directory\&.
|
.SH "OPTIONS"
|
.PP
|
The following options are supported\&.
|
.PP
|
\fB\-a, \-\-authzID {authzID}\fR
|
.RS 4
|
Authorization ID for the user entry whose password should be changed
|
.sp
|
The authorization ID is a string having either the prefix
|
dn:
|
followed by the user\*(Aqs distinguished name, or the prefix
|
u:
|
followed by a user identifier that depends on the identity mapping used to match the user identifier to an entry in the directory\&. Examples include
|
dn:uid=bjensen,ou=People,dc=example,dc=com, and, if we assume that
|
bjensen
|
is mapped to Barbara Jensen\*(Aqs entry,
|
u:bjensen\&.
|
.RE
|
.PP
|
\fB\-A, \-\-provideDNForAuthzID\fR
|
.RS 4
|
Use the bind DN as the authorization ID for the password modify operation
|
.RE
|
.PP
|
\fB\-c, \-\-currentPassword {currentPassword}\fR
|
.RS 4
|
Current password for the target user
|
.RE
|
.PP
|
\fB\-C, \-\-currentPasswordFile {file}\fR
|
.RS 4
|
Path to a file containing the current password for the target user
|
.RE
|
.PP
|
\fB\-J, \-\-control {controloid[:criticality[:value|::b64value|:<filePath]]}\fR
|
.RS 4
|
Use a request control with the provided information
|
.RE
|
.PP
|
\fB\-n, \-\-newPassword {newPassword}\fR
|
.RS 4
|
New password to provide for the target user
|
.RE
|
.PP
|
\fB\-N, \-\-newPasswordFile {file}\fR
|
.RS 4
|
Path to a file containing the new password to provide for the target user
|
.RE
|
.SS "LDAP Connection Options"
|
.PP
|
\fB\-\-certNickname {nickname}\fR
|
.RS 4
|
Nickname of certificate for SSL client authentication
|
.RE
|
.PP
|
\fB\-\-connectTimeout {timeout}\fR
|
.RS 4
|
Maximum length of time (in milliseconds) that can be taken to establish a connection\&. Use \*(Aq0\*(Aq to specify no time out\&.
|
.sp
|
Default: 30000
|
.RE
|
.PP
|
\fB\-D, \-\-bindDN {bindDN}\fR
|
.RS 4
|
DN to use to bind to the server
|
.sp
|
Default value: cn=Directory Manager
|
.RE
|
.PP
|
\fB\-h, \-\-hostname {host}\fR
|
.RS 4
|
Directory server hostname or IP address
|
.sp
|
Default value: localhost\&.localdomain
|
.RE
|
.PP
|
\fB\-j, \-\-bindPasswordFile {bindPasswordFile}\fR
|
.RS 4
|
Bind password file
|
.RE
|
.PP
|
\fB\-K, \-\-keyStorePath {keyStorePath}\fR
|
.RS 4
|
Certificate key store path
|
.RE
|
.PP
|
\fB\-p, \-\-port {port}\fR
|
.RS 4
|
Directory server port number
|
.sp
|
Default value: 389
|
.RE
|
.PP
|
\fB\-P, \-\-trustStorePath {trustStorePath}\fR
|
.RS 4
|
Certificate trust store path
|
.RE
|
.PP
|
\fB\-q, \-\-useStartTLS\fR
|
.RS 4
|
Use StartTLS to secure communication with the server
|
.RE
|
.PP
|
\fB\-\-trustStorePassword {trustStorePassword}\fR
|
.RS 4
|
Certificate trust store PIN
|
.RE
|
.PP
|
\fB\-u, \-\-keyStorePasswordFile {keyStorePasswordFile}\fR
|
.RS 4
|
Certificate key store PIN file
|
.RE
|
.PP
|
\fB\-U, \-\-trustStorePasswordFile {path}\fR
|
.RS 4
|
Certificate trust store PIN file
|
.RE
|
.PP
|
\fB\-w, \-\-bindPassword {bindPassword}\fR
|
.RS 4
|
Password to use to bind to the server
|
.RE
|
.PP
|
\fB\-W, \-\-keyStorePassword {keyStorePassword}\fR
|
.RS 4
|
Certificate key store PIN
|
.RE
|
.PP
|
\fB\-X, \-\-trustAll\fR
|
.RS 4
|
Trust all server SSL certificates
|
.RE
|
.PP
|
\fB\-Z, \-\-useSSL\fR
|
.RS 4
|
Use SSL for secure communication with the server
|
.RE
|
.SS "Utility Input/Output Options"
|
.PP
|
\fB\-\-noPropertiesFile\fR
|
.RS 4
|
No properties file will be used to get default command line argument values
|
.RE
|
.PP
|
\fB\-\-propertiesFilePath {propertiesFilePath}\fR
|
.RS 4
|
Path to the file containing default property values used for command line arguments
|
.RE
|
.PP
|
\fB\-?, \-H, \-\-help\fR
|
.RS 4
|
Display usage information
|
.RE
|
.PP
|
\fB\-V, \-\-version\fR
|
.RS 4
|
Display directory server version information
|
.RE
|
.SS "General Options"
|
.PP
|
\fB\-\-version\fR
|
.RS 4
|
Display version information
|
.RE
|
.PP
|
\fB\-?, \-H, \-\-help\fR
|
.RS 4
|
Display usage information
|
.RE
|
.SH "EXIT CODES"
|
.PP
|
0
|
.RS 4
|
The command completed successfully\&.
|
.RE
|
.PP
|
\fIldap\-error\fR
|
.RS 4
|
An LDAP error occurred while processing the operation\&.
|
.sp
|
LDAP result codes are described in
|
\m[blue]\fBRFC 4511\fR\m[]\&. Also see the additional information for details\&.
|
.RE
|
.PP
|
89
|
.RS 4
|
An error occurred while parsing the command\-line arguments\&.
|
.RE
|
.SH "FILES"
|
.PP
|
You can use
|
~/\&.opendj/tools\&.properties
|
to set the defaults for bind DN, host name, and port number as in the following example\&.
|
.sp
|
.if n \{\
|
.RS 4
|
.\}
|
.nf
|
hostname=directory\&.example\&.com
|
port=1389
|
bindDN=uid=kvaughan,ou=People,dc=example,dc=com
|
|
ldapcompare\&.port=1389
|
ldapdelete\&.port=1389
|
ldapmodify\&.port=1389
|
ldappasswordmodify\&.port=1389
|
ldapsearch\&.port=1389
|
.fi
|
.if n \{\
|
.RE
|
.\}
|
.SH "EXAMPLES"
|
.PP
|
The following example demonstrates a user changing the password for her entry\&.
|
.sp
|
.if n \{\
|
.RS 4
|
.\}
|
.nf
|
$ cat /tmp/currpwd\&.txt /tmp/newpwd\&.txt
|
bribery
|
secret12
|
$ ldappasswordmodify \-p 1389 \-C /tmp/currpwd\&.txt \-N /tmp/newpwd\&.txt
|
\-A \-D uid=kvaughan,ou=people,dc=example,dc=com \-w bribery
|
The LDAP password modify operation was successful
|
.fi
|
.if n \{\
|
.RE
|
.\}
|
.SH "COPYRIGHT"
|
.br
|
Copyright \(co 2011-2012 ForgeRock AS
|
.br
|
