| blob | 5feb1bbc519dd07e05de64ed656bc7abfffd9be0 |
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|:\fIfileurl\fR]]\fR
178 .ad
179 .sp .6
180 .RS 4n
181 Criticality is a boolean value (default is \fBfalse\fR).
182 .RE
184 .sp
185 .ne 2
186 .na
187 \fB\fB-j\fR \fIfilename\fR\fR
188 .ad
189 .sp .6
190 .RS 4n
191 Specify a file containing the password for the bind DN or the password for the
192 SSL client's key database. To protect the password, use this option in scripts
193 and place the password in a secure file. This option is mutually exclusive of
194 the \fB-w\fR and \fB-W\fR options.
195 .RE
197 .sp
198 .ne 2
199 .na
200 \fB\fB-k\fR \fIpath\fR\fR
201 .ad
202 .sp .6
203 .RS 4n
204 Specify the path to a directory containing conversion routines. These routines
205 are used if you want to specify a locale that is not supported by default by
206 your directory server. This is for NLS support.
207 .RE
209 .sp
210 .ne 2
211 .na
212 \fB\fB-M\fR\fR
213 .ad
214 .sp .6
215 .RS 4n
216 Manage smart referrals. When they are the target of the operation, modify the
217 entry containing the referral instead of the entry obtained by following the
218 referral.
219 .RE
221 .sp
222 .ne 2
223 .na
224 \fB\fB-n\fR \fR
225 .ad
226 .sp .6
227 .RS 4n
228 Previews modifications, but makes no changes to entries. Useful in conjunction
229 with \fB-v\fR and \fB-d\fR for debugging.
230 .RE
232 .sp
233 .ne 2
234 .na
235 \fB\fB-N\fR \fIcertificate\fR\fR
236 .ad
237 .sp .6
238 .RS 4n
239 Specify the certificate name to use for certificate-based client
240 authentication. For example: \fB-N\fR \fB"Directory-Cert"\fR.
241 .RE
243 .sp
244 .ne 2
245 .na
246 \fB\fB-n\fR\fR
247 .ad
248 .sp .6
249 .RS 4n
250 Show what would be done, but do not actually change entries. Useful in
251 conjunction with \fB-v\fR for debugging.
252 .RE
254 .sp
255 .ne 2
256 .na
257 \fB\fB-o\fR \fIattributename\fR=\fIvalue\fR\fR
258 .ad
259 .sp .6
260 .RS 4n
261 For SASL mechanisms and other options such as security properties, mode of
262 operation, authorization ID, authentication ID, and so forth.
263 .sp
264 The different attribute names and their values are as follows:
265 .sp
266 .ne 2
267 .na
268 \fB\fBsecProp\fR=\fI"number"\fR\fR
269 .ad
270 .RS 20n
271 For defining SASL security properties.
272 .RE
274 .sp
275 .ne 2
276 .na
277 \fB\fBrealm\fR=\fI"value"\fR\fR
278 .ad
279 .RS 20n
280 Specifies SASL realm (default is \fBrealm=none\fR).
281 .RE
283 .sp
284 .ne 2
285 .na
286 \fB\fBauthzid\fR=\fI"value"\fR\fR
287 .ad
288 .RS 20n
289 Specify the authorization ID name for SASL bind.
290 .RE
292 .sp
293 .ne 2
294 .na
295 \fB\fBauthid\fR=\fI"value"\fR\fR
296 .ad
297 .RS 20n
298 Specify the authentication ID for SASL bind.
299 .RE
301 .sp
302 .ne 2
303 .na
304 \fB\fBmech\fR=\fI"value"\fR\fR
305 .ad
306 .RS 20n
307 Specifies the various SASL mechanisms.
308 .RE
310 .RE
312 .sp
313 .ne 2
314 .na
315 \fB\fB-O\fR \fIhopLimit\fR\fR
316 .ad
317 .sp .6
318 .RS 4n
319 Specify the maximum number of referral hops to follow while finding an entry to
320 modify. By default, there is no limit.
321 .RE
323 .sp
324 .ne 2
325 .na
326 \fB\fB-P\fR \fIpath\fR\fR
327 .ad
328 .sp .6
329 .RS 4n
330 Specify the path and filename of the client's certificate database. For
331 example:
332 .sp
333 .in +2
334 .nf
335 -P /home/uid/.netscape/cert7.db
336 .fi
337 .in -2
339 When using the command on the same host as the directory server, you can use
340 the server's own certificate database. For example:
341 .sp
342 .in +2
343 .nf
344 -P \fIinstallDir\fR/lapd-serverID/alias/cert7.db
345 .fi
346 .in -2
348 Use the \fB-P\fR option alone to specify server authentication only.
349 .RE
351 .sp
352 .ne 2
353 .na
354 \fB\fB-p\fR\fI ldapport\fR\fR
355 .ad
356 .sp .6
357 .RS 4n
358 Specify an alternate TCP port where the secure LAPD server is listening.
359 .RE
361 .sp
362 .ne 2
363 .na
364 \fB\fB-R\fR\fR
365 .ad
366 .sp .6
367 .RS 4n
368 Do not automatically follow referrals returned while searching.
369 .RE
371 .sp
372 .ne 2
373 .na
374 \fB\fB-r\fR\fR
375 .ad
376 .sp .6
377 .RS 4n
378 Remove old RDN values from the entry. By default, old values are kept.
379 .RE
381 .sp
382 .ne 2
383 .na
384 \fB\fB-V\fR \fIversion\fR\fR
385 .ad
386 .sp .6
387 .RS 4n
388 Specify the LDAP protocol version number to be used for the delete operation,
389 either 2 or 3. LDAP v3 is the default. Specify LDAP v2 when connecting to
390 servers that do not support v3.
391 .RE
393 .sp
394 .ne 2
395 .na
396 \fB\fB-v\fR\fR
397 .ad
398 .sp .6
399 .RS 4n
400 Use verbose mode, with diagnostics written to standard output.
401 .RE
403 .sp
404 .ne 2
405 .na
406 \fB\fB-W\fR \fIpassword\fR\fR
407 .ad
408 .sp .6
409 .RS 4n
410 Specify the password for the client's key database given in the \fB-P\fR
411 option. This option is required for certificate-based client authentication.
412 Specifying \fIpassword\fR on the command line has security issues because the
413 password can be seen by others on the system by means of the \fBps\fR command.
414 Use the \fB-j\fR instead to specify the password from the file. This option is
415 mutually exclusive of \fB-j\fR.
416 .RE
418 .sp
419 .ne 2
420 .na
421 \fB\fB-w\fR\fI passwd\fR\fR
422 .ad
423 .sp .6
424 .RS 4n
425 Use \fIpasswd\fR as the password for authentication to the directory. When you
426 use \fB-w\fR\fI passwd\fR to specify the password to be used for
427 authentication, the password is visible to other users of the system by means
428 of the \fBps\fR command, in script files or in shell history. If you use the
429 \fBldapmodrdn\fR command without this option, the command will prompt for the
430 password and read it from standard in. When used without the \fB-w\fR option,
431 the password will not be visible to other users.
432 .RE
434 .sp
435 .ne 2
436 .na
437 \fB\fB-Y\fR \fIproxyid\fR\fR
438 .ad
439 .sp .6
440 .RS 4n
441 Specify the proxy DN (proxied authorization id) to use for the modify
442 operation, usually in double quotes ("") for the shell.
443 .RE
445 .sp
446 .ne 2
447 .na
448 \fB\fB-Z\fR\fR
449 .ad
450 .sp .6
451 .RS 4n
452 Specify that SSL be used to provide certificate-based client authentication.
453 This option requires the \fB-N\fR and SSL password and any other of the SSL
454 options needed to identify the certificate and the key database.
455 .RE
457 .SS "Input Format"
458 .sp
459 .LP
460 If the command-line arguments \fIdn\fR and \fIrdn\fR are given, \fIrdn\fR
461 replaces the RDN of the entry specified by the DN, \fIdn\fR.
462 .sp
463 .LP
464 Otherwise, the contents of \fBfile\fR (or standard input if the \fB-\fR \fBf\fR
465 option is not specified) must consist of one or more pair of lines:
466 .sp
467 .in +2
468 .nf
469 Distinguished Name (DN)
470 Relative Distinguished Name (RDN)
471 .fi
472 .in -2
473 .sp
475 .sp
476 .LP
477 Use one or more blank lines to separate each DN/RDN pair.
478 .SH EXAMPLES
479 .sp
480 .LP
481 The file \fB/tmp/entrymods\fR contains:
482 .sp
483 .in +2
484 .nf
485 cn=Modify Me, o=XYZ, c=US
486 cn=The New Me
487 .fi
488 .in -2
489 .sp
491 .sp
492 .LP
493 The command:
494 .sp
495 .in +2
496 .nf
497 example% ldapmodify -r -f /tmp/entrymods
498 .fi
499 .in -2
500 .sp
502 .sp
503 .LP
504 changes the RDN of the "Modify Me" entry from "Modify Me" to "The New Me" and
505 the old cn, "Modify Me" is removed.
506 .SH ATTRIBUTES
507 .sp
508 .LP
509 See \fBattributes\fR(5) for a description of the following attributes:
510 .sp
512 .sp
513 .TS
514 box;
515 c | c
516 l | l .
517 ATTRIBUTE TYPE ATTRIBUTE VALUE
518 Stability Level Evolving
519 .TE
521 .SH SEE ALSO
522 .sp
523 .LP
524 \fBldapadd\fR(1), \fBldapdelete\fR(1), \fBldapmodify\fR(1),
525 \fBldapsearch\fR(1), \fBattributes\fR(5)
526 .SH DIAGNOSTICS
527 .sp
528 .LP
529 Exit status is \fB0\fR if no errors occur. Errors result in a non-zero exit
530 status and a diagnostic message being written to standard error.