1 .TH LDAPMODIFY 1 "20 August 2000" "OpenLDAP LDVERSION"
3 .\" Copyright 1998-2000 The OpenLDAP Foundation All Rights Reserved.
4 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 ldapmodify, ldapadd \- LDAP modify entry and LDAP add entry tools
26 .BI \-d \ debuglevel\fR]
36 .BI \-h \ ldaphost\fR]
38 .BI \-p \ ldapport\fR]
40 .BI \-P \ 2\fR\||\|\fI3\fR]
42 .BR \-O \ security-properties ]
78 .BI \-d \ debuglevel\fR]
86 .BI \-h \ ldaphost\fR]
88 .BI \-p \ ldapport\fR]
90 .BI \-P \ 2\fR\||\|\fI3\fR]
92 .BR \-O \ security-properties ]
102 .BI \-X \ authzid\fR]
111 is a shell-accessible interface to the
117 is implemented as a hard link to the ldapmodify tool. When invoked as
119 the -a (add new entry) flag is turned on automatically.
122 opens a connection to an LDAP server, binds, and modifies or adds entries.
123 The entry information is read from standard input or from \fIfile\fP through
124 the use of the -f option.
128 Add new entries. The default for
130 is to modify existing entries. If invoked as
132 this flag is always set.
135 Automatically chase referrals.
138 Continuous operation mode. Errors are reported, but
140 will continue with modifications. The default is to exit after
144 Show what would be done, but don't actually modify entries. Useful for
145 debugging in conjunction with -v.
148 Use verbose mode, with many diagnostics written to standard output.
151 Use Kerberos authentication instead of simple authentication. It is
152 assumed that you already have a valid ticket granting ticket. You must
153 compile with Kerberos support for this option to have any effect.
156 Same as \-k, but only does step 1 of the Kerberos bind. This is useful
157 when connecting to a slapd and there is no x500dsa.hostname principal
158 registered with your Kerberos servers.
161 Force application of all changes regardless of the contents of input
162 lines that begin with
164 (by default, replica: lines are compared against the LDAP server host
165 and port in use to decide if a replog record should actually be applied).
168 Enable manage DSA IT control.
170 makes control critical.
173 Set the LDAP debugging level to \fIdebuglevel\fP.
175 must be compiled with LDAP_DEBUG defined for this option to have any effect.
178 Read the entry modification information from \fIfile\fP instead of from
182 Use simple authentication instead of SASL.
185 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
188 Prompt for simple authentication.
189 This is used instead of specifying the password on the command line.
192 Use \fIpasswd\fP as the password for simple authentication.
195 Specify URI(s) referring to the ldap server(s).
198 Specify an alternate host on which the ldap server is running.
199 Deprecated in favor of -H.
202 Specify an alternate TCP port where the ldap server is listening.
203 Deprecated in favor of -H.
205 .BI \-P \ 2\fR\||\|\fI3
206 Specify the LDAP protocol version to use.
208 .BI \-O \ security-properties
209 Specify SASL security properties.
212 Enable SASL Interactive mode. Always prompt. Default is to prompt
216 Enable SASL Quiet mode. Never prompt.
219 Specify the authentication ID for SASL bind. The form of the ID
220 depends on the actual SASL mechanism used.
223 Specify the requested authorization ID for SASL bind.
225 must be one of the following formats:
227 .I <distinguished name>
233 Specify the SASL mechanism to be used for authentication. If it's not
234 specified, the program will choose the best mechanism the server knows.
237 Issue StartTLS (Transport Layer Security) extended operation. If you use
239 , the command will require the operation to be successful.
241 The contents of \fIfile\fP (or standard input if no \-f flag is given on
242 the command line) should conform to the format defined in
243 .BR slapd.replog (5),
244 with the exceptions noted below.
246 Lines that begin with "replica:" are matched against the LDAP server host
247 and port in use to decide if a particular replog record should be applied.
248 Any other lines that precede the "dn:" line are ignored.
249 The -F flag can be used to force
251 to apply all of the replog changes, regardless of the presence or
252 absence of any "replica:" lines.
254 If no "changetype:" line is present, the default is "add" if the -a
255 flag is set (or if the program was invoked as
257 and "modify" otherwise.
259 If changetype is "modify" and no "add:", "replace:", or "delete:" lines
260 appear, the default is "replace" for
266 Note that the above exceptions to the
270 entries to be used as input to
275 Assuming that the file
277 exists and has the contents:
280 dn: cn=Modify Me, dc=example, dc=com
283 mail: modme@OpenLDAP.org
289 jpegPhoto:< file://tmp/modme.jpeg
298 ldapmodify -f /tmp/entrymods
301 will replace the contents of the "Modify Me" entry's
303 attribute with the value "modme@example.com", add a
305 of "Grand Poobah", and the contents of the file "/tmp/modme.jpeg"
308 and completely remove the
312 Assuming that the file
314 exists and has the contents:
317 dn: cn=Barbara Jensen, dc=example, dc=com
322 title: the world's most famous mythical manager
323 mail: bjensen@example.com
329 ldapadd -f /tmp/entrymods
332 will add a new entry for Babs Jensen, using the values from the
336 Assuming that the file
338 exists and has the contents:
341 dn: cn=Barbara Jensen, dc=example, dc=com
347 ldapmodify -f /tmp/entrymods
350 will remove Babs Jensen's entry.
352 Exit status is zero if no errors occur. Errors result in a non-zero
353 exit status and a diagnostic message being written to standard error.
367 There is no interactive mode, but there probably should be.
369 The OpenLDAP Project <http://www.openldap.org/>
372 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
374 is derived from University of Michigan LDAP 3.3 Release.