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

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