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