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

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