ldapmodify.1 8 KB
Newer Older
Kurt Zeilenga's avatar
Kurt Zeilenga committed
1
.TH LDAPMODIFY 1 "RELEASEDATE" "OpenLDAP LDVERSION"
Kurt Zeilenga's avatar
Kurt Zeilenga committed
2
3
4
.\" $OpenLDAP$
.\" Copyright 1998-2002 The OpenLDAP Foundation All Rights Reserved.
.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
5
.SH NAME
Kurt Zeilenga's avatar
Kurt Zeilenga committed
6
ldapmodify, ldapadd \- LDAP modify entry and LDAP add entry tools
Kurt Zeilenga's avatar
Kurt Zeilenga committed
7
8
.SH SYNOPSIS
.B ldapmodify
Kurt Zeilenga's avatar
Kurt Zeilenga committed
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
[\c
.BR \-a ]
[\c
.BR \-c ]
[\c
.BI \-S \ file\fR]
.[\c
.BR \-C ]
[\c
.BR \-n ]
[\c
.BR \-v ]
[\c
.BR \-k ]
[\c
.BR \-K ]
[\c
.BR \-M[M] ]
[\c
.BI \-d \ debuglevel\fR]
[\c
.BI \-D \ binddn\fR]
[\c
.BR \-W ]
[\c
.BI \-w \ passwd\fR]
[\c
.BI \-H \ ldapuri\fR]
[\c
.BI \-h \ ldaphost\fR]
[\c
.BI \-p \ ldapport\fR]
[\c
.BI \-P \ 2\fR\||\|\fI3\fR]
[\c
.BR \-O \ security-properties ]
[\c
.BR \-I ]
[\c
.BR \-Q ]
[\c
.BI \-U \ authcid\fR]
[\c
.BR \-x ]
[\c
.BI \-X \ authzid\fR]
[\c
.BI \-Y \ mech\fR]
[\c
.BR \-Z[Z] ]
[\c
.BI \-f \ file\fR]
Kurt Zeilenga's avatar
Kurt Zeilenga committed
61
62
.LP
.B ldapadd
Kurt Zeilenga's avatar
Kurt Zeilenga committed
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
[\c
.BR \-c ]
[\c
.BI \-S \ file\fR]
[\c
.BR \-C ]
[\c
.BR \-n ]
[\c
.BR \-v ]
[\c
.BR \-k ]
[\c
.BR \-K ]
[\c
.BR \-M[M] ]
[\c
.BI \-d \ debuglevel\fR]
[\c
.BI \-D \ binddn\fR]
[\c
.BR \-W ]
[\c
.BI \-w \ passwd\fR]
[\c
.BI \-h \ ldaphost\fR]
[\c
.BI \-p \ ldapport\fR]
[\c
.BI \-P \ 2\fR\||\|\fI3\fR]
[\c
.BR \-O \ security-properties ]
[\c
.BR \-I ]
[\c
.BR \-Q ]
[\c
.BI \-U \ authcid\fR]
[\c
.BR \-x ]
[\c
.BI \-X \ authzid\fR]
[\c
.BI \-Y \ mech\fR]
[\c
.BR \-Z[Z] ]
[\c
.BI \-f \ file\fR]
Kurt Zeilenga's avatar
Kurt Zeilenga committed
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
.SH DESCRIPTION
.B ldapmodify
is a shell-accessible interface to the
.BR ldap_modify (3)
and
.BR ldap_add (3)
library calls.
.B ldapadd
is implemented as a hard link to the ldapmodify tool.  When invoked as
.B ldapadd
the -a (add new entry) flag is turned on automatically.
.LP
.B ldapmodify
opens a connection to an LDAP server, binds, and modifies or adds entries.
The entry information is read from standard input or from \fIfile\fP through
the use of the -f option.
.SH OPTIONS
.TP
.B \-a
Add new entries.  The default for
.B ldapmodify
is to modify existing entries.  If invoked as
.BR ldapadd ,
this flag is always set.
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
136
137
.B \-C
Automatically chase referrals.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
138
139
140
141
142
143
144
.TP
.B \-c
Continuous operation mode.  Errors are reported, but
.B ldapmodify
will continue with modifications.  The default is to exit after
reporting an error.
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
145
146
147
148
.BI \-S \ file
Add or change records which where skipped due to an error are written to \fIfile\fP 
and the error message returned by the server is added as a comment. Most useful in 
conjunction with -c.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
149
150
151
152
153
154
155
156
157
.TP
.B \-n
Show what would be done, but don't actually modify entries.  Useful for
debugging in conjunction with -v.
.TP
.B \-v
Use verbose mode, with many diagnostics written to standard output.
.TP
.B \-k
Kurt Zeilenga's avatar
Kurt Zeilenga committed
158
Use Kerberos IV authentication instead of simple authentication.  It is
Kurt Zeilenga's avatar
Kurt Zeilenga committed
159
assumed that you already have a valid ticket granting ticket.  You must
Kurt Zeilenga's avatar
Kurt Zeilenga committed
160
compile with Kerberos support for this option to have any effect.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
161
162
.TP
.B \-K
Kurt Zeilenga's avatar
Kurt Zeilenga committed
163
Same as \-k, but only does step 1 of the Kerberos IV bind.  This is useful
Kurt Zeilenga's avatar
Kurt Zeilenga committed
164
when connecting to a slapd and there is no x500dsa.hostname principal
Kurt Zeilenga's avatar
Kurt Zeilenga committed
165
registered with your Kerberos Domain Controller(s).
Kurt Zeilenga's avatar
Kurt Zeilenga committed
166
167
168
169
170
171
172
173
.TP
.B \-F
Force application of all changes regardless of the contents of input
lines that begin with
.I replica:
(by default, replica: lines are compared against the LDAP server host
and port in use to decide if a replog record should actually be applied).
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
174
175
176
177
178
179
.B \-M[M]
Enable manage DSA IT control.
.B \-MM
makes control critical.
.TP
.BI \-d \ debuglevel
Kurt Zeilenga's avatar
Kurt Zeilenga committed
180
181
182
183
Set the LDAP debugging level to \fIdebuglevel\fP.
.B ldapmodify
must be compiled with LDAP_DEBUG defined for this option to have any effect.
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
184
.BI \-f \ file
Kurt Zeilenga's avatar
Kurt Zeilenga committed
185
186
187
Read the entry modification information from \fIfile\fP instead of from
standard input.
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
188
189
190
191
192
.B \-x 
Use simple authentication instead of SASL.
.TP
.BI \-D \ binddn
Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
193
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
194
195
196
197
198
.B \-W
Prompt for simple authentication.
This is used instead of specifying the password on the command line.
.TP
.BI \-w \ passwd
Kurt Zeilenga's avatar
Kurt Zeilenga committed
199
200
Use \fIpasswd\fP as the password for simple authentication.
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
201
202
203
204
.BI \-H \ ldapuri
Specify URI(s) referring to the ldap server(s).
.TP
.BI \-h \ ldaphost
Kurt Zeilenga's avatar
Kurt Zeilenga committed
205
Specify an alternate host on which the ldap server is running.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
206
Deprecated in favor of -H.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
207
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
208
.BI \-p \ ldapport
Kurt Zeilenga's avatar
Kurt Zeilenga committed
209
Specify an alternate TCP port where the ldap server is listening.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
Deprecated in favor of -H.
.TP
.BI \-P \ 2\fR\||\|\fI3
Specify the LDAP protocol version to use.
.TP
.BI \-O \ security-properties
Specify SASL security properties.
.TP
.B \-I
Enable SASL Interactive mode.  Always prompt.  Default is to prompt
only as needed.
.TP
.B \-Q
Enable SASL Quiet mode.  Never prompt.
.TP
.BI \-U \ authcid
Specify the authentication ID for SASL bind. The form of the ID
depends on the actual SASL mechanism used.
.TP
.BI \-X \ authzid
230
Specify the proxy authorization ID for SASL bind.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
.I authzid
must be one of the following formats:
.B dn:\c
.I <distinguished name>
or
.B u:\c
.I <username>
.TP
.BI \-Y \ mech
Specify the SASL mechanism to be used for authentication. If it's not
specified, the program will choose the best mechanism the server knows.
.TP
.B \-Z[Z]
Issue StartTLS (Transport Layer Security) extended operation. If you use
.B \-ZZ\c
, the command will require the operation to be successful.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
.SH INPUT FORMAT
The contents of \fIfile\fP (or standard input if no \-f flag is given on
the command line) should conform to the format defined in
.BR slapd.replog (5),
with the exceptions noted below.
.LP
Lines that begin with "replica:" are matched against the LDAP server host
and port in use to decide if a particular replog record should be applied.
Any other lines that precede the "dn:" line are ignored.
The -F flag can be used to force
.I ldapmodify
to apply all of the replog changes, regardless of the presence or
absence of any "replica:" lines.
.LP
If no "changetype:" line is present, the default is "add" if the -a
flag is set (or if the program was invoked as
.I ldapmodify)
and "modify" otherwise.
.LP
If changetype is "modify" and no "add:", "replace:", or "delete:" lines
Kurt Zeilenga's avatar
Kurt Zeilenga committed
267
268
269
270
appear, the default is "replace" for and "add"
.BR ldapmodify (1)
for
.BR ldapadd (1).
Kurt Zeilenga's avatar
Kurt Zeilenga committed
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
.LP
Note that the above exceptions to the
.BR slapd.replog (5)
format allow
.BR ldif (5)
entries to be used as input to
.I ldapmodify
or
.I ldapadd.
.SH EXAMPLES
Assuming that the file
.B /tmp/entrymods
exists and has the contents:
.LP
.nf
Kurt Zeilenga's avatar
Kurt Zeilenga committed
286
    dn: cn=Modify Me,dc=example,dc=com
Kurt Zeilenga's avatar
Kurt Zeilenga committed
287
288
    changetype: modify
    replace: mail
Kurt Zeilenga's avatar
Kurt Zeilenga committed
289
    mail: modme@OpenLDAP.org
Kurt Zeilenga's avatar
Kurt Zeilenga committed
290
291
292
293
294
    -
    add: title
    title: Grand Poobah
    -
    add: jpegPhoto
Kurt Zeilenga's avatar
Kurt Zeilenga committed
295
    jpegPhoto:< file://tmp/modme.jpeg
Kurt Zeilenga's avatar
Kurt Zeilenga committed
296
297
298
299
300
301
302
303
    -
    delete: description
    -
.fi
.LP
the command:
.LP
.nf
Kurt Zeilenga's avatar
Kurt Zeilenga committed
304
    ldapmodify -f /tmp/entrymods
Kurt Zeilenga's avatar
Kurt Zeilenga committed
305
306
307
308
.fi
.LP
will replace the contents of the "Modify Me" entry's
.I mail
Kurt Zeilenga's avatar
Kurt Zeilenga committed
309
attribute with the value "modme@example.com", add a
Kurt Zeilenga's avatar
Kurt Zeilenga committed
310
311
312
313
314
315
316
317
318
319
320
321
322
.I title
of "Grand Poobah", and the contents of the file "/tmp/modme.jpeg"
as a
.IR jpegPhoto ,
and completely remove the
.I description
attribute.
.LP
Assuming that the file
.B /tmp/newentry
exists and has the contents:
.LP
.nf
Kurt Zeilenga's avatar
Kurt Zeilenga committed
323
    dn: cn=Barbara Jensen,dc=example,dc=com
Kurt Zeilenga's avatar
Kurt Zeilenga committed
324
325
326
327
328
    objectClass: person
    cn: Barbara Jensen
    cn: Babs Jensen
    sn: Jensen
    title: the world's most famous mythical manager
Kurt Zeilenga's avatar
Kurt Zeilenga committed
329
    mail: bjensen@example.com
Kurt Zeilenga's avatar
Kurt Zeilenga committed
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
    uid: bjensen
.LP
the command:
.LP
.nf
    ldapadd -f /tmp/entrymods
.fi
.LP
will add a new entry for Babs Jensen, using the values from the
file
.B /tmp/newentry.
.LP
Assuming that the file
.B /tmp/newentry
exists and has the contents:
.LP
.nf
Kurt Zeilenga's avatar
Kurt Zeilenga committed
347
    dn: cn=Barbara Jensen,dc=example,dc=com
Kurt Zeilenga's avatar
Kurt Zeilenga committed
348
349
350
351
352
353
354
355
356
357
    changetype: delete
.LP
the command:
.LP
.nf
    ldapmodify -f /tmp/entrymods
.fi
.LP
will remove Babs Jensen's entry.
.SH DIAGNOSTICS
Kurt Zeilenga's avatar
Kurt Zeilenga committed
358
359
Exit status is zero if no errors occur.  Errors result in a non-zero
exit status and a diagnostic message being written to standard error.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
360
361
362
363
364
.SH "SEE ALSO"
.BR ldapadd (1),
.BR ldapdelete (1),
.BR ldapmodrdn (1),
.BR ldapsearch (1),
Kurt Zeilenga's avatar
Kurt Zeilenga committed
365
.BR ldap.conf (5),
Kurt Zeilenga's avatar
Kurt Zeilenga committed
366
367
368
369
370
371
.BR ldap (3),
.BR ldap_add (3),
.BR ldap_delete (3),
.BR ldap_modify (3),
.BR ldap_modrdn (3),
.BR slapd.replog (5)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
372
373
374
375
376
377
378
.SH AUTHOR
The OpenLDAP Project <http://www.openldap.org/>
.SH ACKNOWLEDGEMENTS
.B	OpenLDAP
is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
.B	OpenLDAP
is derived from University of Michigan LDAP 3.3 Release.