1 .TH LDAPMODRDN 1 "RELEASEDATE" "OpenLDAP LDVERSION"
3 .\" Copyright 1998-2005 The OpenLDAP Foundation All Rights Reserved.
4 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 ldapmodrdn \- LDAP rename entry tool
20 .BI \-d \ debuglevel\fR]
28 .BI \-y \ passwdfile\fR]
32 .BI \-h \ ldaphost\fR]
34 .BI \-p \ ldapport\fR]
36 .BI \-P \ 2\fR\||\|\fI3\fR]
38 .BR \-O \ security-properties ]
61 is a shell-accessible interface to the
66 opens a connection to an LDAP server, binds, and modifies the RDN of entries.
67 The entry information is read from standard input, from \fIfile\fP through
70 option, or from the command-line pair \fIdn\fP and
75 Remove old RDN values from the entry. Default is to keep old values.
78 Show what would be done, but don't actually change entries. Useful for
79 debugging in conjunction with -v.
82 Use verbose mode, with many diagnostics written to standard output.
85 Continuous operation mode. Errors are reported, but ldapmodrdn
86 will continue with modifications. The default is to exit after
90 Enable manage DSA IT control.
92 makes control critical.
95 Set the LDAP debugging level to \fIdebuglevel\fP.
98 compiled with LDAP_DEBUG defined for this option to have any effect.
101 Read the entry modification information from \fIfile\fP instead of from
102 standard input or the command-line.
105 Use simple authentication instead of SASL.
108 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
111 Prompt for simple authentication.
112 This is used instead of specifying the password on the command line.
115 Use \fIpasswd\fP as the password for simple authentication.
118 Use complete contents of \fIpasswdfile\fP as the password for
119 simple authentication.
122 Specify URI(s) referring to the ldap server(s); only the protocol/host/port
123 fields are allowed; a list of URI, separated by whitespace or commas
127 Specify an alternate host on which the ldap server is running.
128 Deprecated in favor of -H.
131 Specify an alternate TCP port where the ldap server is listening.
132 Deprecated in favor of -H.
134 .BI \-P \ 2\fR\||\|\fI3
135 Specify the LDAP protocol version to use.
137 .BI \-O \ security-properties
138 Specify SASL security properties.
141 Enable SASL Interactive mode. Always prompt. Default is to prompt
145 Enable SASL Quiet mode. Never prompt.
148 Specify the authentication ID for SASL bind. The form of the ID
149 depends on the actual SASL mechanism used.
152 Specify the realm of authentication ID for SASL bind. The form of the realm
153 depends on the actual SASL mechanism used.
156 Specify the requested authorization ID for SASL bind.
158 must be one of the following formats:
160 .I <distinguished name>
166 Specify the SASL mechanism to be used for authentication. If it's not
167 specified, the program will choose the best mechanism the server knows.
170 Issue StartTLS (Transport Layer Security) extended operation. If you use
172 , the command will require the operation to be successful.
174 If the command-line arguments \fIdn\fP and \fIrdn\fP are given, \fIrdn\fP
175 will replace the RDN of the entry specified by the DN, \fIdn\fP.
177 Otherwise, the contents of \fIfile\fP (or standard input if
180 flag is given) should consist of one or more entries.
183 Distinguished Name (DN)
184 Relative Distinguished Name (RDN)
187 One or more blank lines may be used to separate each DN/RDN pair.
189 Assuming that the file
191 exists and has the contents:
194 cn=Modify Me,dc=example,dc=com
201 ldapmodrdn -r -f /tmp/entrymods
204 will change the RDN of the "Modify Me" entry from "Modify Me" to
205 "The New Me" and the old cn, "Modify Me" will be removed.
208 Exit status is 0 if no errors occur. Errors result in a non-zero exit
209 status and a diagnostic message being written to standard error.
219 The OpenLDAP Project <http://www.openldap.org/>
222 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
224 is derived from University of Michigan LDAP 3.3 Release.