docs/manpages-3/nmblookup.1.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
   3 <refentry id="nmblookup">
   4
   5 <refmeta>
   6         <refentrytitle>nmblookup</refentrytitle>
   7         <manvolnum>1</manvolnum>
   8 </refmeta>
   9
  10
  11 <refnamediv>
  12         <refname>nmblookup</refname>
  13         <refpurpose>NetBIOS over TCP/IP client used to lookup NetBIOS
  14         names</refpurpose>
  15 </refnamediv>
  16
  17 <refsynopsisdiv>
  18         <cmdsynopsis>
  19                 <command>nmblookup</command>
  20                 <arg choice="opt">-M</arg>
  21                 <arg choice="opt">-R</arg>
  22                 <arg choice="opt">-S</arg>
  23                 <arg choice="opt">-r</arg>
  24                 <arg choice="opt">-A</arg>
  25                 <arg choice="opt">-h</arg>
  26                 <arg choice="opt">-B &lt;broadcast address&gt;</arg>
  27                 <arg choice="opt">-U &lt;unicast address&gt;</arg>
  28                 <arg choice="opt">-d &lt;debug level&gt;</arg>
  29                 <arg choice="opt">-s &lt;smb config file&gt;</arg>
  30                 <arg choice="opt">-i &lt;NetBIOS scope&gt;</arg>
  31                 <arg choice="opt">-T</arg>
  32                 <arg choice="opt">-f</arg>
  33                 <arg choice="req">name</arg>
  34         </cmdsynopsis>
  35 </refsynopsisdiv>
  36
  37 <refsect1>
  38         <title>DESCRIPTION</title>
  39
  40         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  41         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  42
  43         <para><command>nmblookup</command> is used to query NetBIOS names
  44         and map them to IP addresses in a network using NetBIOS over TCP/IP
  45         queries. The options allow the name queries to be directed at a
  46         particular IP broadcast area or to a particular machine. All queries
  47         are done over UDP.</para>
  48 </refsect1>
  49
  50 <refsect1>
  51         <title>OPTIONS</title>
  52
  53         <variablelist>
  54                 <varlistentry>
  55                 <term>-M</term>
  56                 <listitem><para>Searches for a master browser by looking
  57                 up the  NetBIOS name <replaceable>name</replaceable> with a
  58                 type of <constant>0x1d</constant>. If <replaceable>
  59                 name</replaceable> is "-" then it does a lookup on the special name
  60                 <constant>__MSBROWSE__</constant>. Please note that in order to
  61                 use the name "-", you need to make sure "-" isn't parsed as an
  62                 argument, e.g. use :
  63                 <userinput>nmblookup -M -- -</userinput>.</para></listitem>
  64                 </varlistentry>
  65
  66                 <varlistentry>
  67                 <term>-R</term>
  68                 <listitem><para>Set the recursion desired bit in the packet
  69                 to do a recursive lookup. This is used when sending a name
  70                 query to a machine running a WINS server and the user wishes
  71                 to query the names in the WINS server.  If this bit is unset
  72                 the normal (broadcast responding) NetBIOS processing code
  73                 on a machine is used instead. See RFC1001, RFC1002 for details.
  74                 </para></listitem>
  75                 </varlistentry>
  76
  77                 <varlistentry>
  78                 <term>-S</term>
  79                 <listitem><para>Once the name query has returned an IP
  80                 address then do a node status query as well. A node status
  81                 query returns the NetBIOS names registered by a host.
  82                 </para></listitem>
  83                 </varlistentry>
  84
  85
  86                 <varlistentry>
  87                 <term>-r</term>
  88                 <listitem><para>Try and bind to UDP port 137 to send and receive UDP
  89                 datagrams. The reason for this option is a bug in Windows 95
  90                 where it ignores the source port of the requesting packet
  91                 and only replies to UDP port 137. Unfortunately, on most UNIX
  92                 systems root privilege is needed to bind to this port, and
  93                 in addition, if the <citerefentry><refentrytitle>nmbd</refentrytitle>
  94                 <manvolnum>8</manvolnum></citerefentry> daemon is running on this machine it also binds to this port.
  95                 </para></listitem>
  96                 </varlistentry>
  97
  98
  99                 <varlistentry>
 100                 <term>-A</term>
 101                 <listitem><para>Interpret <replaceable>name</replaceable> as
 102                 an IP Address and do a node status query on this address.</para>
 103                 </listitem>
 104                 </varlistentry>
 105
 106
 107
 108                 &popt.common.connection;
 109                 &stdarg.help;
 110
 111                 <varlistentry>
 112                 <term>-B &lt;broadcast address&gt;</term>
 113                 <listitem><para>Send the query to the given broadcast address. Without
 114                 this option the default behavior of nmblookup is to send the
 115                 query to the broadcast address of the network interfaces as
 116                 either auto-detected or defined in the <ulink
 117                 url="smb.conf.5.html#INTERFACES"><parameter>interfaces</parameter>
 118                 </ulink> parameter of the <citerefentry><refentrytitle>smb.conf</refentrytitle>
 119         <manvolnum>5</manvolnum></citerefentry> file.
 120                 </para></listitem>
 121                 </varlistentry>
 122
 123
 124
 125                 <varlistentry>
 126                 <term>-U &lt;unicast address&gt;</term>
 127                 <listitem><para>Do a unicast query to the specified address or
 128                 host <replaceable>unicast address</replaceable>. This option
 129                 (along with the <parameter>-R</parameter> option) is needed to
 130                 query a WINS server.</para></listitem>
 131                 </varlistentry>
 132
 133                 &stdarg.server.debug;
 134                 &popt.common.samba;
 135
 136                 <varlistentry>
 137                 <term>-T</term>
 138                 <listitem><para>This causes any IP addresses found in the
 139                 lookup to be looked up via a reverse DNS lookup into a
 140                 DNS name, and printed out before each</para>
 141
 142                 <para><emphasis>IP address .... NetBIOS name</emphasis></para>
 143
 144                 <para> pair that is the normal output.</para></listitem>
 145                 </varlistentry>
 146
 147                 <varlistentry>
 148                 <term>-f</term>
 149                 <listitem><para>
 150                 Show which flags apply to the name that has been looked up. Possible
 151                 answers are zero or more of: Response, Authoritative,
 152                 Truncated, Recursion_Desired, Recursion_Available, Broadcast.
 153                 </para></listitem>
 154                 </varlistentry>
 155
 156
 157                 <varlistentry>
 158                 <term>name</term>
 159                 <listitem><para>This is the NetBIOS name being queried. Depending
 160                 upon the previous options this may be a NetBIOS name or IP address.
 161                 If a NetBIOS name then the different name types may be specified
 162                 by appending '#&lt;type&gt;' to the name. This name may also be
 163                 '*', which will return all registered names within a broadcast
 164                 area.</para></listitem>
 165                 </varlistentry>
 166         </variablelist>
 167 </refsect1>
 168
 169
 170 <refsect1>
 171         <title>EXAMPLES</title>
 172
 173                 <para><command>nmblookup</command> can be used to query
 174                 a WINS server (in the same way <command>nslookup</command> is
 175                 used to query DNS servers). To query a WINS server, <command>nmblookup</command>
 176                 must be called like this:</para>
 177
 178                 <para><command>nmblookup -U server -R 'name'</command></para>
 179
 180                 <para>For example, running :</para>
 181
 182                 <para><command>nmblookup -U samba.org -R 'IRIX#1B'</command></para>
 183
 184                 <para>would query the WINS server samba.org for the domain
 185                 master browser (1B name type) for the IRIX workgroup.</para>
 186 </refsect1>
 187
 188 <refsect1>
 189         <title>VERSION</title>
 190
 191         <para>This man page is correct for version 3.0 of
 192         the Samba suite.</para>
 193 </refsect1>
 194
 195 <refsect1>
 196         <title>SEE ALSO</title>
 197         <para><citerefentry><refentrytitle>nmbd</refentrytitle>
 198         <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>samba</refentrytitle>
 199         <manvolnum>7</manvolnum></citerefentry>, and <citerefentry><refentrytitle>smb.conf</refentrytitle>
 200         <manvolnum>5</manvolnum></citerefentry>.</para>
 201 </refsect1>
 202
 203 <refsect1>
 204         <title>AUTHOR</title>
 205
 206         <para>The original Samba software and related utilities
 207         were created by Andrew Tridgell. Samba is now developed
 208         by the Samba Team as an Open Source project similar
 209         to the way the Linux kernel is developed.</para>
 210
 211         <para>The original Samba man pages were written by Karl Auer.
 212         The man page sources were converted to YODL format (another
 213         excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
 214         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
 215         release by Jeremy Allison.  The conversion to DocBook for
 216         Samba 2.2 was done by Gerald Carter. The conversion to DocBook
 217         XML 4.2 for Samba 3.0 was done by Alexander Bokovoy.</para>
 218 </refsect1>
 219
 220 </refentry>