1 .TH LDAPSEARCH 1 "RELEASEDATE" "OpenLDAP LDVERSION"
3 .\" Copyright 1998-2006 The OpenLDAP Foundation All Rights Reserved.
4 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 ldapsearch \- LDAP search tool
28 .BI \-S \ attribute\fR]
30 .BI \-d \ debuglevel\fR]
42 .BI \-y \ passwdfile\fR]
46 .BI \-h \ ldaphost\fR]
48 .BI \-p \ ldapport\fR]
50 .BI \-b \ searchbase\fR]
52 .BI \-s \ base\fR\||\|\fIone\fR\||\|\fIsub\fR\||\|\fIchildren\fR]
54 .BI \-a \ never\fR\||\|\fIalways\fR\||\|\fIsearch\fR\||\|\fIfind\fR]
56 .BI \-P \ 2\fR\||\|\fI3\fR]
58 .BR \-e \ [!]ext[=extparam]]
60 .BR \-E \ [!]ext[=extparam]]
62 .BI \-l \ timelimit\fR]
64 .BI \-z \ sizelimit\fR]
66 .BR \-O \ security-properties ]
86 is a shell-accessible interface to the
87 .BR ldap_search_ext (3)
91 opens a connection to an LDAP server, binds, and performs a search
92 using specified parameters. The \fIfilter\fP should conform to
93 the string representation for search filters as defined in RFC 4515.
94 If not provided, the default filter, (objectClass=*), is used.
97 .B ldapsearch finds one or more entries, the attributes specified by
98 \fIattrs\fP are returned. If * is listed, all user attributes are
99 returned. If + is listed, all operational attributes are returned.
100 If no \fIattrs\fP are listed, all user attributes are returned. If only
101 1.1 is listed, no attributes will be returned.
105 Show what would be done, but don't actually perform the search. Useful for
106 debugging in conjunction with -v.
109 Include the User Friendly Name form of the Distinguished Name (DN)
113 Run in verbose mode, with many diagnostics written to standard output.
116 A single -t writes retrieved non-printable values to a set of temporary
117 files. This is useful for dealing with values containing non-character
118 data such as jpegPhoto or audio. A second -t writes all retrieved values to
122 Write temporary files to directory specified by \fIpath\fP (default:
126 URL prefix for temporary files. Default is file://\fIpath\fP/ where
127 \fIpath\fP is /var/tmp/ or specified with -T.
130 Retrieve attributes only (no values). This is useful when you just want to
131 see if an attribute is present in an entry and are not interested in the
135 Search results are display in LDAP Data Interchange Format detailed in
137 A single -L restricts the output to LDIFv1.
138 A second -L disables comments.
139 A third -L disables printing of the LDIF version.
140 The default is to use an extended version of LDIF.
143 Enable manage DSA IT control.
145 makes control critical.
148 Sort the entries returned based on \fIattribute\fP. The default is not
149 to sort entries returned. If \fIattribute\fP is a zero-length string (""),
150 the entries are sorted by the components of their Distinguished Name. See
152 for more details. Note that
154 normally prints out entries as it receives them. The use of the
156 option defeats this behavior, causing all entries to be retrieved,
157 then sorted, then printed.
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 a series of lines from \fIfile\fP, performing one LDAP search for
166 each line. In this case, the \fIfilter\fP given on the command line
167 is treated as a pattern where the first occurrence of \fB%s\fP is
168 replaced with a line from \fIfile\fP. If \fIfile\fP is a single \fI-\fP
169 character, then the lines are read from standard input.
172 Use simple authentication instead of SASL.
175 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
178 Prompt for simple authentication.
179 This is used instead of specifying the password on the command line.
182 Use \fIpasswd\fP as the password for simple authentication.
185 Use complete contents of \fIpasswdfile\fP as the password for
186 simple authentication.
189 Specify URI(s) referring to the ldap server(s); only the protocol/host/port
190 fields are allowed; a list of URI, separated by whitespace or commas
194 Specify an alternate host on which the ldap server is running.
195 Deprecated in favor of -H.
198 Specify an alternate TCP port where the ldap server is listening.
199 Deprecated in favor of -H.
202 Use \fIsearchbase\fP as the starting point for the search instead of
205 .BI \-s \ base\fR\||\|\fIone\fR\||\|\fIsub\fR\||\|\fIchildren
206 Specify the scope of the search to be one of
212 to specify a base object, one-level, subtree, or children search.
217 scope requires LDAPv3 subordinate feature extension.
219 .BI \-a \ never\fR\||\|\fIalways\fR\||\|\fIsearch\fR\||\|\fIfind
220 Specify how aliases dereferencing is done. Should be one of
226 to specify that aliases are never dereferenced, always dereferenced,
227 dereferenced when searching, or dereferenced only when locating the
228 base object for the search. The default is to never dereference aliases.
230 .BI \-P \ 2\fR\||\|\fI3
231 Specify the LDAP protocol version to use.
233 .B \-e \fI[!]ext[=extparam]\fP
235 .B \-E \fI[!]ext[=extparam]\fP
237 Specify general extensions with -e and search extensions with -E.
238 \'!\' indicates criticality.
242 [!]assert=<filter> (an RFC 4515 Filter)
243 [!]authzid=<authzid> ("dn:<dn>" or "u:<user>")
247 [!]postread[=<attrs>] (a comma-separated attribute list)
248 [!]preread[=<attrs>] (a comma-separated attribute list)
249 abandon, cancel (SIGINT sends abandon/cancel; not really controls)
254 [!]domainScope (domain scope)
255 [!]mv=<filter> (matched values filter)
256 [!]pr=<size>[/prompt|noprompt] (paged results/prompt)
257 [!]subentries[=true|false] (subentries)
258 [!]sync=ro[/<cookie>] (LDAP Sync refreshOnly)
259 rp[/<cookie>][/<slimit>] (LDAP Sync refreshAndPersist)
263 wait at most \fItimelimit\fP seconds for a search to complete.
271 means the maximum integer allowable by the protocol.
272 A server may impose a maximal timelimit which only
273 the root user may override.
276 retrieve at most \fIsizelimit\fP entries for a search.
284 means the maximum integer allowable by the protocol.
285 A server may impose a maximal sizelimit which only
286 the root user may override.
288 .BI \-O \ security-properties
289 Specify SASL security properties.
292 Enable SASL Interactive mode. Always prompt. Default is to prompt
296 Enable SASL Quiet mode. Never prompt.
299 Specify the authentication ID for SASL bind. The form of the ID
300 depends on the actual SASL mechanism used.
303 Specify the realm of authentication ID for SASL bind. The form of the realm
304 depends on the actual SASL mechanism used.
307 Specify the requested authorization ID for SASL bind.
309 must be one of the following formats:
311 .I <distinguished name>
317 Specify the SASL mechanism to be used for authentication. If it's not
318 specified, the program will choose the best mechanism the server knows.
321 Issue StartTLS (Transport Layer Security) extended operation. If you use
323 , the command will require the operation to be successful.
325 If one or more entries are found, each entry is written to standard
326 output in LDAP Data Interchange Format or
332 # bjensen, example, net
333 dn: uid=bjensen,dc=example,dc=net
335 objectClass: dcObject
342 If the -t option is used, the URI of a temporary file
343 is used in place of the actual value. If the -A option
344 is given, only the "attributename" part is written.
346 The following command:
349 ldapsearch -LLL "(sn=smith)" cn sn telephoneNumber
352 will perform a subtree search (using the default search base and
353 other parameters defined in
355 for entries with a surname (sn) of smith. The common name (cn), surname
356 (sn) and telephoneNumber values will be retrieved and printed to
358 The output might look something like this if two entries are found:
361 dn: uid=jts,dc=example,dc=com
367 telephoneNumber: 1 555 123-4567
369 dn: uid=sss,dc=example,dc=com
375 telephoneNumber: 1 555 765-4321
381 ldapsearch -LLL -u -t "(uid=xyz)" jpegPhoto audio
384 will perform a subtree search using the default search base for entries
385 with user id of "xyz". The user friendly form of the entry's DN will be
386 output after the line that contains the DN itself, and the jpegPhoto
387 and audio values will be retrieved and written to temporary files. The
388 output might look like this if one entry with one value for each of the
389 requested attributes is found:
392 dn: uid=xyz,dc=example,dc=com
393 ufn: xyz, example, com
394 audio:< file:///tmp/ldapsearch-audio-a19924
395 jpegPhoto:< file:///tmp/ldapsearch-jpegPhoto-a19924
401 ldapsearch -LLL -s one -b "c=US" "(o=University*)" o description
404 will perform a one-level search at the c=US level for all entries
405 whose organization name (o) begins begins with \fBUniversity\fP.
406 The organization name and description attribute values will be retrieved
407 and printed to standard output, resulting in output similar to this:
410 dn: o=University of Alaska Fairbanks,c=US
411 o: University of Alaska Fairbanks
412 description: Preparing Alaska for a brave new yesterday
413 description: leaf node only
415 dn: o=University of Colorado at Boulder,c=US
416 o: University of Colorado at Boulder
417 description: No personnel information
418 description: Institution of education and research
420 dn: o=University of Colorado at Denver,c=US
421 o: University of Colorado at Denver
425 description: Institute for Higher Learning and Research
427 dn: o=University of Florida,c=US
428 o: University of Florida
430 description: Warper of young minds
435 Exit status is zero if no errors occur.
436 Errors result in a non-zero exit status and
437 a diagnostic message being written to standard error.
446 .BR ldap_search_ext (3),
449 The OpenLDAP Project <http://www.openldap.org/>