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