1 .TH LDAPSEARCH 1 "RELEASEDATE" "OpenLDAP LDVERSION"
3 .\" Copyright 1998-2002 The OpenLDAP Foundation All Rights Reserved.
4 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 ldapsearch \- LDAP search tool
30 .BI \-d \ debuglevel\fR]
40 .BI \-y \ passwdfile\fR]
44 .BI \-h \ ldaphost\fR]
46 .BI \-p \ ldapport\fR]
48 .BI \-P \ 2\fR\||\|\fI3\fR]
50 .BI \-b \ searchbase\fR]
52 .BI \-s \ base\fR\||\|\fIone\fR\||\|\fIsub\fR]
54 .BI \-a \ never\fR\||\|\fIalways\fR\||\|\fIsearch\fR\||\|\fIfind\fR]
56 .BI \-l \ timelimit\fR]
58 .BI \-z \ sizelimit\fR]
60 .BR \-O \ security-properties ]
80 is a shell-accessible interface to the
85 opens a connection to an LDAP server, binds, and performs a search
86 using specified parameters. The \fIfilter\fP should conform to
87 the string representation for search filters as defined in RFC 2254.
88 If not provided, the default filter, (objectClass=*), is used.
91 .B ldapsearch finds one or more entries, the attributes specified by
92 \fIattrs\fP are returned. If * is listed, all user attributes are
93 returned. If + is listed, all operational attributes are returned.
94 If no \fIattrs\fP are listed, all user attributes are returned. If only
95 1.1 is listed, no attributes will be returned.
99 Show what would be done, but don't actually perform the search. Useful for
100 debugging in conjunction with -v.
103 Include the User Friendly Name form of the Distinguished Name (DN)
107 Run in verbose mode, with many diagnostics written to standard output.
110 Use Kerberos IV authentication instead of simple authentication. It is
111 assumed that you already have a valid ticket granting ticket.
113 must be compiled with Kerberos support for this option to have any effect.
116 Same as \-k, but only does step 1 of the Kerberos IV bind. This is useful
117 when connecting to a slapd and there is no x500dsa.hostname principal
118 registered with your Kerberos Domain Controller(s).
121 Write retrieved values to a set of temporary files. This is useful for
122 dealing with non-ASCII values such as jpegPhoto or audio.
125 Retrieve attributes only (no values). This is useful when you just want to
126 see if an attribute is present in an entry and are not interested in the
130 Search results are display in LDAP Data Interchange Format detailed in
132 A single -L restricts the output to LDIFv1.
133 A second -L disables comments.
134 A third -L disables printing of the LDIF version.
135 The default is to use an extended version of LDIF.
138 Enable manage DSA IT control.
140 makes control critical.
143 Automatically chase referrals.
146 Sort the entries returned based on \fIattribute\fP. The default is not
147 to sort entries returned. If \fIattribute\fP is a zero-length string (""),
148 the entries are sorted by the components of their Distingished Name. See
150 for more details. Note that
152 normally prints out entries as it receives them. The use of the
154 option defeats this behavior, causing all entries to be retrieved,
155 then sorted, then printed.
158 Set the LDAP debugging level to \fIdebuglevel\fP.
160 must be compiled with LDAP_DEBUG defined for this option to have any effect.
163 Read a series of lines from \fIfile\fP, performing one LDAP search for
164 each line. In this case, the \fIfilter\fP given on the command line
165 is treated as a pattern where the first occurrence of \fB%s\fP is
166 replaced with a line from \fIfile\fP. If \fIfile\fP is a single \fI-\fP
167 character, then the lines are read from standard input.
170 Use simple authentication instead of SASL.
173 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
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).
190 Specify an alternate host on which the ldap server is running.
191 Deprecated in favor of -H.
194 Specify an alternate TCP port where the ldap server is listening.
195 Deprecated in favor of -H.
198 Use \fIsearchbase\fP as the starting point for the search instead of
201 .BI \-s \ base\fR\||\|\fIone\fR\||\|\fIsub
202 Specify the scope of the search to be one of
207 to specify a base object, one-level, or subtree search. The default
211 .BI \-a \ never\fR\||\|\fIalways\fR\||\|\fIsearch\fR\||\|\fIfind
212 Specify how aliases dereferencing is done. Should be one of
218 to specify that aliases are never dereferenced, always dereferenced,
219 dereferenced when searching, or dereferenced only when locating the
220 base object for the search. The default is to never dereference aliases.
222 .BI \-P \ 2\fR\||\|\fI3
223 Specify the LDAP protocol version to use.
226 wait at most \fItimelimit\fP seconds for a search to complete. A
232 A server may impose a maximal timelimit which only
233 the root user may override.
236 retrieve at most \fIsizelimit\fP entries for a search. A sizelimit
242 A server may impose a maximal sizelimit which only
243 the root user may override.
245 .BI \-O \ security-properties
246 Specify SASL security properties.
249 Enable SASL Interactive mode. Always prompt. Default is to prompt
253 Enable SASL Quiet mode. Never prompt.
256 Specify the authentication ID for SASL bind. The form of the ID
257 depends on the actual SASL mechanism used.
260 Specify the requested authorization ID for SASL bind.
262 must be one of the following formats:
264 .I <distinguished name>
270 Specify the SASL mechanism to be used for authentication. If it's not
271 specified, the program will choose the best mechanism the server knows.
274 Issue StartTLS (Transport Layer Security) extended operation. If you use
276 , the command will require the operation to be successful.
278 If one or more entries are found, each entry is written to standard
279 output in LDAP Data Interchange Format or
285 # bjensen, example, net
286 dn: uid=bjensen,dc=example,dc=net
288 objectClass: dcObject
295 If the -t option is used, the URI of a temporary file
296 is used in place of the actual value. If the -A option
297 is given, only the "attributename" part is written.
299 The following command:
302 ldapsearch -LLL "(sn=smith)" cn sn telephoneNumber
305 will perform a subtree search (using the default search base defined
308 for entries with a surname (sn) of smith. The common name (cn), surname
309 (sn) and telephoneNumber values will be retrieved and printed to
311 The output might look something like this if two entries are found:
314 dn: uid=jts,dc=example,dc=com
320 telephoneNumber: 1 555 123-4567
322 dn: uid=sss,dc=example,dc=com
328 telephoneNumber: 1 555 765-4321
334 ldapsearch -LLL -u -t "(uid=xyz)" jpegPhoto audio
337 will perform a subtree search using the default search base for entries
338 with user id of "xyz". The user friendly form of the entry's DN will be
339 output after the line that contains the DN itself, and the jpegPhoto
340 and audio values will be retrieved and written to temporary files. The
341 output might look like this if one entry with one value for each of the
342 requested attributes is found:
345 dn: uid=xyz,dc=example,dc=com
346 ufn: xyz, example, com
347 audio:< file::/tmp/ldapsearch-audio-a19924
348 jpegPhoto:< file::=/tmp/ldapsearch-jpegPhoto-a19924
354 ldapsearch -LLL -s one -b "c=US" "(o=University*)" o description
357 will perform a one-level search at the c=US level for all entries
358 whose organization name (o) begins begins with \fBUniversity\fP.
359 The organization name and description attribute values will be retrieved
360 and printed to standard output, resulting in output similar to this:
363 dn: o=University of Alaska Fairbanks,c=US
364 o: University of Alaska Fairbanks
365 description: Preparing Alaska for a brave new yesterday
366 description: leaf node only
368 dn: o=University of Colorado at Boulder,c=US
369 o: University of Colorado at Boulder
370 description: No personnel information
371 description: Institution of education and research
373 dn: o=University of Colorado at Denver,c=US
374 o: University of Colorado at Denver
378 description: Institute for Higher Learning and Research
380 dn: o=University of Florida,c=US
381 o: University of Florida
383 description: Warper of young minds
388 Exit status is zero if no errors occur.
389 Errors result in a non-zero exit status and
390 a diagnostic message being written to standard error.
401 The OpenLDAP Project <http://www.openldap.org/>
404 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
406 is derived from University of Michigan LDAP 3.3 Release.