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