1 .TH LDAPMODRDN 1 "RELEASEDATE" "OpenLDAP LDVERSION"
3 .\" Copyright 1998-2009 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 .BI \-P \ 2\fR\||\|\fI3\fR]
40 .BR \-O \ security-properties ]
63 is a shell-accessible interface to the
68 opens a connection to an LDAP server, binds, and modifies the RDN of entries.
69 The entry information is read from standard input, from \fIfile\fP through
72 option, or from the command-line pair \fIdn\fP and
77 Remove old RDN values from the entry. Default is to keep old values.
80 Specify a new superior entry. (I.e., move the target entry and make it a
81 child of the new superior.) This option is not supported in LDAPv2.
84 Show what would be done, but don't actually change entries. Useful for
85 debugging in conjunction with -v.
88 Use verbose mode, with many diagnostics written to standard output.
91 Continuous operation mode. Errors are reported, but ldapmodrdn
92 will continue with modifications. The default is to exit after
96 Enable manage DSA IT control.
98 makes control critical.
101 Set the LDAP debugging level to \fIdebuglevel\fP.
104 compiled with LDAP_DEBUG defined for this option to have any effect.
107 Read the entry modification information from \fIfile\fP instead of from
108 standard input or the command-line.
111 Use simple authentication instead of SASL.
114 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
115 For SASL Binds, the server is expected to ignore this value.
118 Prompt for simple authentication.
119 This is used instead of specifying the password on the command line.
122 Use \fIpasswd\fP as the password for simple authentication.
125 Use complete contents of \fIpasswdfile\fP as the password for
126 simple authentication.
129 Specify URI(s) referring to the ldap server(s); only the protocol/host/port
130 fields are allowed; a list of URI, separated by whitespace or commas
134 Specify an alternate host on which the ldap server is running.
135 Deprecated in favor of -H.
138 Specify an alternate TCP port where the ldap server is listening.
139 Deprecated in favor of -H.
141 .BI \-P \ 2\fR\||\|\fI3
142 Specify the LDAP protocol version to use.
144 .BI \-O \ security-properties
145 Specify SASL security properties.
148 Enable SASL Interactive mode. Always prompt. Default is to prompt
152 Enable SASL Quiet mode. Never prompt.
155 Specify the authentication ID for SASL bind. The form of the ID
156 depends on the actual SASL mechanism used.
159 Specify the realm of authentication ID for SASL bind. The form of the realm
160 depends on the actual SASL mechanism used.
163 Specify the requested authorization ID for SASL bind.
165 must be one of the following formats:
167 .I <distinguished name>
173 Specify the SASL mechanism to be used for authentication. If it's not
174 specified, the program will choose the best mechanism the server knows.
177 Issue StartTLS (Transport Layer Security) extended operation. If you use
179 , the command will require the operation to be successful.
181 If the command-line arguments \fIdn\fP and \fIrdn\fP are given, \fIrdn\fP
182 will replace the RDN of the entry specified by the DN, \fIdn\fP.
184 Otherwise, the contents of \fIfile\fP (or standard input if
187 flag is given) should consist of one or more entries.
190 Distinguished Name (DN)
191 Relative Distinguished Name (RDN)
194 One or more blank lines may be used to separate each DN/RDN pair.
196 Assuming that the file
198 exists and has the contents:
201 cn=Modify Me,dc=example,dc=com
208 ldapmodrdn -r -f /tmp/entrymods
211 will change the RDN of the "Modify Me" entry from "Modify Me" to
212 "The New Me" and the old cn, "Modify Me" will be removed.
215 Exit status is 0 if no errors occur. Errors result in a non-zero exit
216 status and a diagnostic message being written to standard error.
226 The OpenLDAP Project <http://www.openldap.org/>