1 .TH LDAPSEARCH 1 "3 October 2000" "OpenLDAP LDVERSION"
3 .\" Copyright 1998-2000 The OpenLDAP Foundation All Rights Reserved.
4 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 ldapsearch \- LDAP search tool
30 .BI \-d \ debuglevel\fR]
38 .BI \-w \ bindpasswd\fR]
42 .BI \-h \ ldaphost\fR]
44 .BI \-p \ ldapport\fR]
46 .BI \-P \ 2\fR\||\|\fI3\fR]
48 .BI \-b \ searchbase\fR]
50 .BI \-s \ base\fR\||\|\fIone\fR\||\|\fIsub\fR]
52 .BI \-a \ never\fR\||\|\fIalways\fR\||\|\fIsearch\fR\||\|\fIfind\fR]
54 .BI \-l \ timelimit\fR]
56 .BI \-z \ sizelimit\fR]
58 .BR \-O \ security-properties ]
64 .BI \-U \ username\fR]
78 is a shell-accessible interface to the
83 opens a connection to an LDAP server, binds, and performs a search
84 using specified parameters. The \fIfilter\fP should conform to
85 the string representation for search filters as defined in RFC 2254.
86 If not provided, the default filter, (objectClass=*), is used.
89 .B ldapsearch finds one or more entries, the attributes specified by
90 \fIattrs\fP are returned. If * is listed, all user attributes are
91 returned. If + is listed, all operational attributes are returned.
92 If no \fIattrs\fP are listed, all attributes are returned. If only
93 1.1 is listed, no attributes will be returned.
97 Show what would be done, but don't actually perform the search. Useful for
98 debugging in conjunction with -v.
101 Include the User Friendly Name form of the Distinguished Name (DN)
105 Run in verbose mode, with many diagnostics written to standard output.
108 Use Kerberos authentication instead of simple authentication. It is
109 assumed that you already have a valid ticket granting ticket.
111 must be compiled with Kerberos support for this option to have any effect.
114 Same as \-k, but only does step 1 of the Kerberos bind. This is useful
115 when connecting to a slapd and there is no x500dsa.hostname principal
116 registered with your Kerberos servers.
119 Write retrieved values to a set of temporary files. This is useful for
120 dealing with non-ASCII values such as jpegPhoto or audio.
123 Retrieve attributes only (no values). This is useful when you just want to
124 see if an attribute is present in an entry and are not interested in the
128 Search results are display in LDAP Data Interchange Format detailed in
130 A single -L restricts the output to LDIFv1.
131 A second -L disables comments.
132 A third -L disables printing of the LDIF version.
133 The default is to use an extended version of LDIF.
136 Enable manage DSA IT control.
138 makes control critical.
141 Automatically chase referrals.
144 Sort the entries returned based on \fIattribute\fP. The default is not
145 to sort entries returned. If \fIattribute\fP is a zero-length string (""),
146 the entries are sorted by the components of their Distingished Name. See
148 for more details. Note that
150 normally prints out entries as it receives them. The use of the
152 option defeats this behavior, causing all entries to be retrieved,
153 then sorted, then printed.
156 Set the LDAP debugging level to \fIdebuglevel\fP.
158 must be compiled with LDAP_DEBUG defined for this option to have any effect.
161 Read a series of lines from \fIfile\fP, performing one LDAP search for
162 each line. In this case, the \fIfilter\fP given on the command line
163 is treated as a pattern where the first occurrence of \fB%s\fP is
164 replaced with a line from \fIfile\fP. If \fIfile\fP is a single \fI-\fP
165 character, then the lines are read from standard input.
168 Use simple authentication instead of SASL.
171 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
174 Prompt for simple authentication.
175 This is used instead of specifying the password on the command line.
178 Use \fIbindpasswd\fP as the password for simple authentication.
181 Specify URI(s) referring to the ldap server(s).
184 Specify an alternate host on which the ldap server is running.
185 Deprecated in favor of -H.
188 Specify an alternate TCP port where the ldap server is listening.
189 Deprecated in favor of -H.
192 Use \fIsearchbase\fP as the starting point for the search instead of
195 .BI \-s \ base\fR\||\|\fIone\fR\||\|\fIsub
196 Specify the scope of the search to be one of
201 to specify a base object, one-level, or subtree search. The default
205 .BI \-a \ never\fR\||\|\fIalways\fR\||\|\fIsearch\fR\||\|\fIfind
206 Specify how aliases dereferencing is done. Should be one of
212 to specify that aliases are never dereferenced, always dereferenced,
213 dereferenced when searching, or dereferenced only when locating the
214 base object for the search. The default is to never dereference aliases.
216 .BI \-P \ 2\fR\||\|\fI3
217 Specify the LDAP protocol version to use.
220 wait at most \fItimelimit\fP seconds for a search to complete. A
226 A server may impose a maximal timelimit which only
227 the root user may override.
230 retrieve at most \fIsizelimit\fP entries for a search. A sizelimit
236 A server may impose a maximal sizelimit which only
237 the root user may override.
239 .BI \-O \ security-properties
240 Specify SASL security properties.
243 Enable SASL Interactive mode. Always prompt. Default is to prompt
247 Enable SASL Quiet mode. Never prompt.
250 Specify the username for SASL bind. The syntax of the username depends on the
251 actual SASL mechanism used.
254 Specify the requested authorization ID for SASL bind.
256 must be one of the following formats:
258 .I <distinguished name>
264 Specify the SASL mechanism to be used for authentication. If it's not
265 specified, the program will choose the best mechanism the server knows.
268 Issue StartTLS (Transport Layer Security) extended operation. If you use
270 , the command will require the operation to be successful.
272 If one or more entries are found, each entry is written to standard
273 output in LDAP Data Interchange Format or
279 # bjensen, example, net
280 dn: uid=bjensen, dc=example, dc=net
282 objectClass: dcObject
289 If the -t option is used, the URI of a temporary file
290 is used in place of the actual value. If the -A option
291 is given, only the "attributename" part is written.
293 The following command:
296 ldapsearch -LLL "(sn=smith)" cn sn telephoneNumber
299 will perform a subtree search (using the default search base defined
302 for entries with a surname (sn) of smith. The common name (cn), surname
303 (sn) and telephoneNumber values will be retrieved and printed to
305 The output might look something like this if two entries are found:
308 dn: uid=jts, dc=example, dc=com
314 telephoneNumber: 1 555 123-4567
316 dn: uid=sss, dc=example, dc=com
322 telephoneNumber: 1 555 765-4321
328 ldapsearch -LLL -u -t "(uid=xyz)" jpegPhoto audio
331 will perform a subtree search using the default search base for entries
332 with user id of "xyz". The user friendly form of the entry's DN will be
333 output after the line that contains the DN itself, and the jpegPhoto
334 and audio values will be retrieved and written to temporary files. The
335 output might look like this if one entry with one value for each of the
336 requested attributes is found:
339 dn: uid=xyz, dc=example, dc=com
340 ufn: xyz, example, com
341 audio:< file::/tmp/ldapsearch-audio-a19924
342 jpegPhoto:< file::=/tmp/ldapsearch-jpegPhoto-a19924
348 ldapsearch -LLL -s one -b "c=US" "(o=University*)" o description
351 will perform a one-level search at the c=US level for all entries
352 whose organization name (o) begins begins with \fBUniversity\fP.
353 The organization name and description attribute values will be retrieved
354 and printed to standard output, resulting in output similar to this:
357 dn: o=University of Alaska Fairbanks, c=US
358 o: University of Alaska Fairbanks
359 description: Preparing Alaska for a brave new yesterday
360 description: leaf node only
362 dn: o=University of Colorado at Boulder, c=US
363 o: University of Colorado at Boulder
364 description: No personnel information
365 description: Institution of education and research
367 dn: o=University of Colorado at Denver, c=US
368 o: University of Colorado at Denver
372 description: Institute for Higher Learning and Research
374 dn: o=University of Florida, c=US
375 o: University of Florida
377 description: Warper of young minds
382 Exit status is zero if no errors occur.
383 Errors result in a non-zero exit status and
384 a diagnostic message being written to standard error.
395 The OpenLDAP Project <http://www.openldap.org/>
398 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
400 is derived from University of Michigan LDAP 3.3 Release.