1 .TH LDAPSEARCH 1 "10 November 1998" "OpenLDAP LDVERSION"
3 ldapsearch \- ldap search tool
27 .BI \-d \ debuglevel\fR]
35 .BI \-w \ bindpasswd\fR]
37 .BI \-h \ ldaphost\fR]
39 .BI \-p \ ldapport\fR]
41 .BI \-b \ searchbase\fR]
43 .BI \-s \ base\fR\||\|\fIone\fR\||\|\fIsub\fR]
45 .BI \-a \ never\fR\||\|\fIalways\fR\||\|\fIsearch\fR\||\|\fIfind\fR]
47 .BI \-l \ timelimit\fR]
49 .BI \-z \ sizelimit\fR]
55 is a shell-accessible interface to the
60 opens a connection to an LDAP server, binds, and performs a search
61 using the filter \fIfilter\fP. The \fIfilter\fP should conform to
62 the string representation for LDAP filters as defined in RFC 1558.
66 finds one or more entries, the attributes specified by
67 \fIattrs\fP are retrieved and the entries and values are printed to
68 standard output. If no \fIattrs\fP are listed, all attributes are
73 Show what would be done, but don't actually perform the search. Useful for
74 debugging in conjunction with -v.
77 Include the User Friendly form of the Distinguished Name (DN) in the output
80 Run in verbose mode, with many diagnostics written to standard output
83 Use Kerberos authentication instead of simple authentication. It is
84 assumed that you already have a valid ticket granting ticket.
86 must be compiled with KERBEROS defined for this option to have any effect.
89 Same as \-k, but only does step 1 of the kerberos bind. This is useful
90 when connecting to a slapd and there is no x500dsa.hostname principal
91 registered with your kerberos servers.
94 Write retrieved values to a set of temporary files. This is useful for
95 dealing with non-ASCII values such as jpegPhoto or audio.
98 Retrieve attributes only (no values). This is useful when you just want to
99 see if an attribute is present in an entry and are not interested in the
103 Do not suppress display of non-ascii values. This is useful when
104 dealing with values that appear in alternate characters sets such as
105 ISO-8859.1. This option is implied by -L (see below).
108 Display search results in
110 format. This option also turns on the -B option, and causes the -F option
114 Do not automatically follow referrals returned while searching.
116 must be compiled with LDAP_REFERRALS defined for referrals to be
117 automatically followed by default, and for this option to have any effect.
120 Use \fIsep\fP as the field separator between attribute names and values.
121 The default separator is `=', unless the -L flag has been specified, in
122 which case this option is ignored.
125 Sort the entries returned based on \fIattribute\fP. The default is not
126 to sort entries returned. If \fIattribute\fP is a zero-length string (""),
127 the entries are sorted by the components of their Distingished Name. See
129 for more details. Note that
131 normally prints out entries as it receives them. The use of the
133 option defeats this behavior, causing all entries to be retrieved,
134 then sorted, then printed.
137 Set the LDAP debugging level to \fIdebuglevel\fP.
139 must be compiled with LDAP_DEBUG defined for this option to have any effect.
142 Read a series of lines from \fIfile\fP, performing one LDAP search for
143 each line. In this case, the \fIfilter\fP given on the command line
144 is treated as a pattern where the first occurrence of \fB%s\fP is
145 replaced with a line from \fIfile\fP. If \fIfile\fP is a single \fI-\fP
146 character, then the lines are read from standard input.
149 Use \fIbinddn\fP to bind to the LDAP directory. \fIbinddn\fP should be
150 a string-represented DN as defined in RFC 1779.
153 Use \fIbindpasswd\fP as the password for simple authentication.
156 Specify an alternate host on which the ldap server is running.
159 Specify an alternate TCP port where the ldap server is listening.
162 Use \fIsearchbase\fP as the starting point for the search instead of
165 .BI \-s \ base\fR\||\|\fIone\fR\||\|\fIsub
166 Specify the scope of the search to be one of
171 to specify a base object, one-level, or subtree search. The default
175 .BI \-a \ never\fR\||\|\fIalways\fR\||\|\fIsearch\fR\||\|\fIfind
176 Specify how aliases dereferencing is done. Should be one of
182 to specify that aliases are never dereferenced, always dereferenced,
183 dereferenced when searching, or dereferenced only when locating the
184 base object for the search. The default is to never dereference aliases.
187 wait at most \fItimelimit\fP seconds for a search to complete.
190 retrieve at most \fIsizelimit\fP entries for a search.
192 If one or more entries are found, each entry is written to standard output
196 Distinguished Name (DN)
197 User Friendly Name (this line present only if the -u option is used)
204 Multiple entries are separated with a single blank line. If the -F option
205 is used to specify a separator character, it will be used instead of the
206 `=' character. If the -t option is used, the name of a temporary file
207 is used in place of the actual value. If the -A option
208 is given, only the "attributename" part is written.
210 The following command:
213 ldapsearch "cn=mark smith" cn telephoneNumber
216 will perform a subtree search (using the default search base) for entries
217 with a commonName of "mark smith". The commonName and telephoneNumber
218 values will be retrieved and printed to standard output.
219 The output might look something like this if two entries are found:
222 cn=Mark D Smith, ou="College of Literature, Science, and the Arts", ou=Students, ou=People, o=University of Michigan, c=US
227 telephoneNumber=+1 313 930-9489
229 cn=Mark C Smith, ou=Information Technology Division, ou=Faculty and Staff, ou=People, o=University of Michigan, c=US
233 telephoneNumber=+1 313 764-2277
239 ldapsearch -u -t "uid=mcs" jpegPhoto audio
242 will perform a subtree search using the default search base for entries
243 with user id of "mcs". The user friendly form of the entry's DN will be
244 output after the line that contains the DN itself, and the jpegPhoto
245 and audio values will be retrieved and written to temporary files. The
246 output might look like this if one entry with one value for each of the
247 requested attributes is found:
250 cn=Mark C Smith, ou=Information Technology Division, ou=Faculty and Staff, ou=People, o=University of Michigan, c=US
251 Mark C Smith, Information Technology Division, Faculty and Staff, People, University of Michigan, US
252 audio=/tmp/ldapsearch-audio-a19924
253 jpegPhoto=/tmp/ldapsearch-jpegPhoto-a19924
259 ldapsearch -L -s one -b "c=US" "o=university*" o description
262 will perform a one-level search at the c=US level for all organizations
263 whose organizationName begins with \fBuniversity\fP. Search results
264 will be displayed in the LDIF format.
265 The organizationName and description attribute values will be retrieved
266 and printed to standard output, resulting in output similar to this:
269 dn: o=University of Alaska Fairbanks, c=US
270 o: University of Alaska Fairbanks
271 description: Preparing Alaska for a brave new yesterday
272 description: leaf node only
274 dn: o=University of Colorado at Boulder, c=US
275 o: University of Colorado at Boulder
276 description: No personnel information
277 description: Institution of education and research
279 dn: o=University of Colorado at Denver, c=US
280 o: University of Colorado at Denver
284 description: Institute for Higher Learning and Research
286 dn: o=University of Florida, c=US
287 o: University of Florida
289 description: Warper of young minds
294 Exit status is 0 if no errors occur. Errors result in a non-zero exit
295 status and a diagnostic message being written to standard error.
306 .IR "A String Representation of Distinguished Names",
309 ISODE Consortium, March 1995.
312 .IR "A String Representation of LDAP Search Filters",
315 University of Michigan, December 1993.
318 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
320 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob