git.sur5r.net Git - openldap/blob - doc/man/man1/ldapsearch.1

   1 .TH LDAPSEARCH 1 "3 October 2000" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2000 The OpenLDAP Foundation All Rights Reserved.
   4 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   5 .SH NAME
   6 ldapsearch \- LDAP search tool
   7 .SH SYNOPSIS
   8 .B ldapsearch
   9 [\c
  10 .BR \-n ]
  11 [\c
  12 .BR \-u ]
  13 [\c
  14 .BR \-v ]
  15 [\c
  16 .BR \-k ]
  17 [\c
  18 .BR \-K ]
  19 [\c
  20 .BR \-t ]
  21 [\c
  22 .BR \-A ]
  23 [\c
  24 .BR \-C ]
  25 [\c
  26 .BR \-L[L[L]] ]
  27 [\c
  28 .BR \-M[M] ]
  29 [\c
  30 .BI \-d \ debuglevel\fR]
  31 [\c
  32 .BI \-f \ file\fR]
  33 [\c
  34 .BI \-D \ binddn\fR]
  35 [\c
  36 .BR \-W ]
  37 [\c
  38 .BI \-w \ bindpasswd\fR]
  39 [\c
  40 .BI \-H \ ldapuri\fR]
  41 [\c
  42 .BI \-h \ ldaphost\fR]
  43 [\c
  44 .BI \-p \ ldapport\fR]
  45 [\c
  46 .BI \-P \ 2\fR\||\|\fI3\fR]
  47 [\c
  48 .BI \-b \ searchbase\fR]
  49 [\c
  50 .BI \-s \ base\fR\||\|\fIone\fR\||\|\fIsub\fR]
  51 [\c
  52 .BI \-a \ never\fR\||\|\fIalways\fR\||\|\fIsearch\fR\||\|\fIfind\fR]
  53 [\c
  54 .BI \-l \ timelimit\fR]
  55 [\c
  56 .BI \-z \ sizelimit\fR]
  57 [\c
  58 .BR \-O \ security-properties ]
  59 [\c
  60 .BR \-I ]
  61 [\c
  62 .BR \-Q ]
  63 [\c
  64 .BI \-U \ username\fR]
  65 [\c
  66 .BR \-x ]
  67 [\c
  68 .BI \-X \ authzid\fR]
  69 [\c
  70 .BI \-Y \ mech\fR]
  71 [\c
  72 .BR \-Z[Z] ]
  73 .I filter
  74 [\c
  75 .IR attrs... ]
  76 .SH DESCRIPTION
  77 .I ldapsearch
  78 is a shell-accessible interface to the
  79 .BR ldap_search (3)
  80 library call.
  81 .LP
  82 .B ldapsearch
  83 opens a connection to an LDAP server, binds, and performs a search
  84 using specified parameters.   The \fIfilter\fP should conform to
  85 the string representation for search filters as defined in RFC 2254.
  86 If not provided, the default filter, (objectClass=*), is used.
  87 .LP
  88 If
  89 .B ldapsearch finds one or more entries, the attributes specified by
  90 \fIattrs\fP are returned.  If * is listed, all user attributes are
  91 returned.  If + is listed, all operational attributes are returned.
  92 If no \fIattrs\fP are listed, all attributes are returned.  If only
  93 1.1 is listed, no attributes will be returned.
  94 .SH OPTIONS
  95 .TP
  96 .B \-n
  97 Show what would be done, but don't actually perform the search.  Useful for
  98 debugging in conjunction with -v.
  99 .TP
 100 .B \-u
 101 Include the User Friendly Name form of the Distinguished Name (DN)
 102 in the output.
 103 .TP
 104 .B \-v
 105 Run in verbose mode, with many diagnostics written to standard output.
 106 .TP
 107 .B \-k
 108 Use Kerberos authentication instead of simple authentication.  It is
 109 assumed that you already have a valid ticket granting ticket.
 110 .B ldapsearch
 111 must be compiled with Kerberos support for this option to have any effect.
 112 .TP
 113 .B \-K
 114 Same as \-k, but only does step 1 of the Kerberos bind.  This is useful
 115 when connecting to a slapd and there is no x500dsa.hostname principal
 116 registered with your Kerberos servers.
 117 .TP
 118 .B \-t
 119 Write retrieved values to a set of temporary files.  This is useful for
 120 dealing with non-ASCII values such as jpegPhoto or audio.
 121 .TP
 122 .B \-A
 123 Retrieve attributes only (no values).  This is useful when you just want to
 124 see if an attribute is present in an entry and are not interested in the
 125 specific values.
 126 .TP
 127 .B \-L
 128 Search results are display in LDAP Data Interchange Format detailed in
 129 .BR ldif (5).
 130 A single -L restricts the output to LDIFv1.
 131 A second -L disables comments.
 132 A third -L disables printing of the LDIF version.
 133 The default is to use an extended version of LDIF.
 134 .TP
 135 .B \-M[M]
 136 Enable manage DSA IT control.
 137 .B \-MM
 138 makes control critical.
 139 .TP
 140 .B \-C
 141 Automatically chase referrals.
 142 .TP
 143 .BI \-S \ attribute
 144 Sort the entries returned based on \fIattribute\fP. The default is not
 145 to sort entries returned.  If \fIattribute\fP is a zero-length string (""),
 146 the entries are sorted by the components of their Distingished Name.  See
 147 .BR ldap_sort (3)
 148 for more details. Note that
 149 .B ldapsearch
 150 normally prints out entries as it receives them. The use of the
 151 .B \-S
 152 option defeats this behavior, causing all entries to be retrieved,
 153 then sorted, then printed.
 154 .TP
 155 .BI \-d \ debuglevel
 156 Set the LDAP debugging level to \fIdebuglevel\fP.
 157 .B ldapsearch
 158 must be compiled with LDAP_DEBUG defined for this option to have any effect.
 159 .TP
 160 .BI \-f \ file
 161 Read a series of lines from \fIfile\fP, performing one LDAP search for
 162 each line.  In this case, the \fIfilter\fP given on the command line
 163 is treated as a pattern where the first occurrence of \fB%s\fP is
 164 replaced with a line from \fIfile\fP.  If \fIfile\fP is a single \fI-\fP
 165 character, then the lines are read from standard input.
 166 .TP
 167 .B \-x
 168 Use simple authentication instead of SASL.
 169 .TP
 170 .BI \-D \ binddn
 171 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
 172 .TP
 173 .B \-W
 174 Prompt for simple authentication.
 175 This is used instead of specifying the password on the command line.
 176 .TP
 177 .BI \-w \ bindpasswd
 178 Use \fIbindpasswd\fP as the password for simple authentication.
 179 .TP
 180 .BI \-H \ ldapuri
 181 Specify URI(s) referring to the ldap server(s).
 182 .TP
 183 .BI \-h \ ldaphost
 184 Specify an alternate host on which the ldap server is running.
 185 Deprecated in favor of -H.
 186 .TP
 187 .BI \-p \ ldapport
 188 Specify an alternate TCP port where the ldap server is listening.
 189 Deprecated in favor of -H.
 190 .TP
 191 .BI \-b \ searchbase
 192 Use \fIsearchbase\fP as the starting point for the search instead of
 193 the default.
 194 .TP
 195 .BI \-s \ base\fR\||\|\fIone\fR\||\|\fIsub
 196 Specify the scope of the search to be one of
 197 .IR base ,
 198 .IR one ,
 199 or
 200 .I sub
 201 to specify a base object, one-level, or subtree search.  The default
 202 is
 203 .IR sub .
 204 .TP
 205 .BI \-a \ never\fR\||\|\fIalways\fR\||\|\fIsearch\fR\||\|\fIfind
 206 Specify how aliases dereferencing is done.  Should be one of
 207 .IR never ,
 208 .IR always ,
 209 .IR search ,
 210 or
 211 .I find
 212 to specify that aliases are never dereferenced, always dereferenced,
 213 dereferenced when searching, or dereferenced only when locating the
 214 base object for the search.  The default is to never dereference aliases.
 215 .TP
 216 .BI \-P \ 2\fR\||\|\fI3
 217 Specify the LDAP protocol version to use.
 218 .TP
 219 .BI \-l \ timelimit
 220 wait at most \fItimelimit\fP seconds for a search to complete.  A
 221 timelimit of
 222 .I 0
 223 (zero) removes the
 224 .B ldap.conf
 225 limit.
 226 A server may impose a maximal timelimit which only
 227 the root user may override.
 228 .TP
 229 .BI \-z \ sizelimit
 230 retrieve at most \fIsizelimit\fP entries for a search.  A sizelimit
 231 of
 232 .I 0
 233 (zero) removes the
 234 .B ldap.conf
 235 limit.
 236 A server may impose a maximal sizelimit which only
 237 the root user may override.
 238 .TP
 239 .BI \-O \ security-properties
 240 Specify SASL security properties.
 241 .TP
 242 .B \-I
 243 Enable SASL Interactive mode.  Always prompt.  Default is to prompt
 244 only as needed.
 245 .TP
 246 .B \-Q
 247 Enable SASL Quiet mode.  Never prompt.
 248 .TP
 249 .BI \-U \ username
 250 Specify the username for SASL bind. The syntax of the username depends on the
 251 actual SASL mechanism used.
 252 .TP
 253 .TP
 254 .BI \-X \ authzid
 255 Specify the requested authorization ID for SASL bind.
 256 .I authzid
 257 must be one of the following formats:
 258 .B dn:\c
 259 .I <distinguished name>
 260 or
 261 .B u:\c
 262 .I <username>
 263 .TP
 264 .BI \-Y \ mech
 265 Specify the SASL mechanism to be used for authentication. If it's not
 266 specified, the program will choose the best mechanism the server knows.
 267 .TP
 268 .B \-Z[Z]
 269 Issue StartTLS (Transport Layer Security) extended operation. If you use
 270 .B \-ZZ\c
 271 , the command will require the operation to be successful.
 272 .SH OUTPUT FORMAT
 273 If one or more entries are found, each entry is written to standard
 274 output in LDAP Data Interchange Format or
 275 .BR ldif (5):
 276 .LP
 277 .nf
 278         version: 1
 279
 280         # bjensen, example, net
 281         dn: uid=bjensen, dc=example, dc=net
 282         objectClass: person
 283         objectClass: dcObject
 284         uid: bjensen
 285         cn: Barbara Jensen
 286         sn: Jensen
 287     ...
 288 .fi
 289 .LP
 290 If the -t option is used, the URI of a temporary file
 291 is used in place of the actual value.  If the -A option
 292 is given, only the "attributename" part is written.
 293 .SH EXAMPLE
 294 The following command:
 295 .LP
 296 .nf
 297     ldapsearch -LLL "(sn=smith)" cn sn telephoneNumber
 298 .fi
 299 .LP
 300 will perform a subtree search (using the default search base defined
 301 in
 302 .BR ldap.conf (5))
 303 for entries with a surname (sn) of smith.  The common name (cn), surname
 304 (sn) and telephoneNumber values will be retrieved and printed to
 305 standard output.
 306 The output might look something like this if two entries are found:
 307 .LP
 308 .nf
 309     dn: uid=jts, dc=example, dc=com
 310         cn: John Smith
 311         cn: John T. Smith
 312         sn: Smith
 313         sn;lang-en: Smith
 314         sn;lang-de: Schmidt
 315         telephoneNumber: 1 555 123-4567
 316
 317         dn: uid=sss, dc=example, dc=com
 318         cn: Steve Smith
 319         cn: Steve S. Smith
 320         sn: Smith
 321         sn;lang-en: Smith
 322         sn;lang-de: Schmidt
 323         telephoneNumber: 1 555 765-4321
 324 .fi
 325 .LP
 326 The command:
 327 .LP
 328 .nf
 329     ldapsearch -LLL -u -t "(uid=xyz)" jpegPhoto audio
 330 .fi
 331 .LP
 332 will perform a subtree search using the default search base for entries
 333 with user id of "xyz".  The user friendly form of the entry's DN will be
 334 output after the line that contains the DN itself, and the jpegPhoto
 335 and audio values will be retrieved and written to temporary files.  The
 336 output might look like this if one entry with one value for each of the
 337 requested attributes is found:
 338 .LP
 339 .nf
 340     dn: uid=xyz, dc=example, dc=com
 341     ufn: xyz, example, com
 342     audio:< file::/tmp/ldapsearch-audio-a19924
 343     jpegPhoto:< file::=/tmp/ldapsearch-jpegPhoto-a19924
 344 .fi
 345 .LP
 346 This command:
 347 .LP
 348 .nf
 349     ldapsearch -LLL -s one -b "c=US" "(o=University*)" o description
 350 .fi
 351 .LP
 352 will perform a one-level search at the c=US level for all entries
 353 whose organization name (o) begins begins with \fBUniversity\fP.
 354 The organization name and description attribute values will be retrieved
 355 and printed to standard output, resulting in output similar to this:
 356 .LP
 357 .nf
 358     dn: o=University of Alaska Fairbanks, c=US
 359     o: University of Alaska Fairbanks
 360     description: Preparing Alaska for a brave new yesterday
 361     description: leaf node only
 362
 363     dn: o=University of Colorado at Boulder, c=US
 364     o: University of Colorado at Boulder
 365     description: No personnel information
 366     description: Institution of education and research
 367
 368     dn: o=University of Colorado at Denver, c=US
 369     o: University of Colorado at Denver
 370     o: UCD
 371     o: CU/Denver
 372     o: CU-Denver
 373     description: Institute for Higher Learning and Research
 374
 375     dn: o=University of Florida, c=US
 376     o: University of Florida
 377     o: UFl
 378     description: Warper of young minds
 379
 380     etc....
 381 .fi
 382 .SH DIAGNOSTICS
 383 Exit status is zero if no errors occur.
 384 Errors result in a non-zero exit status and
 385 a diagnostic message being written to standard error.
 386 .SH "SEE ALSO"
 387 .BR ldapadd (1),
 388 .BR ldapdelete (1),
 389 .BR ldapmodify (1),
 390 .BR ldapmodrdn (1),
 391 .BR ldap.conf (5),
 392 .BR ldif (5),
 393 .BR ldap (3),
 394 .BR ldap_search (3)
 395 .SH AUTHOR
 396 The OpenLDAP Project <http://www.openldap.org/>
 397 .SH ACKNOWLEDGEMENTS
 398 .B      OpenLDAP
 399 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 400 .B      OpenLDAP
 401 is derived from University of Michigan LDAP 3.3 Release.