1 .TH LDAPMODIFY 1 "RELEASEDATE" "OpenLDAP LDVERSION"
3 .\" Copyright 1998-2009 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]
84 .BI \-h \ ldaphost\fR]
86 .BI \-p \ ldapport\fR]
88 .BI \-P \ 2\fR\||\|\fI3\fR]
90 .BR \-O \ security-properties ]
102 .BI \-X \ authzid\fR]
111 is a shell-accessible interface to the
112 .BR ldap_add_ext (3),
113 .BR ldap_modify_ext (3),
114 .BR ldap_delete_ext (3)
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 Continuous operation mode. Errors are reported, but
139 will continue with modifications. The default is to exit after
143 Add or change records which where skipped due to an error are written to \fIfile\fP
144 and the error message returned by the server is added as a comment. Most useful in
148 Show what would be done, but don't actually modify entries. Useful for
149 debugging in conjunction with -v.
152 Use verbose mode, with many diagnostics written to standard output.
155 Enable manage DSA IT control.
157 makes control critical.
160 Set the LDAP debugging level to \fIdebuglevel\fP.
162 must be compiled with LDAP_DEBUG defined for this option to have any effect.
165 Read the entry modification information from \fIfile\fP instead of from
169 Use simple authentication instead of SASL.
172 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
173 For SASL Binds, the server is expected to ignore this value.
176 Prompt for simple authentication.
177 This is used instead of specifying the password on the command line.
180 Use \fIpasswd\fP as the password for simple authentication.
183 Use complete contents of \fIpasswdfile\fP as the password for
184 simple authentication.
187 Specify URI(s) referring to the ldap server(s); only the protocol/host/port
188 fields are allowed; a list of URI, separated by whitespace or commas
192 Specify an alternate host on which the ldap server is running.
193 Deprecated in favor of -H.
196 Specify an alternate TCP port where the ldap server is listening.
197 Deprecated in favor of -H.
199 .BI \-P \ 2\fR\||\|\fI3
200 Specify the LDAP protocol version to use.
202 .BI \-O \ security-properties
203 Specify SASL security properties.
206 Enable SASL Interactive mode. Always prompt. Default is to prompt
210 Enable SASL Quiet mode. Never prompt.
213 Specify the authentication ID for SASL bind. The form of the ID
214 depends on the actual SASL mechanism used.
217 Specify the realm of authentication ID for SASL bind. The form of the realm
218 depends on the actual SASL mechanism used.
221 Specify the requested authorization ID for SASL bind.
223 must be one of the following formats:
225 .I <distinguished name>
231 Specify the SASL mechanism to be used for authentication. If it's not
232 specified, the program will choose the best mechanism the server knows.
235 Issue StartTLS (Transport Layer Security) extended operation. If you use
237 , the command will require the operation to be successful.
239 The contents of \fIfile\fP (or standard input if no \-f flag is given on
240 the command line) must conform to the format defined in
242 (LDIF as defined in RFC 2849).
244 Assuming that the file
246 exists and has the contents:
249 dn: cn=Modify Me,dc=example,dc=com
252 mail: modme@example.com
258 jpegPhoto:< file:///tmp/modme.jpeg
267 ldapmodify -f /tmp/entrymods
270 will replace the contents of the "Modify Me" entry's
272 attribute with the value "modme@example.com", add a
274 of "Grand Poobah", and the contents of the file "/tmp/modme.jpeg"
277 and completely remove the
281 Assuming that the file
283 exists and has the contents:
286 dn: cn=Barbara Jensen,dc=example,dc=com
291 title: the world's most famous mythical manager
292 mail: bjensen@example.com
299 ldapadd -f /tmp/newentry
302 will add a new entry for Babs Jensen, using the values from the
306 Assuming that the file
308 exists and has the contents:
311 dn: cn=Barbara Jensen,dc=example,dc=com
318 ldapmodify -f /tmp/entrymods
321 will remove Babs Jensen's entry.
323 Exit status is zero if no errors occur. Errors result in a non-zero
324 exit status and a diagnostic message being written to standard error.
332 .BR ldap_add_ext (3),
333 .BR ldap_delete_ext (3),
334 .BR ldap_modify_ext (3),
335 .BR ldap_modrdn_ext (3),
339 The OpenLDAP Project <http://www.openldap.org/>