1 .TH LDAPSEARCH 1 "RELEASEDATE" "OpenLDAP LDVERSION"
3 .\" Copyright 1998-2007 The OpenLDAP Foundation All Rights Reserved.
4 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 ldapsearch \- LDAP search tool
30 .BI \-S \ attribute\fR]
32 .BI \-d \ debuglevel\fR]
44 .BI \-y \ passwdfile\fR]
48 .BI \-h \ ldaphost\fR]
50 .BI \-p \ ldapport\fR]
52 .BI \-b \ searchbase\fR]
54 .BI \-s \ base\fR\||\|\fIone\fR\||\|\fIsub\fR\||\|\fIchildren\fR]
56 .BI \-a \ never\fR\||\|\fIalways\fR\||\|\fIsearch\fR\||\|\fIfind\fR]
58 .BI \-P \ 2\fR\||\|\fI3\fR]
60 .BR \-e \ [!]ext[=extparam]]
62 .BR \-E \ [!]ext[=extparam]]
64 .BI \-l \ timelimit\fR]
66 .BI \-z \ sizelimit\fR]
68 .BR \-O \ security-properties ]
88 is a shell-accessible interface to the
89 .BR ldap_search_ext (3)
93 opens a connection to an LDAP server, binds, and performs a search
94 using specified parameters. The \fIfilter\fP should conform to
95 the string representation for search filters as defined in RFC 4515.
96 If not provided, the default filter, (objectClass=*), is used.
100 finds one or more entries, the attributes specified by
101 \fIattrs\fP are returned. If * is listed, all user attributes are
102 returned. If + is listed, all operational attributes are returned.
103 If no \fIattrs\fP are listed, all user attributes are returned. If only
104 1.1 is listed, no attributes will be returned.
108 Show what would be done, but don't actually perform the search. Useful for
109 debugging in conjunction with -v.
112 Continuous operation mode. Errors are reported, but ldapsearch will continue
113 with searches. The default is to exit after reporting an error. Only useful
114 in conjunction with -f.
117 Include the User Friendly Name form of the Distinguished Name (DN)
121 Run in verbose mode, with many diagnostics written to standard output.
124 A single -t writes retrieved non-printable values to a set of temporary
125 files. This is useful for dealing with values containing non-character
126 data such as jpegPhoto or audio. A second -t writes all retrieved values to
130 Write temporary files to directory specified by \fIpath\fP (default:
134 URL prefix for temporary files. Default is file://\fIpath\fP/ where
135 \fIpath\fP is /var/tmp/ or specified with -T.
138 Retrieve attributes only (no values). This is useful when you just want to
139 see if an attribute is present in an entry and are not interested in the
143 Search results are display in LDAP Data Interchange Format detailed in
145 A single -L restricts the output to LDIFv1.
146 A second -L disables comments.
147 A third -L disables printing of the LDIF version.
148 The default is to use an extended version of LDIF.
151 Enable manage DSA IT control.
153 makes control critical.
156 Sort the entries returned based on \fIattribute\fP. The default is not
157 to sort entries returned. If \fIattribute\fP is a zero-length string (""),
158 the entries are sorted by the components of their Distinguished Name. See
160 for more details. Note that
162 normally prints out entries as it receives them. The use of the
164 option defeats this behavior, causing all entries to be retrieved,
165 then sorted, then printed.
168 Set the LDAP debugging level to \fIdebuglevel\fP.
170 must be compiled with LDAP_DEBUG defined for this option to have any effect.
173 Read a series of lines from \fIfile\fP, performing one LDAP search for
174 each line. In this case, the \fIfilter\fP given on the command line
175 is treated as a pattern where the first and only occurrence of \fB%s\fP
176 is replaced with a line from \fIfile\fP. Any other occurence of the
177 the \fB%\fP character in the pattern will be regarded as an error.
178 Where it is desired that the search filter include a \fB%\fP character,
179 the character should be encoded as \fB\\25\fP (see RFC 4515).
180 If \fIfile\fP is a single
181 \fI-\fP character, then the lines are read from standard input.
183 will exit when the first non-successful search result is returned,
187 Use simple authentication instead of SASL.
190 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
193 Prompt for simple authentication.
194 This is used instead of specifying the password on the command line.
197 Use \fIpasswd\fP as the password for simple authentication.
200 Use complete contents of \fIpasswdfile\fP as the password for
201 simple authentication.
204 Specify URI(s) referring to the ldap server(s); only the protocol/host/port
205 fields are allowed; a list of URI, separated by whitespace or commas
209 Specify an alternate host on which the ldap server is running.
210 Deprecated in favor of -H.
213 Specify an alternate TCP port where the ldap server is listening.
214 Deprecated in favor of -H.
217 Use \fIsearchbase\fP as the starting point for the search instead of
220 .BI \-s \ base\fR\||\|\fIone\fR\||\|\fIsub\fR\||\|\fIchildren
221 Specify the scope of the search to be one of
227 to specify a base object, one-level, subtree, or children search.
232 scope requires LDAPv3 subordinate feature extension.
234 .BI \-a \ never\fR\||\|\fIalways\fR\||\|\fIsearch\fR\||\|\fIfind
235 Specify how aliases dereferencing is done. Should be one of
241 to specify that aliases are never dereferenced, always dereferenced,
242 dereferenced when searching, or dereferenced only when locating the
243 base object for the search. The default is to never dereference aliases.
245 .BI \-P \ 2\fR\||\|\fI3
246 Specify the LDAP protocol version to use.
248 .B \-e \fI[!]ext[=extparam]\fP
250 .B \-E \fI[!]ext[=extparam]\fP
252 Specify general extensions with -e and search extensions with -E.
253 \'!\' indicates criticality.
257 [!]assert=<filter> (an RFC 4515 Filter)
258 [!]authzid=<authzid> ("dn:<dn>" or "u:<user>")
262 [!]postread[=<attrs>] (a comma-separated attribute list)
263 [!]preread[=<attrs>] (a comma-separated attribute list)
264 abandon, cancel (SIGINT sends abandon/cancel; not really controls)
269 [!]domainScope (domain scope)
270 [!]mv=<filter> (matched values filter)
271 [!]pr=<size>[/prompt|noprompt] (paged results/prompt)
272 [!]subentries[=true|false] (subentries)
273 [!]sync=ro[/<cookie>] (LDAP Sync refreshOnly)
274 rp[/<cookie>][/<slimit>] (LDAP Sync refreshAndPersist)
278 wait at most \fItimelimit\fP seconds for a search to complete.
286 means the maximum integer allowable by the protocol.
287 A server may impose a maximal timelimit which only
288 the root user may override.
291 retrieve at most \fIsizelimit\fP entries for a search.
299 means the maximum integer allowable by the protocol.
300 A server may impose a maximal sizelimit which only
301 the root user may override.
303 .BI \-O \ security-properties
304 Specify SASL security properties.
307 Enable SASL Interactive mode. Always prompt. Default is to prompt
311 Enable SASL Quiet mode. Never prompt.
314 Specify the authentication ID for SASL bind. The form of the ID
315 depends on the actual SASL mechanism used.
318 Specify the realm of authentication ID for SASL bind. The form of the realm
319 depends on the actual SASL mechanism used.
322 Specify the requested authorization ID for SASL bind.
324 must be one of the following formats:
326 .I <distinguished name>
332 Specify the SASL mechanism to be used for authentication. If it's not
333 specified, the program will choose the best mechanism the server knows.
336 Issue StartTLS (Transport Layer Security) extended operation. If you use
338 , the command will require the operation to be successful.
340 If one or more entries are found, each entry is written to standard
341 output in LDAP Data Interchange Format or
347 # bjensen, example, net
348 dn: uid=bjensen,dc=example,dc=net
350 objectClass: dcObject
357 If the -t option is used, the URI of a temporary file
358 is used in place of the actual value. If the -A option
359 is given, only the "attributename" part is written.
361 The following command:
364 ldapsearch -LLL "(sn=smith)" cn sn telephoneNumber
367 will perform a subtree search (using the default search base and
368 other parameters defined in
370 for entries with a surname (sn) of smith. The common name (cn), surname
371 (sn) and telephoneNumber values will be retrieved and printed to
373 The output might look something like this if two entries are found:
376 dn: uid=jts,dc=example,dc=com
382 telephoneNumber: 1 555 123-4567
384 dn: uid=sss,dc=example,dc=com
390 telephoneNumber: 1 555 765-4321
396 ldapsearch -LLL -u -t "(uid=xyz)" jpegPhoto audio
399 will perform a subtree search using the default search base for entries
400 with user id of "xyz". The user friendly form of the entry's DN will be
401 output after the line that contains the DN itself, and the jpegPhoto
402 and audio values will be retrieved and written to temporary files. The
403 output might look like this if one entry with one value for each of the
404 requested attributes is found:
407 dn: uid=xyz,dc=example,dc=com
408 ufn: xyz, example, com
409 audio:< file:///tmp/ldapsearch-audio-a19924
410 jpegPhoto:< file:///tmp/ldapsearch-jpegPhoto-a19924
416 ldapsearch -LLL -s one -b "c=US" "(o=University*)" o description
419 will perform a one-level search at the c=US level for all entries
420 whose organization name (o) begins begins with \fBUniversity\fP.
421 The organization name and description attribute values will be retrieved
422 and printed to standard output, resulting in output similar to this:
425 dn: o=University of Alaska Fairbanks,c=US
426 o: University of Alaska Fairbanks
427 description: Preparing Alaska for a brave new yesterday
428 description: leaf node only
430 dn: o=University of Colorado at Boulder,c=US
431 o: University of Colorado at Boulder
432 description: No personnel information
433 description: Institution of education and research
435 dn: o=University of Colorado at Denver,c=US
436 o: University of Colorado at Denver
440 description: Institute for Higher Learning and Research
442 dn: o=University of Florida,c=US
443 o: University of Florida
445 description: Warper of young minds
450 Exit status is zero if no errors occur.
451 Errors result in a non-zero exit status and
452 a diagnostic message being written to standard error.
461 .BR ldap_search_ext (3),
464 The OpenLDAP Project <http://www.openldap.org/>