Rebuild docs
[Samba.git] / docs / htmldocs / nmblookup.1.html
blob851544f0d80b723c6a14702fa3b85dac05a425cc
1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>nmblookup</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.59.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="nmblookup"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>nmblookup &#8212; NetBIOS over TCP/IP client used to lookup NetBIOS
2 names</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt>nmblookup</tt> [-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></div></div><div class="refsect1" lang="en"><h2>DESCRIPTION</h2><p>This tool is part of the <a href="Samba.7.html">Samba(7)</a> suite.</p><p><b>nmblookup</b> is used to query NetBIOS names
3 and map them to IP addresses in a network using NetBIOS over TCP/IP
4 queries. The options allow the name queries to be directed at a
5 particular IP broadcast area or to a particular machine. All queries
6 are done over UDP.</p></div><div class="refsect1" lang="en"><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-M</span></dt><dd><p>Searches for a master browser by looking
7 up the NetBIOS name <i><tt>name</tt></i> with a
8 type of <tt>0x1d</tt>. If <i><tt>
9 name</tt></i> is &quot;-&quot; then it does a lookup on the special name
10 <tt>__MSBROWSE__</tt>. Please note that in order to
11 use the name &quot;-&quot;, you need to make sure &quot;-&quot; isn't parsed as an
12 argument, e.g. use :
13 <b><tt>nmblookup -M -- -</tt></b>.</p></dd><dt><span class="term">-R</span></dt><dd><p>Set the recursion desired bit in the packet
14 to do a recursive lookup. This is used when sending a name
15 query to a machine running a WINS server and the user wishes
16 to query the names in the WINS server. If this bit is unset
17 the normal (broadcast responding) NetBIOS processing code
18 on a machine is used instead. See RFC1001, RFC1002 for details.
19 </p></dd><dt><span class="term">-S</span></dt><dd><p>Once the name query has returned an IP
20 address then do a node status query as well. A node status
21 query returns the NetBIOS names registered by a host.
22 </p></dd><dt><span class="term">-r</span></dt><dd><p>Try and bind to UDP port 137 to send and receive UDP
23 datagrams. The reason for this option is a bug in Windows 95
24 where it ignores the source port of the requesting packet
25 and only replies to UDP port 137. Unfortunately, on most UNIX
26 systems root privilege is needed to bind to this port, and
27 in addition, if the <a href="nmbd.8.html">nmbd(8)</a> daemon is running on this machine it also binds to this port.
28 </p></dd><dt><span class="term">-A</span></dt><dd><p>Interpret <i><tt>name</tt></i> as
29 an IP Address and do a node status query on this address.</p></dd><dt><span class="term">-n &lt;primary NetBIOS name&gt;</span></dt><dd><p>This option allows you to override
30 the NetBIOS name that Samba uses for itself. This is identical
31 to setting the <a href="smb.conf.5.html#netbiosname" target="_top"><i><tt>NetBIOS
32 name</tt></i></a> parameter in the <a href="smb.conf.5.html">smb.conf(5)</a> file. However, a command
33 line setting will take precedence over settings in
34 <a href="smb.conf.5.html">smb.conf(5)</a>.</p></dd><dt><span class="term">-i &lt;scope&gt;</span></dt><dd><p>This specifies a NetBIOS scope that
35 <b>nmblookup</b> will use to communicate with when
36 generating NetBIOS names. For details on the use of NetBIOS
37 scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are
38 <span class="emphasis"><em>very</em></span> rarely used, only set this parameter
39 if you are the system administrator in charge of all the
40 NetBIOS systems you communicate with.</p></dd><dt><span class="term">-W|--workgroup=domain</span></dt><dd><p>Set the SMB domain of the username. This
41 overrides the default domain which is the domain defined in
42 smb.conf. If the domain specified is the same as the servers
43 NetBIOS name, it causes the client to log on using the servers local
44 SAM (as opposed to the Domain SAM). </p></dd><dt><span class="term">-O socket options</span></dt><dd><p>TCP socket options to set on the client
45 socket. See the socket options parameter in
46 the <a href="smb.conf.5.html">smb.conf(5)</a> manual page for the list of valid
47 options. </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options.
48 </p></dd><dt><span class="term">-B &lt;broadcast address&gt;</span></dt><dd><p>Send the query to the given broadcast address. Without
49 this option the default behavior of nmblookup is to send the
50 query to the broadcast address of the network interfaces as
51 either auto-detected or defined in the <a href="smb.conf.5.html#INTERFACES" target="_top"><i><tt>interfaces</tt></i>
52 </a> parameter of the <a href="smb.conf.5.html">smb.conf(5)</a> file.
53 </p></dd><dt><span class="term">-U &lt;unicast address&gt;</span></dt><dd><p>Do a unicast query to the specified address or
54 host <i><tt>unicast address</tt></i>. This option
55 (along with the <i><tt>-R</tt></i> option) is needed to
56 query a WINS server.</p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the version number for
57 <b>smbd</b>.</p></dd><dt><span class="term">-s &lt;configuration file&gt;</span></dt><dd><p>The file specified contains the
58 configuration details required by the server. The
59 information in this file includes server-specific
60 information such as what printcap file to use, as well
61 as descriptions of all the services that the server is
62 to provide. See <a href="smb.conf.5.html" target="_top"><tt>
63 smb.conf(5)</tt></a> for more information.
64 The default configuration file name is determined at
65 compile time.</p></dd><dt><span class="term">-d|--debug=debuglevel</span></dt><dd><p><i><tt>debuglevel</tt></i> is an integer
66 from 0 to 10. The default value if this parameter is
67 not specified is zero.</p><p>The higher this value, the more detail will be
68 logged to the log files about the activities of the
69 server. At level 0, only critical errors and serious
70 warnings will be logged. Level 1 is a reasonable level for
71 day to day running - it generates a small amount of
72 information about operations carried out.</p><p>Levels above 1 will generate considerable
73 amounts of log data, and should only be used when
74 investigating a problem. Levels above 3 are designed for
75 use only by developers and generate HUGE amounts of log
76 data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will
77 override the <a href="smb.conf.5.html#loglevel" target="_top">log
78 level</a> parameter in the <a href="smb.conf.5.html" target="_top">
79 <tt>smb.conf(5)</tt></a> file.</p></dd><dt><span class="term">-l|--logfile=logbasename</span></dt><dd><p>File name for log/debug files. The extension
80 <tt>&quot;.client&quot;</tt> will be appended. The log file is
81 never removed by the client.
82 </p></dd><dt><span class="term">-T</span></dt><dd><p>This causes any IP addresses found in the
83 lookup to be looked up via a reverse DNS lookup into a
84 DNS name, and printed out before each</p><p><span class="emphasis"><em>IP address .... NetBIOS name</em></span></p><p> pair that is the normal output.</p></dd><dt><span class="term">-f</span></dt><dd><p>
85 Show which flags apply to the name that has been looked up. Possible
86 answers are zero or more of: Response, Authoritative,
87 Truncated, Recursion_Desired, Recursion_Available, Broadcast.
88 </p></dd><dt><span class="term">name</span></dt><dd><p>This is the NetBIOS name being queried. Depending
89 upon the previous options this may be a NetBIOS name or IP address.
90 If a NetBIOS name then the different name types may be specified
91 by appending '#&lt;type&gt;' to the name. This name may also be
92 '*', which will return all registered names within a broadcast
93 area.</p></dd></dl></div></div><div class="refsect1" lang="en"><h2>EXAMPLES</h2><p><b>nmblookup</b> can be used to query
94 a WINS server (in the same way <b>nslookup</b> is
95 used to query DNS servers). To query a WINS server, <b>nmblookup</b>
96 must be called like this:</p><p><b>nmblookup -U server -R 'name'</b></p><p>For example, running :</p><p><b>nmblookup -U samba.org -R 'IRIX#1B'</b></p><p>would query the WINS server samba.org for the domain
97 master browser (1B name type) for the IRIX workgroup.</p></div><div class="refsect1" lang="en"><h2>VERSION</h2><p>This man page is correct for version 3.0 of
98 the Samba suite.</p></div><div class="refsect1" lang="en"><h2>SEE ALSO</h2><p><a href="nmbd.8.html">nmbd(8)</a>, <a href="samba.7.html">samba(7)</a>, and <a href="smb.conf.5.html">smb.conf(5)</a>.</p></div><div class="refsect1" lang="en"><h2>AUTHOR</h2><p>The original Samba software and related utilities
99 were created by Andrew Tridgell. Samba is now developed
100 by the Samba Team as an Open Source project similar
101 to the way the Linux kernel is developed.</p><p>The original Samba man pages were written by Karl Auer.
102 The man page sources were converted to YODL format (another
103 excellent piece of Open Source software, available at <a href="ftp://ftp.icce.rug.nl/pub/unix/" target="_top">
104 ftp://ftp.icce.rug.nl/pub/unix/</a>) and updated for the Samba 2.0
105 release by Jeremy Allison. The conversion to DocBook for
106 Samba 2.2 was done by Gerald Carter. The conversion to DocBook
107 XML 4.2 for Samba 3.0 was done by Alexander Bokovoy.</p></div></div></body></html>