1 .TH LDAPMODIFY 1 "RELEASEDATE" "OpenLDAP LDVERSION"
3 .\" Copyright 1998-2007 The OpenLDAP Foundation All Rights Reserved.
4 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 ldapmodify, ldapadd \- LDAP modify entry and LDAP add entry tools
22 .BI \-d \ debuglevel\fR]
30 .BI \-y \ passwdfile\fR]
34 .BI \-h \ ldaphost\fR]
36 .BI \-p \ ldapport\fR]
38 .BI \-P \ 2\fR\||\|\fI3\fR]
40 .BR \-O \ security-properties ]
72 .BI \-d \ debuglevel\fR]
80 .BI \-y \ passwdfile\fR]
82 .BI \-h \ ldaphost\fR]
84 .BI \-p \ ldapport\fR]
86 .BI \-P \ 2\fR\||\|\fI3\fR]
88 .BR \-O \ security-properties ]
100 .BI \-X \ authzid\fR]
109 is a shell-accessible interface to the
110 .BR ldap_add_ext (3),
111 .BR ldap_modify_ext (3),
112 .BR ldap_delete_ext (3)
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 Continuous operation mode. Errors are reported, but
137 will continue with modifications. The default is to exit after
141 Add or change records which where skipped due to an error are written to \fIfile\fP
142 and the error message returned by the server is added as a comment. Most useful in
146 Show what would be done, but don't actually modify entries. Useful for
147 debugging in conjunction with -v.
150 Use verbose mode, with many diagnostics written to standard output.
153 Force application of all changes regardless of the contents of input
154 lines that begin with
156 (by default, replica: lines are compared against the LDAP server host
157 and port in use to decide if a replog record should actually be applied).
160 Enable manage DSA IT control.
162 makes control critical.
165 Set the LDAP debugging level to \fIdebuglevel\fP.
167 must be compiled with LDAP_DEBUG defined for this option to have any effect.
170 Read the entry modification information from \fIfile\fP instead of from
174 Use simple authentication instead of SASL.
177 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
180 Prompt for simple authentication.
181 This is used instead of specifying the password on the command line.
184 Use \fIpasswd\fP as the password for simple authentication.
187 Use complete contents of \fIpasswdfile\fP as the password for
188 simple authentication.
191 Specify URI(s) referring to the ldap server(s); only the protocol/host/port
192 fields are allowed; a list of URI, separated by whitespace or commas
196 Specify an alternate host on which the ldap server is running.
197 Deprecated in favor of -H.
200 Specify an alternate TCP port where the ldap server is listening.
201 Deprecated in favor of -H.
203 .BI \-P \ 2\fR\||\|\fI3
204 Specify the LDAP protocol version to use.
206 .BI \-O \ security-properties
207 Specify SASL security properties.
210 Enable SASL Interactive mode. Always prompt. Default is to prompt
214 Enable SASL Quiet mode. Never prompt.
217 Specify the authentication ID for SASL bind. The form of the ID
218 depends on the actual SASL mechanism used.
221 Specify the realm of authentication ID for SASL bind. The form of the realm
222 depends on the actual SASL mechanism used.
225 Specify the requested authorization ID for SASL bind.
227 must be one of the following formats:
229 .I <distinguished name>
235 Specify the SASL mechanism to be used for authentication. If it's not
236 specified, the program will choose the best mechanism the server knows.
239 Issue StartTLS (Transport Layer Security) extended operation. If you use
241 , the command will require the operation to be successful.
243 The contents of \fIfile\fP (or standard input if no \-f flag is given on
244 the command line) should conform to the format defined in
246 (LDIF as defined RFC 2849), or
248 (an extended form of LDIF)
249 with the exceptions noted below.
251 Lines that begin with "replica:" are matched against the LDAP server host
252 and port in use to decide if a particular replog record should be applied.
253 Any other lines that precede the "dn:" line are ignored.
254 The -F flag can be used to force
256 to apply all of the replog changes, regardless of the presence or
257 absence of any "replica:" lines.
259 If no "changetype:" line is present, the default is "add" if the -a
260 flag is set (or if the program was invoked as
262 and "modify" otherwise.
264 If changetype is "modify" and no "add:", "replace:", or "delete:" lines
265 appear, the default is "replace" for
270 Note that the above exceptions to the
274 entries to be used as input to
279 Assuming that the file
281 exists and has the contents:
284 dn: cn=Modify Me,dc=example,dc=com
287 mail: modme@example.com
293 jpegPhoto:< file:///tmp/modme.jpeg
302 ldapmodify -f /tmp/entrymods
305 will replace the contents of the "Modify Me" entry's
307 attribute with the value "modme@example.com", add a
309 of "Grand Poobah", and the contents of the file "/tmp/modme.jpeg"
312 and completely remove the
316 Assuming that the file
318 exists and has the contents:
321 dn: cn=Barbara Jensen,dc=example,dc=com
326 title: the world's most famous mythical manager
327 mail: bjensen@example.com
333 ldapadd -f /tmp/newentry
336 will add a new entry for Babs Jensen, using the values from the
340 Assuming that the file
342 exists and has the contents:
345 dn: cn=Barbara Jensen,dc=example,dc=com
351 ldapmodify -f /tmp/entrymods
354 will remove Babs Jensen's entry.
356 Exit status is zero if no errors occur. Errors result in a non-zero
357 exit status and a diagnostic message being written to standard error.
365 .BR ldap_add_ext (3),
366 .BR ldap_delete_ext (3),
367 .BR ldap_modify_ext (3),
368 .BR ldap_modrdn_ext (3),
372 The OpenLDAP Project <http://www.openldap.org/>