path: root/docs/htmldocs/nmblookup.1.html

<?xml version="1.0"?>

<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
	        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [

	<!ENTITY % globalentities SYSTEM 'global.ent'> %globalentities;
 ]>
<refentry id="nmblookup">

<refmeta>
	<refentrytitle>nmblookup</refentrytitle>
	<manvolnum>1</manvolnum>
</refmeta>


<refnamediv>
	<refname>nmblookup</refname>
	<refpurpose>NetBIOS over TCP/IP client used to lookup NetBIOS 
	names</refpurpose>
</refnamediv>

<refsynopsisdiv>
	<cmdsynopsis sepchar=" ">
		<command moreinfo="none">nmblookup</command>
		<arg rep="norepeat" choice="opt">-M</arg>
		<arg rep="norepeat" choice="opt">-R</arg>
		<arg rep="norepeat" choice="opt">-S</arg>
		<arg rep="norepeat" choice="opt">-r</arg>
		<arg rep="norepeat" choice="opt">-A</arg>
		<arg rep="norepeat" choice="opt">-h</arg>
		<arg rep="norepeat" choice="opt">-B &lt;broadcast address&gt;</arg>
		<arg rep="norepeat" choice="opt">-U &lt;unicast address&gt;</arg>
		<arg rep="norepeat" choice="opt">-d &lt;debug level&gt;</arg>
		<arg rep="norepeat" choice="opt">-s &lt;smb config file&gt;</arg>
		<arg rep="norepeat" choice="opt">-i &lt;NetBIOS scope&gt;</arg>
		<arg rep="norepeat" choice="opt">-T</arg>
		<arg rep="norepeat" choice="opt">-f</arg>
		<arg rep="norepeat" choice="req">name</arg>
	</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
	<title>DESCRIPTION</title>

	<para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
	<manvolnum>7</manvolnum></citerefentry> suite.</para>

	<para><command moreinfo="none">nmblookup</command> is used to query NetBIOS names 
	and map them to IP addresses in a network using NetBIOS over TCP/IP 
	queries. The options allow the name queries to be directed at a 
	particular IP broadcast area or to a particular machine. All queries 
	are done over UDP.</para>
</refsect1>

<refsect1>
	<title>OPTIONS</title>

	<variablelist>
		<varlistentry>
		<term>-M</term>
		<listitem><para>Searches for a master browser by looking 
		up the  NetBIOS name <replaceable>name</replaceable> with a 
		type of <constant>0x1d</constant>. If <replaceable>
		name</replaceable> is &quot;-&quot; then it does a lookup on the special name 
		<constant>__MSBROWSE__</constant>. Please note that in order to 
		use the name &quot;-&quot;, you need to make sure &quot;-&quot; isn't parsed as an 
		argument, e.g. use : 
		<userinput moreinfo="none">nmblookup -M -- -</userinput>.</para></listitem> 
		</varlistentry>
		
		<varlistentry>
		<term>-R</term>
		<listitem><para>Set the recursion desired bit in the packet 
		to do a recursive lookup. This is used when sending a name 
		query to a machine running a WINS server and the user wishes 
		to query the names in the WINS server.  If this bit is unset 
		the normal (broadcast responding) NetBIOS processing code 
		on a machine is used instead. See RFC1001, RFC1002 for details.
		</para></listitem>
		</varlistentry>
		
		<varlistentry>
		<term>-S</term>
		<listitem><para>Once the name query has returned an IP 
		address then do a node status query as well. A node status 
		query returns the NetBIOS names registered by a host.
		</para></listitem>
		</varlistentry>


		<varlistentry>
		<term>-r</term> 
		<listitem><para>Try and bind to UDP port 137 to send and receive UDP
		datagrams. The reason for this option is a bug in Windows 95 
		where it ignores the source port of the requesting packet 
	 	and only replies to UDP port 137. Unfortunately, on most UNIX 
		systems root privilege is needed to bind to this port, and 
		in addition, if the <citerefentry><refentrytitle>nmbd</refentrytitle>
		<manvolnum>8</manvolnum></citerefentry> daemon is running on this machine it also binds to this port.
		</para></listitem>
		</varlistentry>


		<varlistentry>
		<term>-A</term>
		<listitem><para>Interpret <replaceable>name</replaceable> as 
		an IP Address and do a node status query on this address.</para>
		</listitem>
		</varlistentry>



		

<varlistentry>
<term>-n &lt;primary NetBIOS name&gt;</term>
<listitem><para>This option allows you to override
the NetBIOS name that Samba uses for itself. This is identical
to setting the <indexterm><primary>netbios name</primary></indexterm><parameter moreinfo="none">netbios name</parameter> parameter in the <filename moreinfo="none">smb.conf</filename> file. 
However, a command
line setting will take precedence over settings in
<filename moreinfo="none">smb.conf</filename>.</para></listitem>
</varlistentry>

<varlistentry>
<term>-i &lt;scope&gt;</term>
<listitem><para>This specifies a NetBIOS scope that
<command moreinfo="none">nmblookup</command> will use to communicate with when
generating NetBIOS names. For details on the use of NetBIOS
scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are
<emphasis>very</emphasis> rarely used, only set this parameter
if you are the system administrator in charge of all the
NetBIOS systems you communicate with.</para></listitem>
</varlistentry>

<varlistentry>
<term>-W|--workgroup=domain</term>
<listitem><para>Set the SMB domain of the username.   This
overrides the default domain which is the domain defined in
smb.conf.  If the domain specified is the same as the servers 
NetBIOS name, it causes the client to log on using the servers local 
SAM (as opposed to the Domain SAM). </para></listitem>
</varlistentry>

<varlistentry>
<term>-O socket options</term>
<listitem><para>TCP socket options to set on the client
socket. See the socket options parameter in
the <filename moreinfo="none">smb.conf</filename> manual page for the list of valid
options. </para></listitem>
</varlistentry>


		
<varlistentry>
<term>-h|--help</term>
<listitem><para>Print a summary of command line options.
</para></listitem>
</varlistentry>

		<varlistentry>
		<term>-B &lt;broadcast address&gt;</term> 
		<listitem><para>Send the query to the given broadcast address. Without 
		this option the default behavior of nmblookup is to send the 
		query to the broadcast address of the network interfaces as 
		either auto-detected or defined in the <ulink url="smb.conf.5.html#INTERFACES"><parameter moreinfo="none">interfaces</parameter>
		</ulink> parameter of the <citerefentry><refentrytitle>smb.conf</refentrytitle>
	<manvolnum>5</manvolnum></citerefentry> file.
		</para></listitem>
		</varlistentry>



		<varlistentry>
		<term>-U &lt;unicast address&gt;</term>
		<listitem><para>Do a unicast query to the specified address or 
		host <replaceable>unicast address</replaceable>. This option 
		(along with the <parameter moreinfo="none">-R</parameter> option) is needed to 
		query a WINS server.</para></listitem>
		</varlistentry>
		
		
		

<varlistentry>
<term>-V</term>
<listitem><para>Prints the version number for 
<command moreinfo="none">smbd</command>.</para></listitem>
</varlistentry>

<varlistentry>
<term>-s &lt;configuration file&gt;</term>
<listitem><para>The file specified contains the 
configuration details required by the server.  The 
information in this file includes server-specific
information such as what printcap file to use, as well 
as descriptions of all the services that the server is 
to provide. See <filename moreinfo="none">smb.conf</filename> for more information.
The default configuration file name is determined at 
compile time.</para></listitem>
</varlistentry>

<varlistentry>
<term>-d|--debug=debuglevel</term>
<listitem>
<para><replaceable>debuglevel</replaceable> is an integer 
from 0 to 10.  The default value if this parameter is 
not specified is zero.</para>

<para>The higher this value, the more detail will be 
logged to the log files about the activities of the 
server. At level 0, only critical errors and serious 
warnings will be logged. Level 1 is a reasonable level for
day to day running - it generates a small amount of 
information about operations carried out.</para>

<para>Levels above 1 will generate considerable 
amounts of log data, and should only be used when 
investigating a problem. Levels above 3 are designed for 
use only by developers and generate HUGE amounts of log
data, most of which is extremely cryptic.</para>

<para>Note that specifying this parameter here will 
override the <indexterm><primary>log level</primary></indexterm><parameter moreinfo="none">log level</parameter> parameter
in the <filename moreinfo="none">smb.conf</filename> file.</para>
</listitem>
</varlistentry>

<varlistentry>
<term>-l|--logfile=logbasename</term>
<listitem><para>File name for log/debug files. The extension
<constant>&quot;.client&quot;</constant> will be appended. The log file is
never removed by the client.
</para></listitem>
</varlistentry>


		<varlistentry>
		<term>-T</term> 
		<listitem><para>This causes any IP addresses found in the 
		lookup to be looked up via a reverse DNS lookup into a 
		DNS name, and printed out before each</para>
		
		<para><emphasis>IP address .... NetBIOS name</emphasis></para>
		
		<para> pair that is the normal output.</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>-f</term>
		<listitem><para>
		Show which flags apply to the name that has been looked up. Possible 
		answers are zero or more of: Response, Authoritative, 
		Truncated, Recursion_Desired, Recursion_Available, Broadcast.
		</para></listitem>
		</varlistentry>


		<varlistentry>
		<term>name</term>
		<listitem><para>This is the NetBIOS name being queried. Depending 
		upon the previous options this may be a NetBIOS name or IP address. 
		If a NetBIOS name then the different name types may be specified 
		by appending '#&lt;type&gt;' to the name. This name may also be
		'*', which will return all registered names within a broadcast 
		area.</para></listitem>
		</varlistentry>
	</variablelist>
</refsect1>


<refsect1>
	<title>EXAMPLES</title>

		<para><command moreinfo="none">nmblookup</command> can be used to query 
		a WINS server (in the same way <command moreinfo="none">nslookup</command> is 
		used to query DNS servers). To query a WINS server, <command moreinfo="none">nmblookup</command> 
		must be called like this:</para>

		<para><command moreinfo="none">nmblookup -U server -R 'name'</command></para>

		<para>For example, running :</para>

		<para><command moreinfo="none">nmblookup -U samba.org -R 'IRIX#1B'</command></para>

		<para>would query the WINS server samba.org for the domain 
		master browser (1B name type) for the IRIX workgroup.</para>
</refsect1>

<refsect1>
	<title>VERSION</title>

	<para>This man page is correct for version 3.0 of 
	the Samba suite.</para>
</refsect1>

<refsect1>
	<title>SEE ALSO</title>
	<para><citerefentry><refentrytitle>nmbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>samba</refentrytitle>
	<manvolnum>7</manvolnum></citerefentry>, and <citerefentry><refentrytitle>smb.conf</refentrytitle>
	<manvolnum>5</manvolnum></citerefentry>.</para>
</refsect1>

<refsect1>
	<title>AUTHOR</title>
	
	<para>The original Samba software and related utilities 
	were created by Andrew Tridgell. Samba is now developed
	by the Samba Team as an Open Source project similar 
	to the way the Linux kernel is developed.</para>
	
	<para>The original Samba man pages were written by Karl Auer. 
	The man page sources were converted to YODL format (another 
	excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
	ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 
	release by Jeremy Allison.  The conversion to DocBook for 
	Samba 2.2 was done by Gerald Carter. The conversion to DocBook
	XML 4.2 for Samba 3.0 was done by Alexander Bokovoy.</para>
</refsect1>

</refentry>