1 .TH LDAPSEARCH 1 "RELEASEDATE" "OpenLDAP LDVERSION"
3 .\" Copyright 1998-2005 The OpenLDAP Foundation All Rights Reserved.
4 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 ldapsearch \- LDAP search tool
24 .BI \-d \ debuglevel\fR]
34 .BI \-y \ passwdfile\fR]
38 .BI \-h \ ldaphost\fR]
40 .BI \-p \ ldapport\fR]
42 .BI \-P \ 2\fR\||\|\fI3\fR]
44 .BI \-b \ searchbase\fR]
46 .BI \-s \ base\fR\||\|\fIone\fR\||\|\fIsub\fR\||\|\fIchildren\fR]
48 .BI \-a \ never\fR\||\|\fIalways\fR\||\|\fIsearch\fR\||\|\fIfind\fR]
50 .BI \-l \ timelimit\fR]
52 .BI \-z \ sizelimit\fR]
54 .BR \-O \ security-properties ]
76 is a shell-accessible interface to the
81 opens a connection to an LDAP server, binds, and performs a search
82 using specified parameters. The \fIfilter\fP should conform to
83 the string representation for search filters as defined in RFC 2254.
84 If not provided, the default filter, (objectClass=*), is used.
87 .B ldapsearch finds one or more entries, the attributes specified by
88 \fIattrs\fP are returned. If * is listed, all user attributes are
89 returned. If + is listed, all operational attributes are returned.
90 If no \fIattrs\fP are listed, all user attributes are returned. If only
91 1.1 is listed, no attributes will be returned.
95 Show what would be done, but don't actually perform the search. Useful for
96 debugging in conjunction with -v.
99 Include the User Friendly Name form of the Distinguished Name (DN)
103 Run in verbose mode, with many diagnostics written to standard output.
106 Write retrieved non-printable values to a set of temporary files. This
107 is useful for dealing with values containing non-character data such as
111 Retrieve attributes only (no values). This is useful when you just want to
112 see if an attribute is present in an entry and are not interested in the
116 Search results are display in LDAP Data Interchange Format detailed in
118 A single -L restricts the output to LDIFv1.
119 A second -L disables comments.
120 A third -L disables printing of the LDIF version.
121 The default is to use an extended version of LDIF.
124 Enable manage DSA IT control.
126 makes control critical.
129 Sort the entries returned based on \fIattribute\fP. The default is not
130 to sort entries returned. If \fIattribute\fP is a zero-length string (""),
131 the entries are sorted by the components of their Distinguished Name. See
133 for more details. Note that
135 normally prints out entries as it receives them. The use of the
137 option defeats this behavior, causing all entries to be retrieved,
138 then sorted, then printed.
141 Set the LDAP debugging level to \fIdebuglevel\fP.
143 must be compiled with LDAP_DEBUG defined for this option to have any effect.
146 Read a series of lines from \fIfile\fP, performing one LDAP search for
147 each line. In this case, the \fIfilter\fP given on the command line
148 is treated as a pattern where the first occurrence of \fB%s\fP is
149 replaced with a line from \fIfile\fP. If \fIfile\fP is a single \fI-\fP
150 character, then the lines are read from standard input.
153 Use simple authentication instead of SASL.
156 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
159 Prompt for simple authentication.
160 This is used instead of specifying the password on the command line.
163 Use \fIpasswd\fP as the password for simple authentication.
166 Use complete contents of \fIpasswdfile\fP as the password for
167 simple authentication.
170 Specify URI(s) referring to the ldap server(s); only the protocol/host/port
171 fields are allowed; a list of URI, separated by whitespace or commas
175 Specify an alternate host on which the ldap server is running.
176 Deprecated in favor of -H.
179 Specify an alternate TCP port where the ldap server is listening.
180 Deprecated in favor of -H.
183 Use \fIsearchbase\fP as the starting point for the search instead of
186 .BI \-s \ base\fR\||\|\fIone\fR\||\|\fIsub\fR\||\|\fIchildren
187 Specify the scope of the search to be one of
193 to specify a base object, one-level, subtree, or children search.
198 scope requires LDAPv3 subordinate feature extension.
200 .BI \-a \ never\fR\||\|\fIalways\fR\||\|\fIsearch\fR\||\|\fIfind
201 Specify how aliases dereferencing is done. Should be one of
207 to specify that aliases are never dereferenced, always dereferenced,
208 dereferenced when searching, or dereferenced only when locating the
209 base object for the search. The default is to never dereference aliases.
211 .BI \-P \ 2\fR\||\|\fI3
212 Specify the LDAP protocol version to use.
215 wait at most \fItimelimit\fP seconds for a search to complete.
223 means the maximum integer allowable by the protocol.
224 A server may impose a maximal timelimit which only
225 the root user may override.
228 retrieve at most \fIsizelimit\fP entries for a search.
236 means the maximum integer allowable by the protocol.
237 A server may impose a maximal sizelimit which only
238 the root user may override.
240 .BI \-O \ security-properties
241 Specify SASL security properties.
244 Enable SASL Interactive mode. Always prompt. Default is to prompt
248 Enable SASL Quiet mode. Never prompt.
251 Specify the authentication ID for SASL bind. The form of the ID
252 depends on the actual SASL mechanism used.
255 Specify the realm of authentication ID for SASL bind. The form of the realm
256 depends on the actual SASL mechanism used.
259 Specify the requested authorization ID for SASL bind.
261 must be one of the following formats:
263 .I <distinguished name>
269 Specify the SASL mechanism to be used for authentication. If it's not
270 specified, the program will choose the best mechanism the server knows.
273 Issue StartTLS (Transport Layer Security) extended operation. If you use
275 , the command will require the operation to be successful.
277 If one or more entries are found, each entry is written to standard
278 output in LDAP Data Interchange Format or
284 # bjensen, example, net
285 dn: uid=bjensen,dc=example,dc=net
287 objectClass: dcObject
294 If the -t option is used, the URI of a temporary file
295 is used in place of the actual value. If the -A option
296 is given, only the "attributename" part is written.
298 The following command:
301 ldapsearch -LLL "(sn=smith)" cn sn telephoneNumber
304 will perform a subtree search (using the default search base and
305 other parameters defined in
307 for entries with a surname (sn) of smith. The common name (cn), surname
308 (sn) and telephoneNumber values will be retrieved and printed to
310 The output might look something like this if two entries are found:
313 dn: uid=jts,dc=example,dc=com
319 telephoneNumber: 1 555 123-4567
321 dn: uid=sss,dc=example,dc=com
327 telephoneNumber: 1 555 765-4321
333 ldapsearch -LLL -u -t "(uid=xyz)" jpegPhoto audio
336 will perform a subtree search using the default search base for entries
337 with user id of "xyz". The user friendly form of the entry's DN will be
338 output after the line that contains the DN itself, and the jpegPhoto
339 and audio values will be retrieved and written to temporary files. The
340 output might look like this if one entry with one value for each of the
341 requested attributes is found:
344 dn: uid=xyz,dc=example,dc=com
345 ufn: xyz, example, com
346 audio:< file:///tmp/ldapsearch-audio-a19924
347 jpegPhoto:< file:///tmp/ldapsearch-jpegPhoto-a19924
353 ldapsearch -LLL -s one -b "c=US" "(o=University*)" o description
356 will perform a one-level search at the c=US level for all entries
357 whose organization name (o) begins begins with \fBUniversity\fP.
358 The organization name and description attribute values will be retrieved
359 and printed to standard output, resulting in output similar to this:
362 dn: o=University of Alaska Fairbanks,c=US
363 o: University of Alaska Fairbanks
364 description: Preparing Alaska for a brave new yesterday
365 description: leaf node only
367 dn: o=University of Colorado at Boulder,c=US
368 o: University of Colorado at Boulder
369 description: No personnel information
370 description: Institution of education and research
372 dn: o=University of Colorado at Denver,c=US
373 o: University of Colorado at Denver
377 description: Institute for Higher Learning and Research
379 dn: o=University of Florida,c=US
380 o: University of Florida
382 description: Warper of young minds
387 Exit status is zero if no errors occur.
388 Errors result in a non-zero exit status and
389 a diagnostic message being written to standard error.
400 The OpenLDAP Project <http://www.openldap.org/>
403 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
405 is derived from University of Michigan LDAP 3.3 Release.