-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>rpcclient</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="rpcclient.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>rpcclient — tool for executing client side
- MS-RPC functions</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt>rpcclient</tt> [-A authfile] [-c <command string>] [-d debuglevel] [-h] [-l logfile] [-N] [-s <smb config file>] [-U username[%password]] [-W workgroup] [-N] [-I destinationIP] {server}</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>rpcclient</b> is a utility initially developed
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>rpcclient</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.
60.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="rpcclient.1"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>Name</h2><p>rpcclient — tool for executing client side
+ MS-RPC functions</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt class="command">rpcclient</tt> [-A authfile] [-c <command string>] [-d debuglevel] [-h] [-l logfile] [-N] [-s <smb config file>] [-U username[%password]] [-W workgroup] [-N] [-I destinationIP] {server}</p></div></div><div class="refsect1" lang="en"><h2>DESCRIPTION</h2><p>This tool is part of the <a href="Samba.7.html"><span class="citerefentry"><span class="refentrytitle">Samba</span>(7)</span></a> suite.</p><p><b class="command">rpcclient</b> is a utility initially developed
to test MS-RPC functionality in Samba itself. It has undergone
several stages of development and stability. Many system administrators
have now written scripts around it to manage Windows NT clients from
their UNIX workstation. </p></div><div class="refsect1" lang="en"><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">server</span></dt><dd><p>NetBIOS name of Server to which to connect.
The server can be any SMB/CIFS server. The name is
resolved using the <a href="smb.conf.5.html#NAMERESOLVEORDER" target="_top">
- <i
><tt>name resolve order</tt></i></a> line from <a href="smb.conf.5.html">smb.conf(5)</a>.</p></dd><dt><span class="term">-c|--command='command string'</span></dt><dd><p>execute semicolon separated commands (listed
- below)) </p></dd><dt><span class="term">-I IP-address</span></dt><dd><p><i><tt>IP address</tt></i> is the address of the server to connect to.
+ <i
class="parameter"><tt>name resolve order</tt></i></a> line from <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a>.</p></dd><dt><span class="term">-c|--command='command string'</span></dt><dd><p>execute semicolon separated commands (listed
+ below)) </p></dd><dt><span class="term">-I IP-address</span></dt><dd><p><i class="replaceable"><tt>IP address</tt></i> is the address of the server to connect to.
It should be specified in standard "a.b.c.d" notation. </p><p>Normally the client would attempt to locate a named
SMB/CIFS server by looking it up via the NetBIOS name resolution
- mechanism described above in the <i><tt>name resolve order</tt></i>
+ mechanism described above in the <i class="parameter"><tt>name resolve order</tt></i>
parameter above. Using this parameter will force the client
to assume that the server is on the machine with the specified IP
address and the NetBIOS name component of the resource being
connected to will be ignored. </p><p>There is no default for this parameter. If not supplied,
it will be determined automatically by the client as described
above. </p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the version number for
-<b>smbd</b>.</p></dd><dt><span class="term">-s <configuration file></span></dt><dd><p>The file specified contains the
+<b
class="command">smbd</b>.</p></dd><dt><span class="term">-s <configuration file></span></dt><dd><p>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 <a href="smb.conf.5.html" target="_top"><tt>
+to provide. See <a href="smb.conf.5.html" target="_top"><tt class="filename">
smb.conf(5)</tt></a> for more information.
The default configuration file name is determined at
-compile time.</p></dd><dt><span class="term">-d|--debug=debuglevel</span></dt><dd><p><i><tt>debuglevel</tt></i> is an integer
+compile time.</p></dd><dt><span class="term">-d|--debug=debuglevel</span></dt><dd><p><i class="replaceable"><tt>debuglevel</tt></i> is an integer
from 0 to 10. The default value if this parameter is
not specified is zero.</p><p>The higher this value, the more detail will be
logged to the log files about the activities of the
data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will
override the <a href="smb.conf.5.html#loglevel" target="_top">log
level</a> parameter in the <a href="smb.conf.5.html" target="_top">
-<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
-<tt>".client"</tt> will be appended. The log file is
+<tt
class="filename">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
+<tt class="constant">".client"</tt> will be appended. The log file is
never removed by the client.
</p></dd><dt><span class="term">-N</span></dt><dd><p>If specified, this parameter suppresses the normal
password prompt from the client to the user. This is useful when
domain = <value>
</pre><p>Make certain that the permissions on the file restrict
access from unwanted users. </p></dd><dt><span class="term">-U|--user=username[%password]</span></dt><dd><p>Sets the SMB username or username and password. </p><p>If %password is not specified, the user will be prompted. The
-client will first check the <tt>USER</tt> environment variable, then the
-<tt>LOGNAME</tt> variable and if either exists, the
+client will first check the <tt class="envar">USER</tt> environment variable, then the
+<tt class="envar">LOGNAME</tt> variable and if either exists, the
string is uppercased. If these environmental variables are not
-found, the username <tt>GUEST</tt> is used. </p><p>A third option is to use a credentials file which
+found, the username <tt
class="constant">GUEST</tt> is used. </p><p>A third option is to use a credentials file which
contains the plaintext of the username and password. This
option is mainly provided for scripts where the admin does not
wish to pass the credentials on the command line or via environment
variables. If this method is used, make certain that the permissions
on the file restrict access from unwanted users. See the
-<i><tt>-A</tt></i> for more details. </p><p>Be cautious about including passwords in scripts. Also, on
+<i
class="parameter"><tt>-A</tt></i> for more details. </p><p>Be cautious about including passwords in scripts. Also, on
many systems the command line of a running process may be seen
-via the <b>ps</b> command. To be safe always allow
-<b>rpcclient</b> to prompt for a password and type
+via the <b class="command">ps</b> command. To be safe always allow
+<b class="command">rpcclient</b> to prompt for a password and type
it in directly. </p></dd><dt><span class="term">-n <primary NetBIOS name></span></dt><dd><p>This option allows you to override
the NetBIOS name that Samba uses for itself. This is identical
-to setting the <a href="smb.conf.5.html#netbiosname" target="_top"><i><tt>NetBIOS
-name</tt></i></a> parameter in the <a href="smb.conf.5.html">smb.conf(5)</a> file. However, a command
+to setting the <a href="smb.conf.5.html#netbiosname" target="_top"><i class="parameter"><tt>NetBIOS
+name</tt></i></a> parameter in the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file. However, a command
line setting will take precedence over settings in
-<a href="smb.conf.5.html">
smb.conf(5)</a>.</p></dd><dt><span class="term">-i <scope></span></dt><dd><p>This specifies a NetBIOS scope that
-<b>nmblookup</b> will use to communicate with when
+<a href="smb.conf.5.html">
<span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a>.</p></dd><dt><span class="term">-i <scope></span></dt><dd><p>This specifies a NetBIOS scope that
+<b class="command">nmblookup</b> 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
<span class="emphasis"><em>very</em></span> rarely used, only set this parameter
NetBIOS name, it causes the client to log on using the servers local
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
socket. See the socket options parameter in
-the <a href="smb.conf.5.html">smb.conf(5)</a> manual page for the list of valid
+the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> manual page for the list of valid
options. </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options.
</p></dd></dl></div></div><div class="refsect1" lang="en"><h2>COMMANDS</h2><div class="refsect2" lang="en"><h3>LSARPC</h3><div class="variablelist"><dl><dt><span class="term">lsaquery</span></dt><dd><p>Query info policy</p></dd><dt><span class="term">lookupsids</span></dt><dd><p>Resolve a list
of SIDs to usernames.
Execute an AddPrinterDriver() RPC to install the printer driver
information on the server. Note that the driver files should
already exist in the directory returned by
- <b>getdriverdir</b>. Possible values for
- <i><tt>arch</tt></i> are the same as those for
- the <b>getdriverdir</b> command.
- The <i><tt>config</tt></i> parameter is defined as
+ <b class="command">getdriverdir</b>. Possible values for
+ <i class="parameter"><tt>arch</tt></i> are the same as those for
+ the <b class="command">getdriverdir</b> command.
+ The <i class="parameter"><tt>config</tt></i> parameter is defined as
follows: </p><pre class="programlisting">
Long Printer Name:\
Driver File Name:\
<sharename> <drivername> <port></span></dt><dd><p>
Add a printer on the remote server. This printer
will be automatically shared. Be aware that the printer driver
- must already be installed on the server (see <b>adddriver</b>)
- and the <i><tt>port</tt></i>must be a valid port name (see
- <b>enumports</b>.</p></dd><dt><span class="term">deldriver</span></dt><dd><p>Delete the
+ must already be installed on the server (see <b class="command">adddriver</b>)
+ and the <i class="parameter"><tt>port</tt></i>must be a valid port name (see
+ <b
class="command">enumports</b>.</p></dd><dt><span class="term">deldriver</span></dt><dd><p>Delete the
specified printer driver for all architectures. This
does not delete the actual driver files from the server,
only the entry from the server's list of drivers.
options. Currently supported info levels are 1, 2, and 3.</p></dd><dt><span class="term">enumprinters [level]</span></dt><dd><p>Execute an EnumPrinters() call. This lists the various installed
and share printers. Refer to the MS Platform SDK documentation for
more details of the various flags and calling options. Currently
- supported info levels are
0, 1, and 2.</p></dd><dt><span class="term">getdata <printername> <valuename;></span></dt><dd><p>Retrieve the data for a given printer setting. See
- the <b>enumdata</b> command for more information.
+ supported info levels are
1, 2 and 5.</p></dd><dt><span class="term">getdata <printername> <valuename;></span></dt><dd><p>Retrieve the data for a given printer setting. See
+ the <b class="command">enumdata</b> command for more information.
This command corresponds to the GetPrinterData() MS Platform
SDK function. </p></dd><dt><span class="term">getdataex</span></dt><dd><p>Get
printer driver data with
Execute a GetPrinterDriverDirectory()
RPC to retrieve the SMB share name and subdirectory for
storing printer driver files for a given architecture. Possible
- values for <i><tt>arch</tt></i> are "Windows 4.0"
+ values for <i class="parameter"><tt>arch</tt></i> are "Windows 4.0"
(for Windows 95/98), "Windows NT x86", "Windows NT PowerPC", "Windows
Alpha_AXP", and "Windows NT R4000". </p></dd><dt><span class="term">getprinter <printername></span></dt><dd><p>Retrieve the current printer information. This command
corresponds to the GetPrinter() MS Platform SDK function.
against a given printer. </p></dd><dt><span class="term">setdriver <printername>
<drivername></span></dt><dd><p>Execute a SetPrinter() command to update the printer driver
associated with an installed printer. The printer driver must
- already be correctly installed on the print server. </p><p>See also the <b>enumprinters</b> and
- <b>enumdrivers</b> commands for obtaining a list of
+ already be correctly installed on the print server. </p><p>See also the <b class="command">enumprinters</b> and
+ <b class="command">enumdrivers</b> commands for obtaining a list of
of installed printers and drivers.</p></dd><dt><span class="term">addform</span></dt><dd><p>Add form</p></dd><dt><span class="term">setform</span></dt><dd><p>Set form</p></dd><dt><span class="term">getform</span></dt><dd><p>Get form</p></dd><dt><span class="term">deleteform</span></dt><dd><p>Delete form</p></dd><dt><span class="term">enumforms</span></dt><dd><p>Enumerate form</p></dd><dt><span class="term">setprinter</span></dt><dd><p>Set printer comment</p></dd><dt><span class="term">setprinterdata</span></dt><dd><p>Set REG_SZ printer data</p></dd><dt><span class="term">rffpcnex</span></dt><dd><p>Rffpcnex test</p></dd></dl></div></div><div class="refsect2" lang="en"><h3>NETLOGON</h3><div class="variablelist"><dl><dt><span class="term">logonctrl2</span></dt><dd><p>Logon Control 2</p></dd><dt><span class="term">logonctrl</span></dt><dd><p>Logon Control</p></dd><dt><span class="term">samsync</span></dt><dd><p>Sam Synchronisation</p></dd><dt><span class="term">samdeltas</span></dt><dd><p>Query Sam Deltas</p></dd><dt><span class="term">samlogon</span></dt><dd><p>Sam Logon</p></dd></dl></div></div><div class="refsect2" lang="en"><h3>GENERAL COMMANDS</h3><div class="variablelist"><dl><dt><span class="term">debuglevel</span></dt><dd><p>Set the current
debug level used to log information.</p></dd><dt><span class="term">help (?)</span></dt><dd><p>Print a listing of all
known commands or extended help on a particular command.
- </p></dd><dt><span class="term">quit (exit)</span></dt><dd><p>Exit <b>rpcclient
- </b>.</p></dd></dl></div></div></div><div class="refsect1" lang="en"><h2>BUGS</h2><p><b>rpcclient</b> is designed as a developer testing tool
+ </p></dd><dt><span class="term">quit (exit)</span></dt><dd><p>Exit <b class="command">rpcclient
+ </b>.</p></dd></dl></div></div></div><div class="refsect1" lang="en"><h2>BUGS</h2><p><b class="command">rpcclient</b> is designed as a developer testing tool
and may not be robust in certain areas (such as command line parsing).
It has been known to generate a core dump upon failures when invalid
parameters where passed to the interpreter. </p><p>From Luke Leighton's original rpcclient man page:</p><p><span class="emphasis"><em>WARNING!</em></span> The MSRPC over SMB code has
implementation of these services has been demonstrated (and reported)
to be... a bit flaky in places. </p><p>The development of Samba's implementation is also a bit rough,
and as more of the services are understood, it can even result in
- versions of <a href="smbd.8.html">smbd(8)</a> and <a href="rpcclient.1.html">rpcclient(1)</a> that are incompatible for some commands or services. Additionally,
+ versions of <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> and <a href="rpcclient.1.html"><span class="citerefentry"><span class="refentrytitle">rpcclient</span>(1)</span></a> that are incompatible for some commands or services. Additionally,
the developers are sending reports to Microsoft, and problems found
or reported to Microsoft are fixed in Service Packs, which may
result in incompatibilities.</p></div><div class="refsect1" lang="en"><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba
git.samba.org / kai / samba-autobuild / .git / blobdiff