This commit was manufactured by cvs2svn to create branch 'SAMBA_3_0'.(This used to...
[kai/samba.git] / docs / htmldocs / nmblookup.1.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <HTML
3 ><HEAD
4 ><TITLE
5 >nmblookup</TITLE
6 ><META
7 NAME="GENERATOR"
8 CONTENT="Modular DocBook HTML Stylesheet Version 1.77"></HEAD
9 ><BODY
10 CLASS="REFENTRY"
11 BGCOLOR="#FFFFFF"
12 TEXT="#000000"
13 LINK="#0000FF"
14 VLINK="#840084"
15 ALINK="#0000FF"
16 ><H1
17 ><A
18 NAME="NMBLOOKUP"
19 ></A
20 >nmblookup</H1
21 ><DIV
22 CLASS="REFNAMEDIV"
23 ><A
24 NAME="AEN5"
25 ></A
26 ><H2
27 >Name</H2
28 >nmblookup&nbsp;--&nbsp;NetBIOS over TCP/IP client used to lookup NetBIOS 
29         names</DIV
30 ><DIV
31 CLASS="REFSYNOPSISDIV"
32 ><A
33 NAME="AEN8"
34 ></A
35 ><H2
36 >Synopsis</H2
37 ><P
38 ><B
39 CLASS="COMMAND"
40 >nmblookup</B
41 >  [-M] [-R] [-S] [-r] [-A] [-h] [-B &lt;broadcast address&gt;] [-U &lt;unicast address&gt;] [-d &lt;debug level&gt;] [-s &lt;smb config file&gt;] [-i &lt;NetBIOS scope&gt;] [-T] [-f] {name}</P
42 ></DIV
43 ><DIV
44 CLASS="REFSECT1"
45 ><A
46 NAME="AEN25"
47 ></A
48 ><H2
49 >DESCRIPTION</H2
50 ><P
51 >This tool is part of the <A
52 HREF="samba.7.html"
53 TARGET="_top"
54 >       Samba</A
55 > suite.</P
56 ><P
57 ><B
58 CLASS="COMMAND"
59 >nmblookup</B
60 > is used to query NetBIOS names 
61         and map them to IP addresses in a network using NetBIOS over TCP/IP 
62         queries. The options allow the name queries to be directed at a 
63         particular IP broadcast area or to a particular machine. All queries 
64         are done over UDP.</P
65 ></DIV
66 ><DIV
67 CLASS="REFSECT1"
68 ><A
69 NAME="AEN31"
70 ></A
71 ><H2
72 >OPTIONS</H2
73 ><P
74 ></P
75 ><DIV
76 CLASS="VARIABLELIST"
77 ><DL
78 ><DT
79 >-M</DT
80 ><DD
81 ><P
82 >Searches for a master browser by looking 
83                 up the  NetBIOS name <TT
84 CLASS="REPLACEABLE"
85 ><I
86 >name</I
87 ></TT
88 > with a 
89                 type of <TT
90 CLASS="CONSTANT"
91 >0x1d</TT
92 >. If <TT
93 CLASS="REPLACEABLE"
94 ><I
95 >               name</I
96 ></TT
97 > is "-" then it does a lookup on the special name 
98                 <TT
99 CLASS="CONSTANT"
100 >__MSBROWSE__</TT
101 >.</P
102 ></DD
103 ><DT
104 >-R</DT
105 ><DD
106 ><P
107 >Set the recursion desired bit in the packet 
108                 to do a recursive lookup. This is used when sending a name 
109                 query to a machine running a WINS server and the user wishes 
110                 to query the names in the WINS server.  If this bit is unset 
111                 the normal (broadcast responding) NetBIOS processing code 
112                 on a machine is used instead. See rfc1001, rfc1002 for details.
113                 </P
114 ></DD
115 ><DT
116 >-S</DT
117 ><DD
118 ><P
119 >Once the name query has returned an IP 
120                 address then do a node status query as well. A node status 
121                 query returns the NetBIOS names registered by a host.
122                 </P
123 ></DD
124 ><DT
125 >-r</DT
126 ><DD
127 ><P
128 >Try and bind to UDP port 137 to send and receive UDP
129                 datagrams. The reason for this option is a bug in Windows 95 
130                 where it ignores the source port of the requesting packet 
131                 and only replies to UDP port 137. Unfortunately, on most UNIX 
132                 systems root privilege is needed to bind to this port, and 
133                 in addition, if the <A
134 HREF="nmbd.8.html"
135 TARGET="_top"
136 >nmbd(8)</A
137
138                 daemon is running on this machine it also binds to this port.
139                 </P
140 ></DD
141 ><DT
142 >-A</DT
143 ><DD
144 ><P
145 >Interpret <TT
146 CLASS="REPLACEABLE"
147 ><I
148 >name</I
149 ></TT
150 > as 
151                 an IP Address and do a node status query on this address.</P
152 ></DD
153 ><DT
154 >-h</DT
155 ><DD
156 ><P
157 >Print a help (usage) message.</P
158 ></DD
159 ><DT
160 >-B &lt;broadcast address&gt;</DT
161 ><DD
162 ><P
163 >Send the query to the given broadcast address. Without 
164                 this option the default behavior of nmblookup is to send the 
165                 query to the broadcast address of the network interfaces as 
166                 either auto-detected or defined in the <A
167 HREF="smb.conf.5.html#INTERFACES"
168 TARGET="_top"
169 ><TT
170 CLASS="PARAMETER"
171 ><I
172 >interfaces</I
173 ></TT
174 >
175                 </A
176 > parameter of the  <TT
177 CLASS="FILENAME"
178 >smb.conf (5)</TT
179 > file.
180                 </P
181 ></DD
182 ><DT
183 >-U &lt;unicast address&gt;</DT
184 ><DD
185 ><P
186 >Do a unicast query to the specified address or 
187                 host <TT
188 CLASS="REPLACEABLE"
189 ><I
190 >unicast address</I
191 ></TT
192 >. This option 
193                 (along with the <TT
194 CLASS="PARAMETER"
195 ><I
196 >-R</I
197 ></TT
198 > option) is needed to 
199                 query a WINS server.</P
200 ></DD
201 ><DT
202 >-d &lt;debuglevel&gt;</DT
203 ><DD
204 ><P
205 >debuglevel is an integer from 0 to 10.</P
206 ><P
207 >The default value if this parameter is not specified 
208                 is zero.</P
209 ><P
210 >The higher this value, the more detail will be logged 
211                 about the activities of <B
212 CLASS="COMMAND"
213 >nmblookup</B
214 >. At level 
215                 0, only critical errors and serious warnings will be logged.</P
216 ><P
217 >Levels above 1 will generate considerable amounts of 
218                 log data, and should only be used when investigating a problem. 
219                 Levels above 3 are designed for use only by developers and 
220                 generate HUGE amounts of data, most of which is extremely cryptic.</P
221 ><P
222 >Note that specifying this parameter here will override 
223                 the <A
224 HREF="smb.conf.5.html#LOGLEVEL"
225 TARGET="_top"
226 ><TT
227 CLASS="PARAMETER"
228 ><I
229 >               log level</I
230 ></TT
231 ></A
232 > parameter in the <TT
233 CLASS="FILENAME"
234 >               smb.conf(5)</TT
235 > file.</P
236 ></DD
237 ><DT
238 >-s &lt;smb.conf&gt;</DT
239 ><DD
240 ><P
241 >This parameter specifies the pathname to 
242                 the Samba configuration file, <A
243 HREF="smb.conf.5.html"
244 TARGET="_top"
245 >               smb.conf(5)</A
246 >.  This file controls all aspects of
247                 the Samba setup on the machine.</P
248 ></DD
249 ><DT
250 >-i &lt;scope&gt;</DT
251 ><DD
252 ><P
253 >This specifies a NetBIOS scope that
254                 <B
255 CLASS="COMMAND"
256 >nmblookup</B
257 > will use to communicate with when 
258                 generating NetBIOS names. For details on the use of NetBIOS 
259                 scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are 
260                 <SPAN
261 CLASS="emphasis"
262 ><I
263 CLASS="EMPHASIS"
264 >very</I
265 ></SPAN
266 > rarely used, only set this parameter 
267                 if you are the system administrator in charge of all the 
268                 NetBIOS systems you communicate with.</P
269 ></DD
270 ><DT
271 >-T</DT
272 ><DD
273 ><P
274 >This causes any IP addresses found in the 
275                 lookup to be looked up via a reverse DNS lookup into a 
276                 DNS name, and printed out before each</P
277 ><P
278 ><SPAN
279 CLASS="emphasis"
280 ><I
281 CLASS="EMPHASIS"
282 >IP address .... NetBIOS name</I
283 ></SPAN
284 ></P
285 ><P
286 > pair that is the normal output.</P
287 ></DD
288 ><DT
289 >-f</DT
290 ><DD
291 ><P
292 >               Show which flags apply to the name that has been looked up. Possible 
293                 answers are zero or more of: Response, Authoritative, 
294                 Truncated, Recursion_Desired, Recursion_Available, Broadcast.
295                 </P
296 ></DD
297 ><DT
298 >name</DT
299 ><DD
300 ><P
301 >This is the NetBIOS name being queried. Depending 
302                 upon the previous options this may be a NetBIOS name or IP address. 
303                 If a NetBIOS name then the different name types may be specified 
304                 by appending '#&lt;type&gt;' to the name. This name may also be
305                 '*', which will return all registered names within a broadcast 
306                 area.</P
307 ></DD
308 ></DL
309 ></DIV
310 ></DIV
311 ><DIV
312 CLASS="REFSECT1"
313 ><A
314 NAME="AEN115"
315 ></A
316 ><H2
317 >EXAMPLES</H2
318 ><P
319 ><B
320 CLASS="COMMAND"
321 >nmblookup</B
322 > can be used to query 
323                 a WINS server (in the same way <B
324 CLASS="COMMAND"
325 >nslookup</B
326 > is 
327                 used to query DNS servers). To query a WINS server, 
328                 <B
329 CLASS="COMMAND"
330 >nmblookup</B
331 > must be called like this:</P
332 ><P
333 ><B
334 CLASS="COMMAND"
335 >nmblookup -U server -R 'name'</B
336 ></P
337 ><P
338 >For example, running :</P
339 ><P
340 ><B
341 CLASS="COMMAND"
342 >nmblookup -U samba.org -R 'IRIX#1B'</B
343 ></P
344 ><P
345 >would query the WINS server samba.org for the domain 
346                 master browser (1B name type) for the IRIX workgroup.</P
347 ></DIV
348 ><DIV
349 CLASS="REFSECT1"
350 ><A
351 NAME="AEN127"
352 ></A
353 ><H2
354 >VERSION</H2
355 ><P
356 >This man page is correct for version 3.0 of 
357         the Samba suite.</P
358 ></DIV
359 ><DIV
360 CLASS="REFSECT1"
361 ><A
362 NAME="AEN130"
363 ></A
364 ><H2
365 >SEE ALSO</H2
366 ><P
367 ><A
368 HREF="nmbd.8.html"
369 TARGET="_top"
370 ><B
371 CLASS="COMMAND"
372 >nmbd(8)</B
373 ></A
374 >, 
375         <A
376 HREF="samba.7.html"
377 TARGET="_top"
378 >samba(7)</A
379 >, and  <A
380 HREF="smb.conf.5.html"
381 TARGET="_top"
382 >smb.conf(5)</A
383 >
384         </P
385 ></DIV
386 ><DIV
387 CLASS="REFSECT1"
388 ><A
389 NAME="AEN137"
390 ></A
391 ><H2
392 >AUTHOR</H2
393 ><P
394 >The original Samba software and related utilities 
395         were created by Andrew Tridgell. Samba is now developed
396         by the Samba Team as an Open Source project similar 
397         to the way the Linux kernel is developed.</P
398 ><P
399 >The original Samba man pages were written by Karl Auer. 
400         The man page sources were converted to YODL format (another 
401         excellent piece of Open Source software, available at
402         <A
403 HREF="ftp://ftp.icce.rug.nl/pub/unix/"
404 TARGET="_top"
405 >       ftp://ftp.icce.rug.nl/pub/unix/</A
406 >) and updated for the Samba 2.0 
407         release by Jeremy Allison.  The conversion to DocBook for 
408         Samba 2.2 was done by Gerald Carter</P
409 ></DIV
410 ></BODY
411 ></HTML
412 >