| blob | f8136352252543d61c11b555dc85d47092bd4868 |
1 '\" te
2 .\" Portions Copyright (C) 2002, Sun Microsystems, Inc. All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH LDAPMODRDN 1 "Jan 15, 2004"
7 .SH NAME
8 ldapmodrdn \- ldap modify entry RDN tool
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBldapmodrdn\fR [\fB-r\fR] [\fB-n\fR] [\fB-v\fR] [\fB-c\fR] [\fB-E\fR] [\fB-H\fR] [\fB-?\fR] [\fB-M\fR] [\fB-R\fR]
13 [\fB-Z\fR] [\fB-V\fR \fIversion\fR] [\fB-d\fR \fIdebuglevel\fR] [\fB-D\fR \fIbindDN\fR]
14 [\fB-w\fR \fIpasswd\fR] [\fB-h\fR \fIldaphost\fR] [\fB-i\fR \fIlocale\fR] [\fB-j\fR \fIfilename\fR]
15 [\fB-J\fR [:\fIcriticality\fR]] [\fB-k\fR \fIpath\fR] [\fB-N\fR \fIcertificate\fR]
16 [\fB-O\fR \fIhopLimit\fR] [\fB-P\fR \fIpath\fR] [\fB-W\fR \fIpassword\fR] [\fB-p\fR \fIldapport\fR]
17 [\fB-o\fR \fIattributename\fR=\fIvalue\fR] [\fB-f\fR \fIfile\fR] [\fB-Y\fR \fIproxyDN\fR]
18 [\fIdn\fR \fIrdn\fR]
19 .fi
21 .SH DESCRIPTION
22 .sp
23 .LP
24 \fBldapmodrdn\fR opens a connection to an LDAP server, binds, and modifies the
25 RDN of entries. The entry information is read from standard input, from
26 \fBfile\fR through the use of the \fB-f\fR option, or from the command-line
27 pair \fIdn\fR and \fIrdn\fR.
28 .SH OPTIONS
29 .sp
30 .ne 2
31 .na
32 \fB\fB-c\fR\fR
33 .ad
34 .sp .6
35 .RS 4n
36 Continuous operation mode. Errors are reported, but ldapmodify continues with
37 modifications. The default is to exit after reporting an error.
38 .RE
40 .sp
41 .ne 2
42 .na
43 \fB\fB-D\fR\fI bindDN\fR\fR
44 .ad
45 .sp .6
46 .RS 4n
47 Use the distinguished name \fIbinddn\fR to bind to the directory.
48 .RE
50 .sp
51 .ne 2
52 .na
53 \fB\fB-d\fR\fI debuglevel\fR\fR
54 .ad
55 .sp .6
56 .RS 4n
57 Set the LDAP debugging level. Useful values of \fIdebuglevel\fR for
58 \fBldapmodrdn\fR are:
59 .sp
60 .ne 2
61 .na
62 \fB\fB1\fR \fR
63 .ad
64 .RS 8n
65 Trace
66 .RE
68 .sp
69 .ne 2
70 .na
71 \fB\fB2\fR \fR
72 .ad
73 .RS 8n
74 Packets
75 .RE
77 .sp
78 .ne 2
79 .na
80 \fB\fB4\fR \fR
81 .ad
82 .RS 8n
83 Arguments
84 .RE
86 .sp
87 .ne 2
88 .na
89 \fB\fB32\fR \fR
90 .ad
91 .RS 8n
92 Filters
93 .RE
95 .sp
96 .ne 2
97 .na
98 \fB\fB128\fR \fR
99 .ad
100 .RS 8n
101 Access control
102 .RE
104 To request more than one category of debugging information, add the masks. For
105 example, to request trace and filter information, specify a \fIdebuglevel\fR of
106 33.
107 .RE
109 .sp
110 .ne 2
111 .na
112 \fB\fB-E\fR\fR
113 .ad
114 .sp .6
115 .RS 4n
116 Ask server to expose (report) bind identity by means of authentication response
117 control.
118 .RE
120 .sp
121 .ne 2
122 .na
123 \fB\fB-f\fR\fI file\fR\fR
124 .ad
125 .sp .6
126 .RS 4n
127 Read the entry modification information from \fBfile\fR instead of from
128 standard input or the command-line.
129 .RE
131 .sp
132 .ne 2
133 .na
134 \fB\fB-?\fR\fR
135 .ad
136 .sp .6
137 .RS 4n
138 Display the usage help text that briefly describes all options.
139 .RE
141 .sp
142 .ne 2
143 .na
144 \fB\fB-H\fR\fR
145 .ad
146 .sp .6
147 .RS 4n
148 Display the usage help text that briefly describes all options.
149 .RE
151 .sp
152 .ne 2
153 .na
154 \fB\fB-h\fR \fI ldaphost\fR\fR
155 .ad
156 .sp .6
157 .RS 4n
158 Specify an alternate host on which the LDAP server is running.
159 .RE
161 .sp
162 .ne 2
163 .na
164 \fB\fB-i\fR \fIlocale\fR\fR
165 .ad
166 .sp .6
167 .RS 4n
168 Specify the character set to use for the \fB-f\fR \fILDIFfile\fR or standard
169 input. The default is the character set specified in the \fBLANG\fR environment
170 variable. You might choose to use this option to perform the conversion from
171 the specified character set to UTF8, thus overriding the \fBLANG\fR setting.
172 .RE
174 .sp
175 .ne 2
176 .na
177 \fB\fB-J\fR [:\fIcriticality\fR[:\fIvalue\fR|::\fIb64value\fR|\fIb64value\fR|:\
178 fIfileurl\fR]]\fR
179 .ad
180 .sp .6
181 .RS 4n
182 Criticality is a boolean value (default is \fBfalse\fR).
183 .RE
185 .sp
186 .ne 2
187 .na
188 \fB\fB-j\fR \fIfilename\fR\fR
189 .ad
190 .sp .6
191 .RS 4n
192 Specify a file containing the password for the bind DN or the password for the
193 SSL client's key database. To protect the password, use this option in scripts
194 and place the password in a secure file. This option is mutually exclusive of
195 the \fB-w\fR and \fB-W\fR options.
196 .RE
198 .sp
199 .ne 2
200 .na
201 \fB\fB-k\fR \fIpath\fR\fR
202 .ad
203 .sp .6
204 .RS 4n
205 Specify the path to a directory containing conversion routines. These routines
206 are used if you want to specify a locale that is not supported by default by
207 your directory server. This is for NLS support.
208 .RE
210 .sp
211 .ne 2
212 .na
213 \fB\fB-M\fR\fR
214 .ad
215 .sp .6
216 .RS 4n
217 Manage smart referrals. When they are the target of the operation, modify the
218 entry containing the referral instead of the entry obtained by following the
219 referral.
220 .RE
222 .sp
223 .ne 2
224 .na
225 \fB\fB-n\fR \fR
226 .ad
227 .sp .6
228 .RS 4n
229 Previews modifications, but makes no changes to entries. Useful in conjunction
230 with \fB-v\fR and \fB-d\fR for debugging.
231 .RE
233 .sp
234 .ne 2
235 .na
236 \fB\fB-N\fR \fIcertificate\fR\fR
237 .ad
238 .sp .6
239 .RS 4n
240 Specify the certificate name to use for certificate-based client
241 authentication. For example: \fB-N\fR \fB"Directory-Cert"\fR.
242 .RE
244 .sp
245 .ne 2
246 .na
247 \fB\fB-n\fR\fR
248 .ad
249 .sp .6
250 .RS 4n
251 Show what would be done, but do not actually change entries. Useful in
252 conjunction with \fB-v\fR for debugging.
253 .RE
255 .sp
256 .ne 2
257 .na
258 \fB\fB-o\fR \fIattributename\fR=\fIvalue\fR\fR
259 .ad
260 .sp .6
261 .RS 4n
262 For SASL mechanisms and other options such as security properties, mode of
263 operation, authorization ID, authentication ID, and so forth.
264 .sp
265 The different attribute names and their values are as follows:
266 .sp
267 .ne 2
268 .na
269 \fB\fBsecProp\fR=\fI"number"\fR\fR
270 .ad
271 .RS 20n
272 For defining SASL security properties.
273 .RE
275 .sp
276 .ne 2
277 .na
278 \fB\fBrealm\fR=\fI"value"\fR\fR
279 .ad
280 .RS 20n
281 Specifies SASL realm (default is \fBrealm=none\fR).
282 .RE
284 .sp
285 .ne 2
286 .na
287 \fB\fBauthzid\fR=\fI"value"\fR\fR
288 .ad
289 .RS 20n
290 Specify the authorization ID name for SASL bind.
291 .RE
293 .sp
294 .ne 2
295 .na
296 \fB\fBauthid\fR=\fI"value"\fR\fR
297 .ad
298 .RS 20n
299 Specify the authentication ID for SASL bind.
300 .RE
302 .sp
303 .ne 2
304 .na
305 \fB\fBmech\fR=\fI"value"\fR\fR
306 .ad
307 .RS 20n
308 Specifies the various SASL mechanisms.
309 .RE
311 .RE
313 .sp
314 .ne 2
315 .na
316 \fB\fB-O\fR \fIhopLimit\fR\fR
317 .ad
318 .sp .6
319 .RS 4n
320 Specify the maximum number of referral hops to follow while finding an entry to
321 modify. By default, there is no limit.
322 .RE
324 .sp
325 .ne 2
326 .na
327 \fB\fB-P\fR \fIpath\fR\fR
328 .ad
329 .sp .6
330 .RS 4n
331 Specify the path and filename of the client's certificate database. For
332 example:
333 .sp
334 .in +2
335 .nf
336 -P /home/uid/.netscape/cert7.db
337 .fi
338 .in -2
340 When using the command on the same host as the directory server, you can use
341 the server's own certificate database. For example:
342 .sp
343 .in +2
344 .nf
345 -P \fIinstallDir\fR/lapd-serverID/alias/cert7.db
346 .fi
347 .in -2
349 Use the \fB-P\fR option alone to specify server authentication only.
350 .RE
352 .sp
353 .ne 2
354 .na
355 \fB\fB-p\fR\fI ldapport\fR\fR
356 .ad
357 .sp .6
358 .RS 4n
359 Specify an alternate TCP port where the secure LAPD server is listening.
360 .RE
362 .sp
363 .ne 2
364 .na
365 \fB\fB-R\fR\fR
366 .ad
367 .sp .6
368 .RS 4n
369 Do not automatically follow referrals returned while searching.
370 .RE
372 .sp
373 .ne 2
374 .na
375 \fB\fB-r\fR\fR
376 .ad
377 .sp .6
378 .RS 4n
379 Remove old RDN values from the entry. By default, old values are kept.
380 .RE
382 .sp
383 .ne 2
384 .na
385 \fB\fB-V\fR \fIversion\fR\fR
386 .ad
387 .sp .6
388 .RS 4n
389 Specify the LDAP protocol version number to be used for the delete operation,
390 either 2 or 3. LDAP v3 is the default. Specify LDAP v2 when connecting to
391 servers that do not support v3.
392 .RE
394 .sp
395 .ne 2
396 .na
397 \fB\fB-v\fR\fR
398 .ad
399 .sp .6
400 .RS 4n
401 Use verbose mode, with diagnostics written to standard output.
402 .RE
404 .sp
405 .ne 2
406 .na
407 \fB\fB-W\fR \fIpassword\fR\fR
408 .ad
409 .sp .6
410 .RS 4n
411 Specify the password for the client's key database given in the \fB-P\fR
412 option. This option is required for certificate-based client authentication.
413 Specifying \fIpassword\fR on the command line has security issues because the
414 password can be seen by others on the system by means of the \fBps\fR command.
415 Use the \fB-j\fR instead to specify the password from the file. This option is
416 mutually exclusive of \fB-j\fR.
417 .RE
419 .sp
420 .ne 2
421 .na
422 \fB\fB-w\fR\fI passwd\fR\fR
423 .ad
424 .sp .6
425 .RS 4n
426 Use \fIpasswd\fR as the password for authentication to the directory. When you
427 use \fB-w\fR\fI passwd\fR to specify the password to be used for
428 authentication, the password is visible to other users of the system by means
429 of the \fBps\fR command, in script files or in shell history. If you use the
430 \fBldapmodrdn\fR command without this option, the command will prompt for the
431 password and read it from standard in. When used without the \fB-w\fR option,
432 the password will not be visible to other users.
433 .RE
435 .sp
436 .ne 2
437 .na
438 \fB\fB-Y\fR \fIproxyid\fR\fR
439 .ad
440 .sp .6
441 .RS 4n
442 Specify the proxy DN (proxied authorization id) to use for the modify
443 operation, usually in double quotes ("") for the shell.
444 .RE
446 .sp
447 .ne 2
448 .na
449 \fB\fB-Z\fR\fR
450 .ad
451 .sp .6
452 .RS 4n
453 Specify that SSL be used to provide certificate-based client authentication.
454 This option requires the \fB-N\fR and SSL password and any other of the SSL
455 options needed to identify the certificate and the key database.
456 .RE
458 .SS "Input Format"
459 .sp
460 .LP
461 If the command-line arguments \fIdn\fR and \fIrdn\fR are given, \fIrdn\fR
462 replaces the RDN of the entry specified by the DN, \fIdn\fR.
463 .sp
464 .LP
465 Otherwise, the contents of \fBfile\fR (or standard input if the \fB-\fR \fBf\fR
466 option is not specified) must consist of one or more pair of lines:
467 .sp
468 .in +2
469 .nf
470 Distinguished Name (DN)
471 Relative Distinguished Name (RDN)
472 .fi
473 .in -2
474 .sp
476 .sp
477 .LP
478 Use one or more blank lines to separate each DN/RDN pair.
479 .SH EXAMPLES
480 .sp
481 .LP
482 The file \fB/tmp/entrymods\fR contains:
483 .sp
484 .in +2
485 .nf
486 cn=Modify Me, o=XYZ, c=US
487 cn=The New Me
488 .fi
489 .in -2
490 .sp
492 .sp
493 .LP
494 The command:
495 .sp
496 .in +2
497 .nf
498 example% ldapmodify -r -f /tmp/entrymods
499 .fi
500 .in -2
501 .sp
503 .sp
504 .LP
505 changes the RDN of the "Modify Me" entry from "Modify Me" to "The New Me" and
506 the old cn, "Modify Me" is removed.
507 .SH ATTRIBUTES
508 .sp
509 .LP
510 See \fBattributes\fR(5) for a description of the following attributes:
511 .sp
513 .sp
514 .TS
515 box;
516 c | c
517 l | l .
518 ATTRIBUTE TYPE ATTRIBUTE VALUE
519 Stability Level Evolving
520 .TE
522 .SH SEE ALSO
523 .sp
524 .LP
525 \fBldapadd\fR(1), \fBldapdelete\fR(1), \fBldapmodify\fR(1),
526 \fBldapsearch\fR(1), \fBattributes\fR(5)
527 .SH DIAGNOSTICS
528 .sp
529 .LP
530 Exit status is \fB0\fR if no errors occur. Errors result in a non-zero exit
531 status and a diagnostic message being written to standard error.