1 .TH LDAPMODRDN 1 "RELEASEDATE" "OpenLDAP LDVERSION"
3 .\" Copyright 1998-2012 The OpenLDAP Foundation All Rights Reserved.
4 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 ldapmodrdn \- LDAP rename entry tool
12 .BI \-d \ debuglevel\fR]
36 .BI \-y \ passwdfile\fR]
40 .BI \-h \ ldaphost\fR]
42 .BI \-p \ ldapport\fR]
44 .BR \-P \ { 2 \||\| 3 }]
46 .BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
48 .BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
50 .BI \-o \ opt \fR[= optparam \fR]]
52 .BI \-O \ security-properties\fR]
73 is a shell-accessible interface to the
78 opens a connection to an LDAP server, binds, and modifies the RDN of entries.
79 The entry information is read from standard input, from \fIfile\fP through
82 option, or from the command-line pair \fIdn\fP and
88 If \fB\-VV\fP is given, only the version information is printed.
91 Set the LDAP debugging level to \fIdebuglevel\fP.
93 must be compiled with LDAP_DEBUG defined for this option to have any effect.
96 Show what would be done, but don't actually change entries. Useful for
97 debugging in conjunction with \fB\-v\fP.
100 Use verbose mode, with many diagnostics written to standard output.
103 Remove old RDN values from the entry. Default is to keep old values.
106 Specify a new superior entry. (I.e., move the target entry and make it a
107 child of the new superior.) This option is not supported in LDAPv2.
110 Continuous operation mode. Errors are reported, but ldapmodrdn
111 will continue with modifications. The default is to exit after
115 Read the entry modification information from \fIfile\fP instead of from
116 standard input or the command-line.
119 Enable manage DSA IT control.
121 makes control critical.
124 Use simple authentication instead of SASL.
127 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
128 For SASL binds, the server is expected to ignore this value.
131 Prompt for simple authentication.
132 This is used instead of specifying the password on the command line.
135 Use \fIpasswd\fP as the password for simple authentication.
138 Use complete contents of \fIpasswdfile\fP as the password for
139 simple authentication.
142 Specify URI(s) referring to the ldap server(s); only the protocol/host/port
143 fields are allowed; a list of URI, separated by whitespace or commas
147 Specify an alternate host on which the ldap server is running.
148 Deprecated in favor of \fB\-H\fP.
151 Specify an alternate TCP port where the ldap server is listening.
152 Deprecated in favor of \fB\-H\fP.
154 .BR \-P \ { 2 \||\| 3 }
155 Specify the LDAP protocol version to use.
157 .BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]
159 .BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]
161 Specify general extensions with \fB\-e\fP and modrdn extensions with \fB\-E\fP.
162 \'\fB!\fP\' indicates criticality.
166 [!]assert=<filter> (an RFC 4515 Filter)
167 !authzid=<authzid> ("dn:<dn>" or "u:<user>")
168 [!]bauthzid (RFC 3829 authzid control)
169 [!]chaining[=<resolve>[/<cont>]]
173 [!]postread[=<attrs>] (a comma-separated attribute list)
174 [!]preread[=<attrs>] (a comma-separated attribute list)
177 abandon,cancel,ignore (SIGINT sends abandon/cancel,
178 or ignores response; if critical, doesn't wait for SIGINT.
187 .BI \-o \ opt \fR[= optparam \fR]
189 Specify general options.
193 nettimeout=<timeout> (in seconds, or "none" or "max")
194 ldif-wrap=<width> (in columns, or "no" for no wrapping)
197 .BI \-O \ security-properties
198 Specify SASL security properties.
201 Enable SASL Interactive mode. Always prompt. Default is to prompt
205 Enable SASL Quiet mode. Never prompt.
208 Do not use reverse DNS to canonicalize SASL host name.
211 Specify the authentication ID for SASL bind. The form of the ID
212 depends on the actual SASL mechanism used.
215 Specify the realm of authentication ID for SASL bind. The form of the realm
216 depends on the actual SASL mechanism used.
219 Specify the requested authorization ID for SASL bind.
221 must be one of the following formats:
222 .BI dn: "<distinguished name>"
227 Specify the SASL mechanism to be used for authentication. If it's not
228 specified, the program will choose the best mechanism the server knows.
231 Issue StartTLS (Transport Layer Security) extended operation. If you use
232 \fB\-ZZ\fP, the command will require the operation to be successful.
234 If the command-line arguments \fIdn\fP and \fIrdn\fP are given, \fIrdn\fP
235 will replace the RDN of the entry specified by the DN, \fIdn\fP.
237 Otherwise, the contents of \fIfile\fP (or standard input if
238 no \fB\-f\fP flag is given) should consist of one or more entries.
241 Distinguished Name (DN)
242 Relative Distinguished Name (RDN)
245 One or more blank lines may be used to separate each DN/RDN pair.
247 Assuming that the file
249 exists and has the contents:
252 cn=Modify Me,dc=example,dc=com
259 ldapmodrdn \-r \-f /tmp/entrymods
262 will change the RDN of the "Modify Me" entry from "Modify Me" to
263 "The New Me" and the old cn, "Modify Me" will be removed.
266 Exit status is 0 if no errors occur. Errors result in a non-zero exit
267 status and a diagnostic message being written to standard error.
277 The OpenLDAP Project <http://www.openldap.org/>