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

   1 .TH LDAPSEARCH 1 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2002 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 \ passwd\fR]
  39 [\c
  40 .BI \-y \ passwdfile\fR]
  41 [\c
  42 .BI \-H \ ldapuri\fR]
  43 [\c
  44 .BI \-h \ ldaphost\fR]
  45 [\c
  46 .BI \-p \ ldapport\fR]
  47 [\c
  48 .BI \-P \ 2\fR\||\|\fI3\fR]
  49 [\c
  50 .BI \-b \ searchbase\fR]
  51 [\c
  52 .BI \-s \ base\fR\||\|\fIone\fR\||\|\fIsub\fR]
  53 [\c
  54 .BI \-a \ never\fR\||\|\fIalways\fR\||\|\fIsearch\fR\||\|\fIfind\fR]
  55 [\c
  56 .BI \-l \ timelimit\fR]
  57 [\c
  58 .BI \-z \ sizelimit\fR]
  59 [\c
  60 .BR \-O \ security-properties ]
  61 [\c
  62 .BR \-I ]
  63 [\c
  64 .BR \-Q ]
  65 [\c
  66 .BI \-U \ authcid\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 values to a set of temporary files.  This is useful for
 122 dealing with non-ASCII values such as jpegPhoto or audio.
 123 .TP
 124 .B \-A
 125 Retrieve attributes only (no values).  This is useful when you just want to
 126 see if an attribute is present in an entry and are not interested in the
 127 specific values.
 128 .TP
 129 .B \-L
 130 Search results are display in LDAP Data Interchange Format detailed in
 131 .BR ldif (5).
 132 A single -L restricts the output to LDIFv1.
 133 A second -L disables comments.
 134 A third -L disables printing of the LDIF version.
 135 The default is to use an extended version of LDIF.
 136 .TP
 137 .B \-M[M]
 138 Enable manage DSA IT control.
 139 .B \-MM
 140 makes control critical.
 141 .TP
 142 .B \-C
 143 Automatically chase referrals.
 144 .TP
 145 .BI \-S \ attribute
 146 Sort the entries returned based on \fIattribute\fP. The default is not
 147 to sort entries returned.  If \fIattribute\fP is a zero-length string (""),
 148 the entries are sorted by the components of their Distingished Name.  See
 149 .BR ldap_sort (3)
 150 for more details. Note that
 151 .B ldapsearch
 152 normally prints out entries as it receives them. The use of the
 153 .B \-S
 154 option defeats this behavior, causing all entries to be retrieved,
 155 then sorted, then printed.
 156 .TP
 157 .BI \-d \ debuglevel
 158 Set the LDAP debugging level to \fIdebuglevel\fP.
 159 .B ldapsearch
 160 must be compiled with LDAP_DEBUG defined for this option to have any effect.
 161 .TP
 162 .BI \-f \ file
 163 Read a series of lines from \fIfile\fP, performing one LDAP search for
 164 each line.  In this case, the \fIfilter\fP given on the command line
 165 is treated as a pattern where the first occurrence of \fB%s\fP is
 166 replaced with a line from \fIfile\fP.  If \fIfile\fP is a single \fI-\fP
 167 character, then the lines are read from standard input.
 168 .TP
 169 .B \-x
 170 Use simple authentication instead of SASL.
 171 .TP
 172 .BI \-D \ binddn
 173 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
 174 .TP
 175 .B \-W
 176 Prompt for simple authentication.
 177 This is used instead of specifying the password on the command line.
 178 .TP
 179 .BI \-w \ passwd
 180 Use \fIpasswd\fP as the password for simple authentication.
 181 .TP
 182 .BI \-y \ passwdfile
 183 Use complete contents of \fIpasswdfile\fP as the password for
 184 simple authentication.
 185 .TP
 186 .BI \-H \ ldapuri
 187 Specify URI(s) referring to the ldap server(s).
 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.  A
 227 timelimit of
 228 .I 0
 229 (zero) removes the
 230 .B ldap.conf
 231 limit.
 232 A server may impose a maximal timelimit which only
 233 the root user may override.
 234 .TP
 235 .BI \-z \ sizelimit
 236 retrieve at most \fIsizelimit\fP entries for a search.  A sizelimit
 237 of
 238 .I 0
 239 (zero) removes the
 240 .B ldap.conf
 241 limit.
 242 A server may impose a maximal sizelimit which only
 243 the root user may override.
 244 .TP
 245 .BI \-O \ security-properties
 246 Specify SASL security properties.
 247 .TP
 248 .B \-I
 249 Enable SASL Interactive mode.  Always prompt.  Default is to prompt
 250 only as needed.
 251 .TP
 252 .B \-Q
 253 Enable SASL Quiet mode.  Never prompt.
 254 .TP
 255 .BI \-U \ authcid
 256 Specify the authentication ID for SASL bind. The form of the ID
 257 depends on the actual SASL mechanism used.
 258 .TP
 259 .BI \-X \ authzid
 260 Specify the requested authorization ID for SASL bind.
 261 .I authzid
 262 must be one of the following formats:
 263 .B dn:\c
 264 .I <distinguished name>
 265 or
 266 .B u:\c
 267 .I <username>
 268 .TP
 269 .BI \-Y \ mech
 270 Specify the SASL mechanism to be used for authentication. If it's not
 271 specified, the program will choose the best mechanism the server knows.
 272 .TP
 273 .B \-Z[Z]
 274 Issue StartTLS (Transport Layer Security) extended operation. If you use
 275 .B \-ZZ\c
 276 , the command will require the operation to be successful.
 277 .SH OUTPUT FORMAT
 278 If one or more entries are found, each entry is written to standard
 279 output in LDAP Data Interchange Format or
 280 .BR ldif (5):
 281 .LP
 282 .nf
 283         version: 1
 284
 285         # bjensen, example, net
 286         dn: uid=bjensen,dc=example,dc=net
 287         objectClass: person
 288         objectClass: dcObject
 289         uid: bjensen
 290         cn: Barbara Jensen
 291         sn: Jensen
 292     ...
 293 .fi
 294 .LP
 295 If the -t option is used, the URI of a temporary file
 296 is used in place of the actual value.  If the -A option
 297 is given, only the "attributename" part is written.
 298 .SH EXAMPLE
 299 The following command:
 300 .LP
 301 .nf
 302     ldapsearch -LLL "(sn=smith)" cn sn telephoneNumber
 303 .fi
 304 .LP
 305 will perform a subtree search (using the default search base defined
 306 in
 307 .BR ldap.conf (5))
 308 for entries with a surname (sn) of smith.  The common name (cn), surname
 309 (sn) and telephoneNumber values will be retrieved and printed to
 310 standard output.
 311 The output might look something like this if two entries are found:
 312 .LP
 313 .nf
 314     dn: uid=jts,dc=example,dc=com
 315         cn: John Smith
 316         cn: John T. Smith
 317         sn: Smith
 318         sn;lang-en: Smith
 319         sn;lang-de: Schmidt
 320         telephoneNumber: 1 555 123-4567
 321
 322         dn: uid=sss,dc=example,dc=com
 323         cn: Steve Smith
 324         cn: Steve S. Smith
 325         sn: Smith
 326         sn;lang-en: Smith
 327         sn;lang-de: Schmidt
 328         telephoneNumber: 1 555 765-4321
 329 .fi
 330 .LP
 331 The command:
 332 .LP
 333 .nf
 334     ldapsearch -LLL -u -t "(uid=xyz)" jpegPhoto audio
 335 .fi
 336 .LP
 337 will perform a subtree search using the default search base for entries
 338 with user id of "xyz".  The user friendly form of the entry's DN will be
 339 output after the line that contains the DN itself, and the jpegPhoto
 340 and audio values will be retrieved and written to temporary files.  The
 341 output might look like this if one entry with one value for each of the
 342 requested attributes is found:
 343 .LP
 344 .nf
 345     dn: uid=xyz,dc=example,dc=com
 346     ufn: xyz, example, com
 347     audio:< file::/tmp/ldapsearch-audio-a19924
 348     jpegPhoto:< file::=/tmp/ldapsearch-jpegPhoto-a19924
 349 .fi
 350 .LP
 351 This command:
 352 .LP
 353 .nf
 354     ldapsearch -LLL -s one -b "c=US" "(o=University*)" o description
 355 .fi
 356 .LP
 357 will perform a one-level search at the c=US level for all entries
 358 whose organization name (o) begins begins with \fBUniversity\fP.
 359 The organization name and description attribute values will be retrieved
 360 and printed to standard output, resulting in output similar to this:
 361 .LP
 362 .nf
 363     dn: o=University of Alaska Fairbanks,c=US
 364     o: University of Alaska Fairbanks
 365     description: Preparing Alaska for a brave new yesterday
 366     description: leaf node only
 367
 368     dn: o=University of Colorado at Boulder,c=US
 369     o: University of Colorado at Boulder
 370     description: No personnel information
 371     description: Institution of education and research
 372
 373     dn: o=University of Colorado at Denver,c=US
 374     o: University of Colorado at Denver
 375     o: UCD
 376     o: CU/Denver
 377     o: CU-Denver
 378     description: Institute for Higher Learning and Research
 379
 380     dn: o=University of Florida,c=US
 381     o: University of Florida
 382     o: UFl
 383     description: Warper of young minds
 384
 385     ...
 386 .fi
 387 .SH DIAGNOSTICS
 388 Exit status is zero if no errors occur.
 389 Errors result in a non-zero exit status and
 390 a diagnostic message being written to standard error.
 391 .SH "SEE ALSO"
 392 .BR ldapadd (1),
 393 .BR ldapdelete (1),
 394 .BR ldapmodify (1),
 395 .BR ldapmodrdn (1),
 396 .BR ldap.conf (5),
 397 .BR ldif (5),
 398 .BR ldap (3),
 399 .BR ldap_search (3)
 400 .SH AUTHOR
 401 The OpenLDAP Project <http://www.openldap.org/>
 402 .SH ACKNOWLEDGEMENTS
 403 .B      OpenLDAP
 404 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 405 .B      OpenLDAP
 406 is derived from University of Michigan LDAP 3.3 Release.