1 .TH LDAPMODIFY 1 "10 November 1998" "OpenLDAP LDVERSION"
3 ldapmodify, ldapadd \- ldap modify entry and ldap add entry tools
36 is a shell-accessible interface to the
42 is implemented as a hard link to the ldapmodify tool. When invoked as
44 the -a (add new entry) flag is turned on automatically.
47 opens a connection to an LDAP server, binds, and modifies or adds entries.
48 The entry information is read from standard input or from \fIfile\fP through
49 the use of the -f option.
53 Add new entries. The default for
55 is to modify existing entries. If invoked as
57 this flag is always set.
60 Assume that any values that start with a `/' are binary values and that
61 the actual value is in a file whose path is specified in the place where
62 values normally appear.
65 Continuous operation mode. Errors are reported, but
67 will continue with modifications. The default is to exit after
71 Replace existing values by default.
74 Show what would be done, but don't actually modify entries. Useful for
75 debugging in conjunction with -v.
78 Use verbose mode, with many diagnostics written to standard output.
81 Use Kerberos authentication instead of simple authentication. It is
82 assumed that you already have a valid ticket granting ticket. You must
83 compile with KERBEROS defined for this option to have any effect.
86 Same as \-k, but only does step 1 of the kerberos bind. This is useful
87 when connecting to a slapd and there is no x500dsa.hostname principal
88 registered with your kerberos servers.
91 Force application of all changes regardless of the contents of input
94 (by default, replica: lines are compared against the LDAP server host
95 and port in use to decide if a replog record should actually be applied).
98 Set the LDAP debugging level to \fIdebuglevel\fP.
100 must be compiled with LDAP_DEBUG defined for this option to have any effect.
103 Read the entry modification information from \fIfile\fP instead of from
107 Use \fIbinddn\fP to bind to the LDAP directory. \fIbinddn\fP should be
108 a string-represented DN as defined in RFC 1779.
111 Use \fIpasswd\fP as the password for simple authentication.
114 Specify an alternate host on which the ldap server is running.
117 Specify an alternate TCP port where the ldap server is listening.
119 The contents of \fIfile\fP (or standard input if no \-f flag is given on
120 the command line) should conform to the format defined in
121 .BR slapd.replog (5),
122 with the exceptions noted below.
124 If the first line of a record consists of a decimal number (entry id),
127 Lines that begin with "replica:" are matched against the LDAP server host
128 and port in use to decide if a particular replog record should be applied.
129 Any other lines that precede the "dn:" line are ignored.
130 The -F flag can be used to force
132 to apply all of the replog changes, regardless of the presence or
133 absence of any "replica:" lines.
135 If no "changetype:" line is present, the default is "add" if the -a
136 flag is set (or if the program was invoked as
138 and "modify" otherwise.
140 If changetype is "modify" and no "add:", "replace:", or "delete:" lines
141 appear, the default is "replace" if the -r flag is set and "add"
144 Note that the above exceptions to the
148 entries to be used as input to
152 .SH ALTERNATIVE INPUT FORMAT
153 An alternative input format is supported for compatibility with older
156 This format consists of one or more entries separated by blank lines,
157 where each entry looks like:
160 Distinguished Name (DN)
165 where \fIattr\fP is the name of the attribute and \fIvalue\fP is the
168 By default, values are added. If the
171 given, the default is to replace existing values with the new one.
172 Note that it is permissible for a given attribute to appear more than
173 once (for example, to add more than one value for an attribute). Also
174 note that you can use a trailing `\\' to continue values across lines and
175 preserve newlines in the value itself (this is useful for modifying
176 QUIPU iattr attributes among others).
179 should be preceded by a \fB-\fP to remove a value. The `=' and
180 value should be omitted to remove an entire attribute.
183 should be preceded by a \fB+\fP to add a value in the presence of the
187 Assuming that the file
189 exists and has the contents:
192 dn: cn=Modify Me, o=University of Michigan, c=US
195 mail: modme@terminator.rs.itd.umich.edu
201 jpegPhoto: /tmp/modme.jpeg
210 ldapmodify -b -r -f /tmp/entrymods
213 will replace the contents of the "Modify Me" entry's
215 attribute with the value "modme@terminator.rs.itd.umich.edu", add a
217 of "Grand Poobah", and the contents of the file "/tmp/modme.jpeg"
220 and completely remove the
223 The same modifications as above can be performed using the older
228 cn=Modify Me, o=University of Michigan, c=US
229 mail=modme@terminator.rs.itd.umich.edu
231 +jpegPhoto=/tmp/modme.jpeg
238 ldapmodify -b -r -f /tmp/entrymods
241 Assuming that the file
243 exists and has the contents:
246 dn: cn=Barbara Jensen, o=University of Michigan, c=US
251 title: the world's most famous mythical manager
252 mail: bjensen@terminator.rs.itd.umich.edu
258 ldapadd -f /tmp/entrymods
261 will add a new entry for Babs Jensen, using the values from the
265 Assuming that the file
267 exists and has the contents:
270 dn: cn=Barbara Jensen, o=University of Michigan, c=US
276 ldapmodify -f /tmp/entrymods
279 will remove Babs Jensen's entry.
281 Exit status is 0 if no errors occur. Errors result in a non-zero exit
282 status and a diagnostic message being written to standard error.
297 .IR "A String Representation of Distinguished Names",
300 ISODE Consortium, March 1995.
302 There is no interactive mode, but there probably should be.
305 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
307 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob