1 .TH LDAPMODRDN 1 "RELEASEDATE" "OpenLDAP LDVERSION"
3 .\" Copyright 1998-2011 The OpenLDAP Foundation All Rights Reserved.
4 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 ldapmodrdn \- LDAP rename entry tool
22 .BI \-d \ debuglevel\fR]
30 .BI \-y \ passwdfile\fR]
34 .BI \-h \ ldaphost\fR]
36 .BI \-p \ ldapport\fR]
38 .BR \-P \ { 2 \||\| 3 }]
40 .BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
42 .BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
44 .BI \-O \ security-properties\fR]
67 is a shell-accessible interface to the
72 opens a connection to an LDAP server, binds, and modifies the RDN of entries.
73 The entry information is read from standard input, from \fIfile\fP through
76 option, or from the command-line pair \fIdn\fP and
81 Remove old RDN values from the entry. Default is to keep old values.
84 Specify a new superior entry. (I.e., move the target entry and make it a
85 child of the new superior.) This option is not supported in LDAPv2.
88 Show what would be done, but don't actually change entries. Useful for
89 debugging in conjunction with \fB\-v\fP.
92 Use verbose mode, with many diagnostics written to standard output.
95 Continuous operation mode. Errors are reported, but ldapmodrdn
96 will continue with modifications. The default is to exit after
100 Enable manage DSA IT control.
102 makes control critical.
105 Set the LDAP debugging level to \fIdebuglevel\fP.
108 compiled with LDAP_DEBUG defined for this option to have any effect.
111 Read the entry modification information from \fIfile\fP instead of from
112 standard input or the command-line.
115 Use simple authentication instead of SASL.
118 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
119 For SASL binds, the server is expected to ignore this value.
122 Prompt for simple authentication.
123 This is used instead of specifying the password on the command line.
126 Use \fIpasswd\fP as the password for simple authentication.
129 Use complete contents of \fIpasswdfile\fP as the password for
130 simple authentication.
133 Specify URI(s) referring to the ldap server(s); only the protocol/host/port
134 fields are allowed; a list of URI, separated by whitespace or commas
138 Specify an alternate host on which the ldap server is running.
139 Deprecated in favor of \fB\-H\fP.
142 Specify an alternate TCP port where the ldap server is listening.
143 Deprecated in favor of \fB\-H\fP.
145 .BR \-P \ { 2 \||\| 3 }
146 Specify the LDAP protocol version to use.
148 .BI \-O \ security-properties
149 Specify SASL security properties.
151 .BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]
153 .BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]
155 Specify general extensions with \fB\-e\fP and modrdn extensions with \fB\-E\fP.
156 \'\fB!\fP\' indicates criticality.
160 [!]assert=<filter> (an RFC 4515 Filter)
161 !authzid=<authzid> ("dn:<dn>" or "u:<user>")
162 [!]bauthzid (RFC 3829 authzid control)
163 [!]chaining[=<resolve>[/<cont>]]
167 [!]postread[=<attrs>] (a comma-separated attribute list)
168 [!]preread[=<attrs>] (a comma-separated attribute list)
170 sessiontracking[=<username>]
171 abandon,cancel,ignore (SIGINT sends abandon/cancel,
172 or ignores response; if critical, doesn't wait for SIGINT.
182 Enable SASL Interactive mode. Always prompt. Default is to prompt
186 Enable SASL Quiet mode. Never prompt.
189 Specify the authentication ID for SASL bind. The form of the ID
190 depends on the actual SASL mechanism used.
193 Specify the realm of authentication ID for SASL bind. The form of the realm
194 depends on the actual SASL mechanism used.
197 Specify the requested authorization ID for SASL bind.
199 must be one of the following formats:
200 .BI dn: "<distinguished name>"
205 Specify the SASL mechanism to be used for authentication. If it's not
206 specified, the program will choose the best mechanism the server knows.
209 Issue StartTLS (Transport Layer Security) extended operation. If you use
210 \fB\-ZZ\fP, the command will require the operation to be successful.
212 If the command-line arguments \fIdn\fP and \fIrdn\fP are given, \fIrdn\fP
213 will replace the RDN of the entry specified by the DN, \fIdn\fP.
215 Otherwise, the contents of \fIfile\fP (or standard input if
216 no \fB\-f\fP flag is given) should consist of one or more entries.
219 Distinguished Name (DN)
220 Relative Distinguished Name (RDN)
223 One or more blank lines may be used to separate each DN/RDN pair.
225 Assuming that the file
227 exists and has the contents:
230 cn=Modify Me,dc=example,dc=com
237 ldapmodrdn \-r \-f /tmp/entrymods
240 will change the RDN of the "Modify Me" entry from "Modify Me" to
241 "The New Me" and the old cn, "Modify Me" will be removed.
244 Exit status is 0 if no errors occur. Errors result in a non-zero exit
245 status and a diagnostic message being written to standard error.
255 The OpenLDAP Project <http://www.openldap.org/>