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

   1 .TH LDAPSEARCH 1 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2008 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 \-c ]
  13 [\c
  14 .BR \-u ]
  15 [\c
  16 .BR \-v ]
  17 [\c
  18 .BR \-t[t] ]
  19 [\c
  20 .BI \-T \ path\fR]
  21 [\c
  22 .BI \-F \ prefix\fR]
  23 [\c
  24 .BR \-A ]
  25 [\c
  26 .BR \-L[L[L]] ]
  27 [\c
  28 .BR \-M[M] ]
  29 [\c
  30 .BI \-S \ attribute\fR]
  31 [\c
  32 .BI \-d \ debuglevel\fR]
  33 [\c
  34 .BI \-f \ file\fR]
  35 [\c
  36 .BR \-x ]
  37 [\c
  38 .BI \-D \ binddn\fR]
  39 [\c
  40 .BR \-W ]
  41 [\c
  42 .BI \-w \ passwd\fR]
  43 [\c
  44 .BI \-y \ passwdfile\fR]
  45 [\c
  46 .BI \-H \ ldapuri\fR]
  47 [\c
  48 .BI \-h \ ldaphost\fR]
  49 [\c
  50 .BI \-p \ ldapport\fR]
  51 [\c
  52 .BI \-b \ searchbase\fR]
  53 [\c
  54 .BI \-s \ base\fR\||\|\fIone\fR\||\|\fIsub\fR\||\|\fIchildren\fR]
  55 [\c
  56 .BI \-a \ never\fR\||\|\fIalways\fR\||\|\fIsearch\fR\||\|\fIfind\fR]
  57 [\c
  58 .BI \-P \ 2\fR\||\|\fI3\fR]
  59 [\c
  60 .BR \-e \ [!]ext[=extparam]]
  61 [\c
  62 .BR \-E \ [!]ext[=extparam]]
  63 [\c
  64 .BI \-l \ timelimit\fR]
  65 [\c
  66 .BI \-z \ sizelimit\fR]
  67 [\c
  68 .BR \-O \ security-properties ]
  69 [\c
  70 .BR \-I ]
  71 [\c
  72 .BR \-Q ]
  73 [\c
  74 .BI \-U \ authcid\fR]
  75 [\c
  76 .BI \-R \ realm\fR]
  77 [\c
  78 .BI \-X \ authzid\fR]
  79 [\c
  80 .BI \-Y \ mech\fR]
  81 [\c
  82 .BR \-Z[Z] ]
  83 .I filter
  84 [\c
  85 .IR attrs... ]
  86 .SH DESCRIPTION
  87 .I ldapsearch
  88 is a shell-accessible interface to the
  89 .BR ldap_search_ext (3)
  90 library call.
  91 .LP
  92 .B ldapsearch
  93 opens a connection to an LDAP server, binds, and performs a search
  94 using specified parameters.   The \fIfilter\fP should conform to
  95 the string representation for search filters as defined in RFC 4515.
  96 If not provided, the default filter, (objectClass=*), is used.
  97 .LP
  98 If
  99 .B ldapsearch
 100 finds one or more entries, the attributes specified by
 101 \fIattrs\fP are returned.  If * is listed, all user attributes are
 102 returned.  If + is listed, all operational attributes are returned.
 103 If no \fIattrs\fP are listed, all user attributes are returned.  If only
 104 1.1 is listed, no attributes will be returned.
 105 .SH OPTIONS
 106 .TP
 107 .B \-n
 108 Show what would be done, but don't actually perform the search.  Useful for
 109 debugging in conjunction with -v.
 110 .TP
 111 .B \-c
 112 Continuous operation mode. Errors are reported, but ldapsearch will continue
 113 with searches. The default is to exit after reporting an error.  Only useful
 114 in conjunction with -f.
 115 .TP
 116 .B \-u
 117 Include the User Friendly Name form of the Distinguished Name (DN)
 118 in the output.
 119 .TP
 120 .B \-v
 121 Run in verbose mode, with many diagnostics written to standard output.
 122 .TP
 123 .B \-t[t]
 124 A single -t writes retrieved non-printable values to a set of temporary
 125 files.  This is useful for dealing with values containing non-character
 126 data such as jpegPhoto or audio. A second -t writes all retrieved values to
 127 files.
 128 .TP
 129 .BI \-T \ path
 130 Write temporary files to directory specified by \fIpath\fP (default:
 131 /var/tmp/)
 132 .TP
 133 .BI \-F \ prefix
 134 URL prefix for temporary files.  Default is file://\fIpath\fP/ where
 135 \fIpath\fP is /var/tmp/ or specified with -T.
 136 .TP
 137 .B \-A
 138 Retrieve attributes only (no values).  This is useful when you just want to
 139 see if an attribute is present in an entry and are not interested in the
 140 specific values.
 141 .TP
 142 .B \-L
 143 Search results are display in LDAP Data Interchange Format detailed in
 144 .BR ldif (5).
 145 A single -L restricts the output to LDIFv1.
 146 A second -L disables comments.
 147 A third -L disables printing of the LDIF version.
 148 The default is to use an extended version of LDIF.
 149 .TP
 150 .B \-M[M]
 151 Enable manage DSA IT control.
 152 .B \-MM
 153 makes control critical.
 154 .TP
 155 .BI \-S \ attribute
 156 Sort the entries returned based on \fIattribute\fP. The default is not
 157 to sort entries returned.  If \fIattribute\fP is a zero-length string (""),
 158 the entries are sorted by the components of their Distinguished Name.  See
 159 .BR ldap_sort (3)
 160 for more details. Note that
 161 .B ldapsearch
 162 normally prints out entries as it receives them. The use of the
 163 .B \-S
 164 option defeats this behavior, causing all entries to be retrieved,
 165 then sorted, then printed.
 166 .TP
 167 .BI \-d \ debuglevel
 168 Set the LDAP debugging level to \fIdebuglevel\fP.
 169 .B ldapsearch
 170 must be compiled with LDAP_DEBUG defined for this option to have any effect.
 171 .TP
 172 .BI \-f \ file
 173 Read a series of lines from \fIfile\fP, performing one LDAP search for
 174 each line.  In this case, the \fIfilter\fP given on the command line
 175 is treated as a pattern where the first and only occurrence of \fB%s\fP
 176 is replaced with a line from \fIfile\fP.  Any other occurrence of the
 177 the \fB%\fP character in the pattern will be regarded as an error.
 178 Where it is desired that the search filter include a \fB%\fP character,
 179 the character should be encoded as \fB\\25\fP (see RFC 4515).
 180 If \fIfile\fP is a single
 181 \fI-\fP character, then the lines are read from standard input.
 182 .B ldapsearch
 183 will exit when the first non-successful search result is returned,
 184 unless -c is used.
 185 .TP
 186 .B \-x
 187 Use simple authentication instead of SASL.
 188 .TP
 189 .BI \-D \ binddn
 190 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
 191 For SASL Binds, the server is expected to ignore this value.
 192 .TP
 193 .B \-W
 194 Prompt for simple authentication.
 195 This is used instead of specifying the password on the command line.
 196 .TP
 197 .BI \-w \ passwd
 198 Use \fIpasswd\fP as the password for simple authentication.
 199 .TP
 200 .BI \-y \ passwdfile
 201 Use complete contents of \fIpasswdfile\fP as the password for
 202 simple authentication.
 203 .TP
 204 .BI \-H \ ldapuri
 205 Specify URI(s) referring to the ldap server(s);
 206 a list of URI, separated by whitespace or commas is expected;
 207 only the protocol/host/port fields are allowed.
 208 As an exception, if no host/port is specified, but a DN is,
 209 the DN is used to look up the corresponding host(s) using the
 210 DNS SRV records, according to RFC 2782.  The DN must be a non-empty
 211 sequence of AVAs whose attribute type is "dc" (domain component),
 212 and must be escaped according to RFC 2396.
 213 .TP
 214 .BI \-h \ ldaphost
 215 Specify an alternate host on which the ldap server is running.
 216 Deprecated in favor of -H.
 217 .TP
 218 .BI \-p \ ldapport
 219 Specify an alternate TCP port where the ldap server is listening.
 220 Deprecated in favor of -H.
 221 .TP
 222 .BI \-b \ searchbase
 223 Use \fIsearchbase\fP as the starting point for the search instead of
 224 the default.
 225 .TP
 226 .BI \-s \ base\fR\||\|\fIone\fR\||\|\fIsub\fR\||\|\fIchildren
 227 Specify the scope of the search to be one of
 228 .IR base ,
 229 .IR one ,
 230 .IR sub ,
 231 or
 232 .I children
 233 to specify a base object, one-level, subtree, or children search.
 234 The default is
 235 .IR sub .
 236 Note:
 237 .I children
 238 scope requires LDAPv3 subordinate feature extension.
 239 .TP
 240 .BI \-a \ never\fR\||\|\fIalways\fR\||\|\fIsearch\fR\||\|\fIfind
 241 Specify how aliases dereferencing is done.  Should be one of
 242 .IR never ,
 243 .IR always ,
 244 .IR search ,
 245 or
 246 .I find
 247 to specify that aliases are never dereferenced, always dereferenced,
 248 dereferenced when searching, or dereferenced only when locating the
 249 base object for the search.  The default is to never dereference aliases.
 250 .TP
 251 .BI \-P \ 2\fR\||\|\fI3
 252 Specify the LDAP protocol version to use.
 253 .TP
 254 .B \-e \fI[!]ext[=extparam]\fP
 255 .TP
 256 .B \-E \fI[!]ext[=extparam]\fP
 257
 258 Specify general extensions with -e and search extensions with -E.
 259 \'!\' indicates criticality.
 260
 261 General extensions:
 262 .nf
 263   [!]assert=<filter>   (an RFC 4515 Filter)
 264   [!]authzid=<authzid> ("dn:<dn>" or "u:<user>")
 265   [!]manageDSAit
 266   [!]noop
 267   ppolicy
 268   [!]postread[=<attrs>]        (a comma-separated attribute list)
 269   [!]preread[=<attrs>] (a comma-separated attribute list)
 270   abandon, cancel (SIGINT sends abandon/cancel; not really controls)
 271 .fi
 272
 273 Search extensions:
 274 .nf
 275   [!]domainScope                               (domain scope)
 276   [!]mv=<filter>                               (matched values filter)
 277   [!]pr=<size>[/prompt|noprompt]       (paged results/prompt)
 278   [!]sss=[-]<attr[:OID]>[/[-]<attr[:OID]>...]  (server side sorting)
 279   [!]subentries[=true|false]           (subentries)
 280   [!]sync=ro[/<cookie>]                        (LDAP Sync refreshOnly)
 281           rp[/<cookie>][/<slimit>]     (LDAP Sync refreshAndPersist)
 282 .fi
 283 .TP
 284 .BI \-l \ timelimit
 285 wait at most \fItimelimit\fP seconds for a search to complete.
 286 A timelimit of
 287 .I 0
 288 (zero) or
 289 .I none
 290 means no limit.
 291 A timelimit of
 292 .I max
 293 means the maximum integer allowable by the protocol.
 294 A server may impose a maximal timelimit which only
 295 the root user may override.
 296 .TP
 297 .BI \-z \ sizelimit
 298 retrieve at most \fIsizelimit\fP entries for a search.
 299 A sizelimit of
 300 .I 0
 301 (zero) or
 302 .I none
 303 means no limit.
 304 A sizelimit of
 305 .I max
 306 means the maximum integer allowable by the protocol.
 307 A server may impose a maximal sizelimit which only
 308 the root user may override.
 309 .TP
 310 .BI \-O \ security-properties
 311 Specify SASL security properties.
 312 .TP
 313 .B \-I
 314 Enable SASL Interactive mode.  Always prompt.  Default is to prompt
 315 only as needed.
 316 .TP
 317 .B \-Q
 318 Enable SASL Quiet mode.  Never prompt.
 319 .TP
 320 .BI \-U \ authcid
 321 Specify the authentication ID for SASL bind. The form of the ID
 322 depends on the actual SASL mechanism used.
 323 .TP
 324 .BI \-R \ realm
 325 Specify the realm of authentication ID for SASL bind. The form of the realm
 326 depends on the actual SASL mechanism used.
 327 .TP
 328 .BI \-X \ authzid
 329 Specify the requested authorization ID for SASL bind.
 330 .I authzid
 331 must be one of the following formats:
 332 .B dn:\c
 333 .I <distinguished name>
 334 or
 335 .B u:\c
 336 .I <username>
 337 .TP
 338 .BI \-Y \ mech
 339 Specify the SASL mechanism to be used for authentication. If it's not
 340 specified, the program will choose the best mechanism the server knows.
 341 .TP
 342 .B \-Z[Z]
 343 Issue StartTLS (Transport Layer Security) extended operation. If you use
 344 .B \-ZZ\c
 345 , the command will require the operation to be successful.
 346 .SH OUTPUT FORMAT
 347 If one or more entries are found, each entry is written to standard
 348 output in LDAP Data Interchange Format or
 349 .BR ldif (5):
 350 .LP
 351 .nf
 352     version: 1
 353
 354     # bjensen, example, net
 355     dn: uid=bjensen,dc=example,dc=net
 356     objectClass: person
 357     objectClass: dcObject
 358     uid: bjensen
 359     cn: Barbara Jensen
 360     sn: Jensen
 361     ...
 362 .fi
 363 .LP
 364 If the -t option is used, the URI of a temporary file
 365 is used in place of the actual value.  If the -A option
 366 is given, only the "attributename" part is written.
 367 .SH EXAMPLE
 368 The following command:
 369 .LP
 370 .nf
 371     ldapsearch -LLL "(sn=smith)" cn sn telephoneNumber
 372 .fi
 373 .LP
 374 will perform a subtree search (using the default search base and
 375 other parameters defined in
 376 .BR ldap.conf (5))
 377 for entries with a surname (sn) of smith.  The common name (cn), surname
 378 (sn) and telephoneNumber values will be retrieved and printed to
 379 standard output.
 380 The output might look something like this if two entries are found:
 381 .LP
 382 .nf
 383     dn: uid=jts,dc=example,dc=com
 384     cn: John Smith
 385     cn: John T. Smith
 386     sn: Smith
 387     sn;lang-en: Smith
 388     sn;lang-de: Schmidt
 389     telephoneNumber: 1 555 123-4567
 390
 391     dn: uid=sss,dc=example,dc=com
 392     cn: Steve Smith
 393     cn: Steve S. Smith
 394     sn: Smith
 395     sn;lang-en: Smith
 396     sn;lang-de: Schmidt
 397     telephoneNumber: 1 555 765-4321
 398 .fi
 399 .LP
 400 The command:
 401 .LP
 402 .nf
 403     ldapsearch -LLL -u -t "(uid=xyz)" jpegPhoto audio
 404 .fi
 405 .LP
 406 will perform a subtree search using the default search base for entries
 407 with user id of "xyz".  The user friendly form of the entry's DN will be
 408 output after the line that contains the DN itself, and the jpegPhoto
 409 and audio values will be retrieved and written to temporary files.  The
 410 output might look like this if one entry with one value for each of the
 411 requested attributes is found:
 412 .LP
 413 .nf
 414     dn: uid=xyz,dc=example,dc=com
 415     ufn: xyz, example, com
 416     audio:< file:///tmp/ldapsearch-audio-a19924
 417     jpegPhoto:< file:///tmp/ldapsearch-jpegPhoto-a19924
 418 .fi
 419 .LP
 420 This command:
 421 .LP
 422 .nf
 423     ldapsearch -LLL -s one -b "c=US" "(o=University*)" o description
 424 .fi
 425 .LP
 426 will perform a one-level search at the c=US level for all entries
 427 whose organization name (o) begins begins with \fBUniversity\fP.
 428 The organization name and description attribute values will be retrieved
 429 and printed to standard output, resulting in output similar to this:
 430 .LP
 431 .nf
 432     dn: o=University of Alaska Fairbanks,c=US
 433     o: University of Alaska Fairbanks
 434     description: Preparing Alaska for a brave new yesterday
 435     description: leaf node only
 436
 437     dn: o=University of Colorado at Boulder,c=US
 438     o: University of Colorado at Boulder
 439     description: No personnel information
 440     description: Institution of education and research
 441
 442     dn: o=University of Colorado at Denver,c=US
 443     o: University of Colorado at Denver
 444     o: UCD
 445     o: CU/Denver
 446     o: CU-Denver
 447     description: Institute for Higher Learning and Research
 448
 449     dn: o=University of Florida,c=US
 450     o: University of Florida
 451     o: UFl
 452     description: Warper of young minds
 453
 454     ...
 455 .fi
 456 .SH DIAGNOSTICS
 457 Exit status is zero if no errors occur.
 458 Errors result in a non-zero exit status and
 459 a diagnostic message being written to standard error.
 460 .SH "SEE ALSO"
 461 .BR ldapadd (1),
 462 .BR ldapdelete (1),
 463 .BR ldapmodify (1),
 464 .BR ldapmodrdn (1),
 465 .BR ldap.conf (5),
 466 .BR ldif (5),
 467 .BR ldap (3),
 468 .BR ldap_search_ext (3),
 469 .BR ldap_sort (3)
 470 .SH AUTHOR
 471 The OpenLDAP Project <http://www.openldap.org/>
 472 .SH ACKNOWLEDGEMENTS
 473 .so ../Project