| blob | 15e38d9d1f16596909beb76e7089eb19e849b3b9 |
1 '\" te
2 .\" Copyright (C) 1990, Regents of the University of Michigan. All Rights Reserved.
3 .\" Portions Copyright (C) 2004, Sun Microsystems, Inc. All Rights Reserved.
4 .\" 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.
5 .\" 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.
6 .\" 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]
7 .TH LDAPMODIFY 1 "Jan 15, 2004"
8 .SH NAME
9 ldapmodify, ldapadd \- ldap entry addition and modification tools
10 .SH SYNOPSIS
11 .LP
12 .nf
13 \fBldapmodify\fR [\fB-a\fR] [\fB-c\fR] [\fB-r\fR] [\fB-n\fR] [\fB-v\fR] [\fB-F\fR] [\fB-b\fR] [\fB-A\fR] [\fB-q\fR]
14 [\fB-H\fR] [\fB-?\fR] [\fB-E\fR] [\fB-J\fR] [\fB-Z\fR] [\fB-M\fR] [\fB-d\fR \fIdebuglevel\fR]
15 [\fB-D\fR \fIbindDN\fR] [\fB-j\fR \fIfilename\fR] [\fB-J\fR [:\fIcriticality\fR]]
16 [\fB-B\fR \fIbaseDN\fR] [\fB-V\fR \fIversion\fR] [\fB-Y\fR \fIproxyDN\fR] [\fB-O\fR \fIhopLimit\fR]
17 [\fB-i\fR \fIlocale\fR] [\fB-k\fR \fIpath\fR] [\fB-e\fR \fIerrorFile\fR] [\fB-P\fR \fIpath\fR]
18 [\fB-N\fR \fIcertificate\fR] [\fB-w\fR \fIpasswd\fR] [\fB-o\fR \fIattributename\fR=\fIvalue\fR]
19 [\fB-h\fR \fIldaphost\fR] [\fB-W\fR \fIpassword\fR] [\fB-p\fR \fIldapport\fR] [\fB-f\fR \fIfile\fR]
20 [\fB-l\fR \fInb-ldap-connections\fR]
21 .fi
23 .LP
24 .nf
25 \fBldapadd\fR [\fB-c\fR] [\fB-n\fR] [\fB-v\fR] [\fB-F\fR]
26 [ [\fB-b\fR] [\fB-A\fR] [\fB-q\fR] [\fB-H\fR] [\fB-?\fR] [\fB-E\fR] [\fB-J\fR] [\fB-Z\fR] [\fB-M\fR]\fB-d\fR \fIdebuglevel\fR]
27 [\fB-D\fR \fIbindDN\fR] [\fB-j\fR \fIfilename\fR] [\fB-B\fR \fIbaseDN\fR] [\fB-V\fR \fIversion\fR]
28 [\fB-Y\fR \fIproxyDN\fR] [\fB-O\fR \fIhopLimit\fR] [\fB-i\fR \fIlocale\fR] [\fB-k\fR \fIpath\fR]
29 [\fB-e\fR \fIerrorFile\fR] [\fB-P\fR \fIpath\fR] [\fB-N\fR \fIcertificate\fR] [\fB-w\fR \fIpasswd\fR]
30 [\fB-o\fR \fIattributename\fR=\fIvalue\fR] [\fB-h\fR \fIldaphost\fR] [\fB-W\fR \fIpassword\fR]
31 [\fB-p\fR \fIldapport\fR] [\fB-f\fR \fIfile\fR] [\fB-l\fR \fInb-ldap-connections\fR]
32 .fi
34 .SH DESCRIPTION
35 .sp
36 .LP
37 The \fBldapmodify\fR utility opens a connection to an \fBLDAP\fR server, binds
38 and modifies or adds entries. The entry information is read from standard input
39 or from \fIfile\fR, specified using the \fB-f\fR option. The \fBldapadd\fR
40 utility is implemented as a hard link to the \fBldapmodify\fR tool. When
41 invoked as \fBldapadd\fR, the \fB-a\fR (add new entry) option is turned on
42 automatically.
43 .sp
44 .LP
45 Both \fBldapadd\fR and \fBldapmodify\fR reject duplicate attribute-name/value
46 pairs for the same entry.
47 .SH OPTIONS
48 .sp
49 .LP
50 The following options are supported:
51 .sp
52 .ne 2
53 .na
54 \fB\fB-a\fR\fR
55 .ad
56 .sp .6
57 .RS 4n
58 Adds new entries. The default for \fBldapmodify\fR is to modify existing
59 entries. If invoked as \fBldapadd\fR, this option is always set.
60 .RE
62 .sp
63 .ne 2
64 .na
65 \fB\fB-A\fR\fR
66 .ad
67 .sp .6
68 .RS 4n
69 Non-ASCII mode: display non-ASCII values, in conjunction with the \fB-v\fR
70 option.
71 .RE
73 .sp
74 .ne 2
75 .na
76 \fB\fB-b\fR\fR
77 .ad
78 .sp .6
79 .RS 4n
80 Handle binary files. The \fBldapmodify\fR tool will scan every attribute value
81 in the input to determine whether it is a valid file reference. If the
82 reference is valid, it will use the contents of the file as the attribute's
83 value. This option is used to input binary data, such as a JPEG image, for an
84 attribute. For example, the corresponding LDIF input would be: "\fB jpegPhoto:
85 /tmp/photo.jpg\fR" The \fBldapmodify\fR tool also supports the LDIF \fB:<
86 \fIURL\fR\fR notation for directly including file contents.
87 .RE
89 .sp
90 .ne 2
91 .na
92 \fB\fB-B\fR\ \fIbaseDN\fR\fR
93 .ad
94 .sp .6
95 .RS 4n
96 Specify the base DN when performing additions, usually in double quotes
97 (\fB""\fR) for the shell. All entries will be placed under this suffix, thus
98 providing bulk import functionality.
99 .RE
101 .sp
102 .ne 2
103 .na
104 \fB\fB-c\fR\fR
105 .ad
106 .sp .6
107 .RS 4n
108 Specifies continuous operation mode. Errors are reported, but \fBldapmodify\fR
109 and \fBldapadd\fR continue with modifications. The default is to exit after
110 reporting an error.
111 .RE
113 .sp
114 .ne 2
115 .na
116 \fB\fB-D\fR \fIbindDN\fR \fR
117 .ad
118 .sp .6
119 .RS 4n
120 Uses the distinguished name \fIbindDN\fR to bind to the directory.
121 .RE
123 .sp
124 .ne 2
125 .na
126 \fB\fB-d\fR \fIdebuglevel\fR\fR
127 .ad
128 .sp .6
129 .RS 4n
130 Sets the \fBLDAP\fR debugging level. Useful levels of debugging for
131 \fBldapmodify\fR and \fBldapadd\fR are:
132 .sp
133 .ne 2
134 .na
135 \fB\fB1\fR\fR
136 .ad
137 .RS 7n
138 Trace
139 .RE
141 .sp
142 .ne 2
143 .na
144 \fB\fB2\fR\fR
145 .ad
146 .RS 7n
147 Packets
148 .RE
150 .sp
151 .ne 2
152 .na
153 \fB\fB4\fR\fR
154 .ad
155 .RS 7n
156 Arguments
157 .RE
159 .sp
160 .ne 2
161 .na
162 \fB\fB32\fR\fR
163 .ad
164 .RS 7n
165 Filters
166 .RE
168 .sp
169 .ne 2
170 .na
171 \fB\fB128\fR\fR
172 .ad
173 .RS 7n
174 Access control
175 .RE
177 To request more than one category of debugging information, add the masks. For
178 example, to request trace and filter information, specify a \fIdebuglevel\fR of
179 33.
180 .RE
182 .sp
183 .ne 2
184 .na
185 \fB\fB-e\fR\ \fIerrorFile\fR\fR
186 .ad
187 .sp .6
188 .RS 4n
189 Invalid update statements in the input will be copied to the \fIerrorFile\fR
190 for debugging. Use with the \fB-c\fR option to correct errors when processing
191 large LDIF input.
192 .RE
194 .sp
195 .ne 2
196 .na
197 \fB\fB-E\fR\fR
198 .ad
199 .sp .6
200 .RS 4n
201 Ask server to expose (report) bind identity by means of authentication response
202 control.
203 .RE
205 .sp
206 .ne 2
207 .na
208 \fB\fB-F\fR\fR
209 .ad
210 .sp .6
211 .RS 4n
212 Forces application of all changes regardless of the content of input lines that
213 begin with \fBreplica:\fR. By default, \fBreplica:\fR lines are compared
214 against the \fBLDAP\fR server host and port in use to decide whether a replog
215 record should be applied.
216 .RE
218 .sp
219 .ne 2
220 .na
221 \fB\fB-f\fR \fIfile\fR\fR
222 .ad
223 .sp .6
224 .RS 4n
225 Reads the entry modification information from \fIfile\fR instead of from
226 standard input.
227 .RE
229 .sp
230 .ne 2
231 .na
232 \fB\fB-?\fR\fR
233 .ad
234 .sp .6
235 .RS 4n
236 Display the usage help text that briefly describes all options.
237 .RE
239 .sp
240 .ne 2
241 .na
242 \fB\fB-H\fR\fR
243 .ad
244 .sp .6
245 .RS 4n
246 Display the usage help text that briefly describes all options.
247 .RE
249 .sp
250 .ne 2
251 .na
252 \fB\fB-h\fR \fIldaphost\fR\fR
253 .ad
254 .sp .6
255 .RS 4n
256 Specifies an alternate host on which the LAPD server is running.
257 .RE
259 .sp
260 .ne 2
261 .na
262 \fB\fB-i\fR \fIlocale\fR\fR
263 .ad
264 .sp .6
265 .RS 4n
266 Specify the character set to use for the \fB-f\fR \fILDIFfile\fR or standard
267 input. The default is the character set specified in the \fBLANG\fR environment
268 variable. You might choose to use this option to perform the conversion from
269 the specified character set to UTF8, thus overriding the \fBLANG\fR setting.
270 .RE
272 .sp
273 .ne 2
274 .na
275 \fB\fB-j\fR \fIfilename\fR\fR
276 .ad
277 .sp .6
278 .RS 4n
279 Specify a file containing the password for the bind DN or the password for the
280 SSL client's key database. To protect the password, use this option in scripts
281 and place the password in a secure file. This option is mutually exclusive of
282 the \fB-w\fR and \fB-W\fR options.
283 .RE
285 .sp
286 .ne 2
287 .na
288 \fB\fB-J\fR [:\fIcriticality\fR[:\fIvalue\fR|::\fIb64value\fR|\fIb64value\fR|:\
289 fIfileurl\fR]]\fR
290 .ad
291 .sp .6
292 .RS 4n
293 Criticality is a boolean value (default is \fBfalse\fR).
294 .RE
296 .sp
297 .ne 2
298 .na
299 \fB\fB-k\fR \fIpath\fR\fR
300 .ad
301 .sp .6
302 .RS 4n
303 Specify the path to a directory containing conversion routines. These routines
304 are used if you want to specify a locale that is not supported by default by
305 your directory server. This is for NLS support.
306 .RE
308 .sp
309 .ne 2
310 .na
311 \fB\fB-l\fR\fI nb-ldap-connections\fR\fR
312 .ad
313 .sp .6
314 .RS 4n
315 Specifies the number of \fBLDAP\fR connections that \fBldapadd\fR or
316 \fBldapmodify\fR will open to process the modifications in the directory. The
317 default is one connection.
318 .RE
320 .sp
321 .ne 2
322 .na
323 \fB\fB-M\fR\fR
324 .ad
325 .sp .6
326 .RS 4n
327 Manage smart referrals. When they are the target of the operation, modify the
328 entry containing the referral instead of the entry obtained by following the
329 referral.
330 .RE
332 .sp
333 .ne 2
334 .na
335 \fB\fB-n\fR \fR
336 .ad
337 .sp .6
338 .RS 4n
339 Previews modifications, but makes no changes to entries. Useful in conjunction
340 with \fB-v\fR and \fB-d\fR for debugging.
341 .RE
343 .sp
344 .ne 2
345 .na
346 \fB\fB-N\fR \fIcertificate\fR\fR
347 .ad
348 .sp .6
349 .RS 4n
350 Specify the certificate name to use for certificate-based client
351 authentication. For example: \fB-N\fR \fB"Directory-Cert"\fR.
352 .RE
354 .sp
355 .ne 2
356 .na
357 \fB\fB-o\fR \fIattributename\fR=\fIvalue\fR\fR
358 .ad
359 .sp .6
360 .RS 4n
361 For SASL mechanisms and other options such as security properties, mode of
362 operation, authorization ID, authentication ID, and so forth.
363 .sp
364 The different attribute names and their values are as follows:
365 .sp
366 .ne 2
367 .na
368 \fB\fBsecProp\fR=\fI"number"\fR\fR
369 .ad
370 .RS 20n
371 For defining SASL security properties.
372 .RE
374 .sp
375 .ne 2
376 .na
377 \fB\fBrealm\fR=\fI"value"\fR\fR
378 .ad
379 .RS 20n
380 Specifies SASL realm (default is \fBrealm=none\fR).
381 .RE
383 .sp
384 .ne 2
385 .na
386 \fB\fBauthzid\fR=\fI"value"\fR\fR
387 .ad
388 .RS 20n
389 Specify the authorization ID name for SASL bind.
390 .RE
392 .sp
393 .ne 2
394 .na
395 \fB\fBauthid\fR=\fI"value"\fR\fR
396 .ad
397 .RS 20n
398 Specify the authentication ID for SASL bind.
399 .RE
401 .sp
402 .ne 2
403 .na
404 \fB\fBmech\fR=\fI"value"\fR\fR
405 .ad
406 .RS 20n
407 Specifies the various SASL mechanisms.
408 .RE
410 .RE
412 .sp
413 .ne 2
414 .na
415 \fB\fB-O\fR \fIhopLimit\fR\fR
416 .ad
417 .sp .6
418 .RS 4n
419 Specify the maximum number of referral hops to follow while finding an entry to
420 modify. By default, there is no limit.
421 .RE
423 .sp
424 .ne 2
425 .na
426 \fB\fB-p\fR \fIldapport\fR \fR
427 .ad
428 .sp .6
429 .RS 4n
430 Specifies an alternate \fBTCP\fR port where the secure LDAP server is
431 listening.
432 .RE
434 .sp
435 .ne 2
436 .na
437 \fB\fB-P\fR \fIpath\fR\fR
438 .ad
439 .sp .6
440 .RS 4n
441 Specify the path and filename of the client's certificate database. For
442 example:
443 .sp
444 .in +2
445 .nf
446 -P /home/uid/.netscape/cert7.db
447 .fi
448 .in -2
450 When using the command on the same host as the directory server, you can use
451 the server's own certificate database. For example:
452 .sp
453 .in +2
454 .nf
455 -P \fIinstallDir\fR/lapd-serverID/alias/cert7.db
456 .fi
457 .in -2
459 Use the \fB-P\fR option alone to specify server authentication only.
460 .RE
462 .sp
463 .ne 2
464 .na
465 \fB\fB-r\fR \fR
466 .ad
467 .sp .6
468 .RS 4n
469 Replaces existing value with the specified value. This is the default for
470 \fBldapmodify\fR. When \fBldapadd\fR is called, or if the \fB-a\fR option is
471 specified, the \fB-r\fR option is ignored.
472 .RE
474 .sp
475 .ne 2
476 .na
477 \fB\fB-v\fR \fR
478 .ad
479 .sp .6
480 .RS 4n
481 Uses verbose mode, with diagnostics written to standard output.
482 .RE
484 .sp
485 .ne 2
486 .na
487 \fB\fB-V\fR \fIversion\fR\fR
488 .ad
489 .sp .6
490 .RS 4n
491 Specify the LDAP protocol version number to be used for the delete operation,
492 either 2 or 3. LDAP v3 is the default. Specify LDAP v2 when connecting to
493 servers that do not support v3.
494 .RE
496 .sp
497 .ne 2
498 .na
499 \fB\fB-W\fR \fIpassword\fR\fR
500 .ad
501 .sp .6
502 .RS 4n
503 Specify the password for the client's key database given in the \fB-P\fR
504 option. This option is required for certificate-based client authentication.
505 Specifying \fIpassword\fR on the command line has security issues because the
506 password can be seen by others on the system by means of the \fBps\fR command.
507 Use the \fB-j\fR instead to specify the password from the file. This option is
508 mutually exclusive of \fB-j\fR.
509 .RE
511 .sp
512 .ne 2
513 .na
514 \fB\fB-w\fR \fIpasswd\fR \fR
515 .ad
516 .sp .6
517 .RS 4n
518 Use \fIpasswd\fR as the password for authentication to the directory. When you
519 use \fB-w\fR\fI passwd\fR to specify the password to be used for
520 authentication, the password is visible to other users of the system by means
521 of the \fBps\fR command, in script files or in shell history. If you use either
522 the \fBldapmodify\fR command or the \fBldapadd\fR command without this option,
523 the command will prompt for the password and read it from standard in. When
524 used without the \fB-w\fR option, the password will not be visible to other
525 users.
526 .RE
528 .sp
529 .ne 2
530 .na
531 \fB\fB-Y\fR \fIproxyid\fR\fR
532 .ad
533 .sp .6
534 .RS 4n
535 Specify the proxy DN (proxied authorization id) to use for the modify
536 operation, usually in double quotes ("") for the shell.
537 .RE
539 .sp
540 .ne 2
541 .na
542 \fB\fB-Z\fR\fR
543 .ad
544 .sp .6
545 .RS 4n
546 Specify that SSL be used to provide certificate-based client authentication.
547 This option requires the \fB-N\fR and SSL password and any other of the SSL
548 options needed to identify the certificate and the key database.
549 .RE
551 .SH EXIT STATUS
552 .sp
553 .LP
554 The following exit values are returned:
555 .sp
556 .ne 2
557 .na
558 \fB\fB0\fR \fR
559 .ad
560 .RS 13n
561 Successful completion.
562 .RE
564 .sp
565 .ne 2
566 .na
567 \fBNon-zero \fR
568 .ad
569 .RS 13n
570 An error occurred. A diagnostic message is written to standard error.
571 .RE
573 .SH EXAMPLES
574 .sp
575 .LP
576 The format of the content of \fIfile\fR (or standard input if no \fB-f\fR
577 option is specified) is illustrated in the following examples.
578 .LP
579 \fBExample 1 \fRModifying an Entry
580 .sp
581 .LP
582 The file \fB/tmp/entrymods\fR contains the following modification instructions:
584 .sp
585 .in +2
586 .nf
587 dn: cn=Modify Me, o=XYZ, c=US
588 changetype: modify
589 replace: mail
590 mail: modme@atlanta.xyz.com
591 -
592 add: title
593 title: System Manager
594 -
595 add: jpegPhoto
596 jpegPhoto:< file:///tmp/modme.jpeg
597 -
598 delete: description
599 -
600 .fi
601 .in -2
603 .sp
604 .LP
605 The command:
607 .sp
608 .in +2
609 .nf
610 example% \fBldapmodify -r -f /tmp/entrymods\fR
611 .fi
612 .in -2
613 .sp
615 .sp
616 .LP
617 modifies the \fBModify Me\fR entry as follows:
619 .RS +4
620 .TP
621 1.
622 The current value of the \fBmail\fR attribute is replaced with the value,
623 \fBmodme@atlanta.xyz.com\fR.
624 .RE
625 .RS +4
626 .TP
627 2.
628 A \fBtitle\fR attribute with the value, \fBSystem Manager\fR, is added.
629 .RE
630 .RS +4
631 .TP
632 3.
633 A \fBjpegPhoto\fR attribute is added, using the contents of the file,
634 \fB/tmp/modme.jpeg\fR, as the attribute value.
635 .RE
636 .RS +4
637 .TP
638 4.
639 The \fBdescription\fR attribute is removed.
640 .RE
641 .LP
642 \fBExample 2 \fRCreating a New Entry
643 .sp
644 .LP
645 The file, \fB/tmp/newentry\fR, contains the following information for creating
646 a new entry:
648 .sp
649 .in +2
650 .nf
651 dn: cn=Ann Jones, o=XYZ, c=US
652 objectClass: person
653 cn: Ann Jones
654 cn: Annie Jones
655 sn: Jones
656 title: Director of Research and Development
657 mail: ajones@londonrd.xyz.us.com
658 uid: ajones
659 .fi
660 .in -2
662 .sp
663 .LP
664 The command
666 .sp
667 .in +2
668 .nf
669 example% \fBldapadd -f /tmp/newentry\fR
670 .fi
671 .in -2
672 .sp
674 .sp
675 .LP
676 adds a new entry for \fBAnn Jones\fR, using the information in the file.
678 .LP
679 \fBExample 3 \fRCreating a New Entry on an IPv6 Server
680 .sp
681 .LP
682 The file, \fB/tmp/newentry\fR, contains the following information for creating
683 a new entry: on an IPv6 server.
685 .sp
686 .in +2
687 .nf
688 dn: cn=Ann Jones, o=XYZ, c=US
689 objectClass: person
690 cn: Ann Jones
691 cn: Annie Jones
692 sn: Jones
693 title: Director of Research and Development
694 mail: ajones@londonrd.xyz.us.com
695 uid: ajones
696 .fi
697 .in -2
699 .sp
700 .LP
701 The command
703 .sp
704 .in +2
705 .nf
706 example% \fBldapadd -c -v -h '['fec0::111:a00:20ff:feaa:a364']':389 \e
707 -D cn=Directory Manager -w secret \e
708 -f /tmp/entry \fR
709 .fi
710 .in -2
711 .sp
713 .sp
714 .LP
715 adds a new entry for \fBDirectory Manager\fR, using the information in the
716 file.
718 .LP
719 \fBExample 4 \fRDeleting an Entry
720 .sp
721 .LP
722 The file, \fB/tmp/badentry\fR, contains the following information about an
723 entry to be deleted:
725 .sp
726 .in +2
727 .nf
728 dn: cn=Ann Jones, o=XYZ, c=US
729 changetype: delete
730 .fi
731 .in -2
733 .sp
734 .LP
735 The command:
737 .sp
738 .in +2
739 .nf
740 example% \fBldapmodify -f /tmp/badentry\fR
741 .fi
742 .in -2
743 .sp
745 .sp
746 .LP
747 removes Ann Jones' entry.
749 .SH ATTRIBUTES
750 .sp
751 .LP
752 See \fBattributes\fR(5) for a description of the following attributes:
753 .sp
755 .sp
756 .TS
757 box;
758 c | c
759 l | l .
760 ATTRIBUTE TYPE ATTRIBUTE VALUE
761 Stability Level Evolving
762 .TE
764 .SH SEE ALSO
765 .sp
766 .LP
767 \fBldap\fR(1), \fBldapdelete\fR(1), \fBldaplist\fR(1), \fBldapmodrdn\fR(1),
768 \fBldapsearch\fR(1), \fBldapaddent\fR(1M), \fBldap_cachemgr\fR(1M),
769 \fBldap_get_option\fR(3LDAP), \fBldap_set_option\fR(3LDAP), \fBattributes\fR(5)