1 .TH LDAPMODIFY 1 "RELEASEDATE" "OpenLDAP LDVERSION"
3 .\" Copyright 1998-2002 The OpenLDAP Foundation All Rights Reserved.
4 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 ldapmodify, ldapadd \- LDAP modify entry and LDAP add entry tools
28 .BI \-d \ debuglevel\fR]
38 .BI \-h \ ldaphost\fR]
40 .BI \-p \ ldapport\fR]
42 .BI \-P \ 2\fR\||\|\fI3\fR]
44 .BR \-O \ security-properties ]
80 .BI \-d \ debuglevel\fR]
88 .BI \-h \ ldaphost\fR]
90 .BI \-p \ ldapport\fR]
92 .BI \-P \ 2\fR\||\|\fI3\fR]
94 .BR \-O \ security-properties ]
100 .BI \-U \ authcid\fR]
104 .BI \-X \ authzid\fR]
113 is a shell-accessible interface to the
119 is implemented as a hard link to the ldapmodify tool. When invoked as
121 the -a (add new entry) flag is turned on automatically.
124 opens a connection to an LDAP server, binds, and modifies or adds entries.
125 The entry information is read from standard input or from \fIfile\fP through
126 the use of the -f option.
130 Add new entries. The default for
132 is to modify existing entries. If invoked as
134 this flag is always set.
137 Automatically chase referrals.
140 Continuous operation mode. Errors are reported, but
142 will continue with modifications. The default is to exit after
146 Add or change records which where skipped due to an error are written to \fIfile\fP
147 and the error message returned by the server is added as a comment. Most useful in
151 Show what would be done, but don't actually modify entries. Useful for
152 debugging in conjunction with -v.
155 Use verbose mode, with many diagnostics written to standard output.
158 Use Kerberos IV authentication instead of simple authentication. It is
159 assumed that you already have a valid ticket granting ticket. You must
160 compile with Kerberos support for this option to have any effect.
163 Same as \-k, but only does step 1 of the Kerberos IV bind. This is useful
164 when connecting to a slapd and there is no x500dsa.hostname principal
165 registered with your Kerberos Domain Controller(s).
168 Force application of all changes regardless of the contents of input
169 lines that begin with
171 (by default, replica: lines are compared against the LDAP server host
172 and port in use to decide if a replog record should actually be applied).
175 Enable manage DSA IT control.
177 makes control critical.
180 Set the LDAP debugging level to \fIdebuglevel\fP.
182 must be compiled with LDAP_DEBUG defined for this option to have any effect.
185 Read the entry modification information from \fIfile\fP instead of from
189 Use simple authentication instead of SASL.
192 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
195 Prompt for simple authentication.
196 This is used instead of specifying the password on the command line.
199 Use \fIpasswd\fP as the password for simple authentication.
202 Specify URI(s) referring to the ldap server(s).
205 Specify an alternate host on which the ldap server is running.
206 Deprecated in favor of -H.
209 Specify an alternate TCP port where the ldap server is listening.
210 Deprecated in favor of -H.
212 .BI \-P \ 2\fR\||\|\fI3
213 Specify the LDAP protocol version to use.
215 .BI \-O \ security-properties
216 Specify SASL security properties.
219 Enable SASL Interactive mode. Always prompt. Default is to prompt
223 Enable SASL Quiet mode. Never prompt.
226 Specify the authentication ID for SASL bind. The form of the ID
227 depends on the actual SASL mechanism used.
230 Specify the requested authorization ID for SASL bind.
232 must be one of the following formats:
234 .I <distinguished name>
240 Specify the SASL mechanism to be used for authentication. If it's not
241 specified, the program will choose the best mechanism the server knows.
244 Issue StartTLS (Transport Layer Security) extended operation. If you use
246 , the command will require the operation to be successful.
248 The contents of \fIfile\fP (or standard input if no \-f flag is given on
249 the command line) should conform to the format defined in
250 .BR slapd.replog (5),
251 with the exceptions noted below.
253 Lines that begin with "replica:" are matched against the LDAP server host
254 and port in use to decide if a particular replog record should be applied.
255 Any other lines that precede the "dn:" line are ignored.
256 The -F flag can be used to force
258 to apply all of the replog changes, regardless of the presence or
259 absence of any "replica:" lines.
261 If no "changetype:" line is present, the default is "add" if the -a
262 flag is set (or if the program was invoked as
264 and "modify" otherwise.
266 If changetype is "modify" and no "add:", "replace:", or "delete:" lines
267 appear, the default is "replace" for and "add"
272 Note that the above exceptions to the
276 entries to be used as input to
281 Assuming that the file
283 exists and has the contents:
286 dn: cn=Modify Me,dc=example,dc=com
289 mail: modme@OpenLDAP.org
295 jpegPhoto:< file://tmp/modme.jpeg
304 ldapmodify -f /tmp/entrymods
307 will replace the contents of the "Modify Me" entry's
309 attribute with the value "modme@example.com", add a
311 of "Grand Poobah", and the contents of the file "/tmp/modme.jpeg"
314 and completely remove the
318 Assuming that the file
320 exists and has the contents:
323 dn: cn=Barbara Jensen,dc=example,dc=com
328 title: the world's most famous mythical manager
329 mail: bjensen@example.com
335 ldapadd -f /tmp/entrymods
338 will add a new entry for Babs Jensen, using the values from the
342 Assuming that the file
344 exists and has the contents:
347 dn: cn=Barbara Jensen,dc=example,dc=com
353 ldapmodify -f /tmp/entrymods
356 will remove Babs Jensen's entry.
358 Exit status is zero if no errors occur. Errors result in a non-zero
359 exit status and a diagnostic message being written to standard error.
373 The OpenLDAP Project <http://www.openldap.org/>
376 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
378 is derived from University of Michigan LDAP 3.3 Release.