source: trunk/samba/docs/htmldocs/manpages/rpcclient.1.html @ 26

Last change on this file since 26 was 26, checked in by Paul Smedley, 14 years ago

Updated source to 3.0.25rc1

File size: 22.9 KB
Line 
1<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.68.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 &#8212; tool for executing client side
2        MS-RPC functions</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">rpcclient</code>  [-A authfile] [-c &lt;command string&gt;] [-d debuglevel] [-h] [-l logdir] [-N] [-s &lt;smb config file&gt;] [-U username[%password]] [-W workgroup] [-N] [-I destinationIP] {server}</p></div></div><div class="refsect1" lang="en"><a name="id231180"></a><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><span><strong class="command">rpcclient</strong></span> is a utility initially developed
3        to test MS-RPC functionality in Samba itself.  It has undergone
4        several stages of development and stability.  Many system administrators
5        have now written scripts around it to manage Windows NT clients from
6        their UNIX workstation. </p></div><div class="refsect1" lang="en"><a name="id231409"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">server</span></dt><dd><p>NetBIOS name of Server to which to connect.
7                The server can be  any SMB/CIFS server.  The name is
8                resolved using the <a class="indexterm" name="id231427"></a>name resolve order 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
9                below)) </p></dd><dt><span class="term">-I IP-address</span></dt><dd><p><em class="replaceable"><code>IP address</code></em> is the address of the server to connect to.
10                It should be specified in standard "a.b.c.d" notation. </p><p>Normally the client would attempt to locate a named
11                SMB/CIFS server by looking it up via the NetBIOS name resolution
12                mechanism described above in the <em class="parameter"><code>name resolve order</code></em> 
13                parameter above. Using this parameter will force the client
14                to assume that the server is on the machine with the specified IP
15                address and the NetBIOS name component of the resource being
16                connected to will be ignored. </p><p>There is no default for this parameter. If not supplied,
17                it will be determined automatically by the client as described
18                above. </p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the program version number.
19</p></dd><dt><span class="term">-s &lt;configuration file&gt;</span></dt><dd><p>The file specified contains the
20configuration details required by the server.  The
21information in this file includes server-specific
22information such as what printcap file to use, as well
23as descriptions of all the services that the server is
24to provide. See <code class="filename">smb.conf</code> for more information.
25The default configuration file name is determined at
26compile time.</p></dd><dt><span class="term">-d|--debuglevel=level</span></dt><dd><p><em class="replaceable"><code>level</code></em> is an integer
27from 0 to 10.  The default value if this parameter is
28not specified is zero.</p><p>The higher this value, the more detail will be
29logged to the log files about the activities of the
30server. At level 0, only critical errors and serious
31warnings will be logged. Level 1 is a reasonable level for
32day-to-day running - it generates a small amount of
33information about operations carried out.</p><p>Levels above 1 will generate considerable
34amounts of log data, and should only be used when
35investigating a problem. Levels above 3 are designed for
36use only by developers and generate HUGE amounts of log
37data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will
38override the <a class="indexterm" name="id230492"></a> parameter
39in the <code class="filename">smb.conf</code> file.</p></dd><dt><span class="term">-l|--logfile=logdirectory</span></dt><dd><p>Base directory name for log/debug files. The extension
40<code class="constant">".progname"</code> will be appended (e.g. log.smbclient,
41log.smbd, etc...). The log file is never removed by the client.
42</p></dd><dt><span class="term">-N</span></dt><dd><p>If specified, this parameter suppresses the normal
43password prompt from the client to the user. This is useful when
44accessing a service that does not require a password. </p><p>Unless a password is specified on the command line or
45this parameter is specified, the client will request a
46password.</p><p>If a password is specified on the command line and this
47option is also defined the password on the command line will
48be silently ingnored and no password will be used.</p></dd><dt><span class="term">-k</span></dt><dd><p>
49Try to authenticate with kerberos. Only useful in
50an Active Directory environment.
51</p></dd><dt><span class="term">-A|--authentication-file=filename</span></dt><dd><p>This option allows
52you to specify a file from which to read the username and
53password used in the connection.  The format of the file is
54</p><pre class="programlisting">
55username = &lt;value&gt;
56password = &lt;value&gt;
57domain   = &lt;value&gt;
58</pre><p>Make certain that the permissions on the file restrict
59access 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
60client will first check the <code class="envar">USER</code> environment variable, then the
61<code class="envar">LOGNAME</code> variable and if either exists, the
62string is uppercased. If these environmental variables are not
63found, the username <code class="constant">GUEST</code> is used. </p><p>A third option is to use a credentials file which
64contains the plaintext of the username and password.  This
65option is mainly provided for scripts where the admin does not
66wish to pass the credentials on the command line or via environment
67variables. If this method is used, make certain that the permissions
68on the file restrict access from unwanted users.  See the
69<em class="parameter"><code>-A</code></em> for more details. </p><p>Be cautious about including passwords in scripts. Also, on
70many systems the command line of a running process may be seen
71via the <span><strong class="command">ps</strong></span> command.  To be safe always allow
72<span><strong class="command">rpcclient</strong></span> to prompt for a password and type
73it in directly. </p></dd><dt><span class="term">-n &lt;primary NetBIOS name&gt;</span></dt><dd><p>This option allows you to override
74the NetBIOS name that Samba uses for itself. This is identical
75to setting the <a class="indexterm" name="id271744"></a> parameter in the <code class="filename">smb.conf</code> file.
76However, a command
77line setting will take precedence over settings in
78<code class="filename">smb.conf</code>.</p></dd><dt><span class="term">-i &lt;scope&gt;</span></dt><dd><p>This specifies a NetBIOS scope that
79<span><strong class="command">nmblookup</strong></span> will use to communicate with when
80generating NetBIOS names. For details on the use of NetBIOS
81scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are
82<span class="emphasis"><em>very</em></span> rarely used, only set this parameter
83if you are the system administrator in charge of all the
84NetBIOS systems you communicate with.</p></dd><dt><span class="term">-W|--workgroup=domain</span></dt><dd><p>Set the SMB domain of the username.   This
85overrides the default domain which is the domain defined in
86smb.conf.  If the domain specified is the same as the servers
87NetBIOS name, it causes the client to log on using the servers local
88SAM (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
89socket. See the socket options parameter in
90the <code class="filename">smb.conf</code> manual page for the list of valid
91options. </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options.
92</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id271829"></a><h2>COMMANDS</h2><div class="refsect2" lang="en"><a name="id271835"></a><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
93                of SIDs to usernames.
94                </p></dd><dt><span class="term">lookupnames</span></dt><dd><p>Resolve a list
95                of usernames to SIDs.
96                </p></dd><dt><span class="term">enumtrusts</span></dt><dd><p>Enumerate trusted domains</p></dd><dt><span class="term">enumprivs</span></dt><dd><p>Enumerate privileges</p></dd><dt><span class="term">getdispname</span></dt><dd><p>Get the privilege name</p></dd><dt><span class="term">lsaenumsid</span></dt><dd><p>Enumerate the LSA SIDS</p></dd><dt><span class="term">lsaenumprivsaccount</span></dt><dd><p>Enumerate the privileges of an SID</p></dd><dt><span class="term">lsaenumacctrights</span></dt><dd><p>Enumerate the rights of an SID</p></dd><dt><span class="term">lsaenumacctwithright</span></dt><dd><p>Enumerate accounts with a right</p></dd><dt><span class="term">lsaaddacctrights</span></dt><dd><p>Add rights to an account</p></dd><dt><span class="term">lsaremoveacctrights</span></dt><dd><p>Remove rights from an account</p></dd><dt><span class="term">lsalookupprivvalue</span></dt><dd><p>Get a privilege value given its name</p></dd><dt><span class="term">lsaquerysecobj</span></dt><dd><p>Query LSA security object</p></dd></dl></div></div><div class="refsect2" lang="en"><a name="id271959"></a><h3>LSARPC-DS</h3><div class="variablelist"><dl><dt><span class="term">dsroledominfo</span></dt><dd><p>Get Primary Domain Information</p></dd></dl></div><p> </p><p><span class="emphasis"><em>DFS</em></span></p><div class="variablelist"><dl><dt><span class="term">dfsexist</span></dt><dd><p>Query DFS support</p></dd><dt><span class="term">dfsadd</span></dt><dd><p>Add a DFS share</p></dd><dt><span class="term">dfsremove</span></dt><dd><p>Remove a DFS share</p></dd><dt><span class="term">dfsgetinfo</span></dt><dd><p>Query DFS share info</p></dd><dt><span class="term">dfsenum</span></dt><dd><p>Enumerate dfs shares</p></dd></dl></div></div><div class="refsect2" lang="en"><a name="id272028"></a><h3>REG</h3><div class="variablelist"><dl><dt><span class="term">shutdown</span></dt><dd><p>Remote Shutdown</p></dd><dt><span class="term">abortshutdown</span></dt><dd><p>Abort Shutdown</p></dd></dl></div></div><div class="refsect2" lang="en"><a name="id272053"></a><h3>SRVSVC</h3><div class="variablelist"><dl><dt><span class="term">srvinfo</span></dt><dd><p>Server query info</p></dd><dt><span class="term">netshareenum</span></dt><dd><p>Enumerate shares</p></dd><dt><span class="term">netfileenum</span></dt><dd><p>Enumerate open files</p></dd><dt><span class="term">netremotetod</span></dt><dd><p>Fetch remote time of day</p></dd></dl></div></div><div class="refsect2" lang="en"><a name="id272095"></a><h3>SAMR</h3><div class="variablelist"><dl><dt><span class="term">queryuser</span></dt><dd><p>Query user info</p></dd><dt><span class="term">querygroup</span></dt><dd><p>Query group info</p></dd><dt><span class="term">queryusergroups</span></dt><dd><p>Query user groups</p></dd><dt><span class="term">querygroupmem</span></dt><dd><p>Query group membership</p></dd><dt><span class="term">queryaliasmem</span></dt><dd><p>Query alias membership</p></dd><dt><span class="term">querydispinfo</span></dt><dd><p>Query display info</p></dd><dt><span class="term">querydominfo</span></dt><dd><p>Query domain info</p></dd><dt><span class="term">enumdomusers</span></dt><dd><p>Enumerate domain users</p></dd><dt><span class="term">enumdomgroups</span></dt><dd><p>Enumerate domain groups</p></dd><dt><span class="term">enumalsgroups</span></dt><dd><p>Enumerate alias groups</p></dd><dt><span class="term">createdomuser</span></dt><dd><p>Create domain user</p></dd><dt><span class="term">samlookupnames</span></dt><dd><p>Look up names</p></dd><dt><span class="term">samlookuprids</span></dt><dd><p>Look up names</p></dd><dt><span class="term">deletedomuser</span></dt><dd><p>Delete domain user</p></dd><dt><span class="term">samquerysecobj</span></dt><dd><p>Query SAMR security object</p></dd><dt><span class="term">getdompwinfo</span></dt><dd><p>Retrieve domain password info</p></dd><dt><span class="term">lookupdomain</span></dt><dd><p>Look up domain</p></dd></dl></div></div><div class="refsect2" lang="en"><a name="id272241"></a><h3>SPOOLSS</h3><div class="variablelist"><dl><dt><span class="term">adddriver &lt;arch&gt; &lt;config&gt; [&lt;version&gt;]</span></dt><dd><p>
97                Execute an AddPrinterDriver() RPC to install the printer driver
98                information on the server.  Note that the driver files should
99                already exist in the directory returned by 
100                <span><strong class="command">getdriverdir</strong></span>.  Possible values for
101                <em class="parameter"><code>arch</code></em> are the same as those for
102                the <span><strong class="command">getdriverdir</strong></span> command.
103                The <em class="parameter"><code>config</code></em> parameter is defined as
104                follows: </p><pre class="programlisting">
105Long Printer Name:\
106Driver File Name:\
107Data File Name:\
108Config File Name:\
109Help File Name:\
110Language Monitor Name:\
111Default Data Type:\
112Comma Separated list of Files
113</pre><p>Any empty fields should be enter as the string "NULL". </p><p>Samba does not need to support the concept of Print Monitors
114                since these only apply to local printers whose driver can make
115                use of a bi-directional link for communication.  This field should
116                be "NULL".   On a remote NT print server, the Print Monitor for a
117                driver must already be installed prior to adding the driver or
118                else the RPC will fail. </p><p>The <em class="parameter"><code>version</code></em> parameter lets you
119                specify the printer driver version number.  If omitted, the
120                default driver version for the specified architecture will
121                be used.  This option can be used to upload Windows 2000
122                (version 3) printer drivers.</p></dd><dt><span class="term">addprinter &lt;printername&gt; 
123                &lt;sharename&gt; &lt;drivername&gt; &lt;port&gt;</span></dt><dd><p>
124                Add a printer on the remote server.  This printer
125                will be automatically shared.  Be aware that the printer driver
126                must already be installed on the server (see <span><strong class="command">adddriver</strong></span>)
127                and the <em class="parameter"><code>port</code></em>must be a valid port name (see
128                <span><strong class="command">enumports</strong></span>.</p></dd><dt><span class="term">deldriver</span></dt><dd><p>Delete the
129                specified printer driver for all architectures.  This
130                does not delete the actual driver files from the server,
131                only the entry from the server's list of drivers.
132                </p></dd><dt><span class="term">deldriverex &lt;driver&gt; [architecture] [version]
133                </span></dt><dd><p>Delete the specified printer driver including driver files.
134                You can limit this action to a specific architecture and a specific version.
135                If no architecure is given, all driver files of that driver will be deleted.
136                </p></dd><dt><span class="term">enumdata</span></dt><dd><p>Enumerate all
137                printer setting data stored on the server. On Windows NT  clients,
138                these values are stored  in the registry, while Samba servers
139                store them in the printers TDB.  This command corresponds
140                to the MS Platform SDK GetPrinterData() function (* This
141                command is currently unimplemented).</p></dd><dt><span class="term">enumdataex</span></dt><dd><p>Enumerate printer data for a key</p></dd><dt><span class="term">enumjobs &lt;printer&gt;</span></dt><dd><p>List the jobs and status of a given printer.
142                This command corresponds to the MS Platform SDK EnumJobs()
143                function</p></dd><dt><span class="term">enumkey</span></dt><dd><p>Enumerate
144                printer keys</p></dd><dt><span class="term">enumports [level]</span></dt><dd><p>
145                Executes an EnumPorts() call using the specified
146                info level. Currently only info levels 1 and 2 are supported.
147                </p></dd><dt><span class="term">enumdrivers [level]</span></dt><dd><p>
148                Execute an EnumPrinterDrivers() call.  This lists the various installed
149                printer drivers for all architectures.  Refer to the MS Platform SDK
150                documentation for more details of the various flags and calling
151                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
152                and share printers.  Refer to the MS Platform SDK documentation for
153                more details of the various flags and calling options. Currently
154                supported info levels are 1, 2 and 5.</p></dd><dt><span class="term">getdata &lt;printername&gt; &lt;valuename;&gt;</span></dt><dd><p>Retrieve the data for a given printer setting.  See
155                the  <span><strong class="command">enumdata</strong></span> command for more information. 
156                This command corresponds to the GetPrinterData() MS Platform
157                SDK function. </p></dd><dt><span class="term">getdataex</span></dt><dd><p>Get
158                printer driver data with
159                keyname</p></dd><dt><span class="term">getdriver &lt;printername&gt;</span></dt><dd><p>
160                Retrieve the printer driver information (such as driver file,
161                config file, dependent files, etc...) for
162                the given printer. This command corresponds to the GetPrinterDriver()
163                MS Platform  SDK function. Currently info level 1, 2, and 3 are supported.
164                </p></dd><dt><span class="term">getdriverdir &lt;arch&gt;</span></dt><dd><p>
165                Execute a GetPrinterDriverDirectory()
166                RPC to retrieve the SMB share name and subdirectory for
167                storing printer driver files for a given architecture.  Possible
168                values for <em class="parameter"><code>arch</code></em> are "Windows 4.0"
169                (for Windows 95/98), "Windows NT x86", "Windows NT PowerPC", "Windows
170                Alpha_AXP", and "Windows NT R4000". </p></dd><dt><span class="term">getprinter &lt;printername&gt;</span></dt><dd><p>Retrieve the current printer information.  This command
171                corresponds to the GetPrinter() MS Platform SDK function.
172                </p></dd><dt><span class="term">getprintprocdir</span></dt><dd><p>Get
173                print processor
174                directory</p></dd><dt><span class="term">openprinter &lt;printername&gt;</span></dt><dd><p>Execute an OpenPrinterEx() and ClosePrinter() RPC
175                against a given printer. </p></dd><dt><span class="term">setdriver &lt;printername&gt;
176                &lt;drivername&gt;</span></dt><dd><p>Execute a SetPrinter() command to update the printer driver
177                associated with an installed printer.  The printer driver must
178                already be correctly installed on the print server.  </p><p>See also the <span><strong class="command">enumprinters</strong></span> and
179                <span><strong class="command">enumdrivers</strong></span> commands for obtaining a list of
180                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">setprintername &lt;printername&gt;
181                &lt;newprintername&gt;</span></dt><dd><p>Set printer name</p></dd><dt><span class="term">rffpcnex</span></dt><dd><p>Rffpcnex test</p></dd></dl></div></div><div class="refsect2" lang="en"><a name="id272617"></a><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"><a name="id272677"></a><h3>GENERAL COMMANDS</h3><div class="variablelist"><dl><dt><span class="term">debuglevel</span></dt><dd><p>Set the current
182                debug level used to log information.</p></dd><dt><span class="term">help (?)</span></dt><dd><p>Print a listing of all
183                known commands or extended help  on a particular command.
184                </p></dd><dt><span class="term">quit (exit)</span></dt><dd><p>Exit <span><strong class="command">rpcclient
185                </strong></span>.</p></dd></dl></div></div></div><div class="refsect1" lang="en"><a name="id272719"></a><h2>BUGS</h2><p><span><strong class="command">rpcclient</strong></span> is designed as a developer testing tool
186        and may not be robust in certain areas (such as command line parsing). 
187        It has been known to  generate a core dump upon failures when invalid
188        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
189        been developed from examining  Network traces. No documentation is
190        available from the original creators  (Microsoft) on how MSRPC over
191        SMB works, or how the individual MSRPC services  work. Microsoft's
192        implementation of these services has been demonstrated  (and reported)
193        to be... a bit flaky in places. </p><p>The development of Samba's implementation is also a bit rough,
194        and as more of the services are understood, it can even result in
195        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,
196        the developers are sending reports to Microsoft,  and problems found
197        or reported to Microsoft are fixed in Service Packs,  which may
198        result in incompatibilities.</p></div><div class="refsect1" lang="en"><a name="id272770"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba
199        suite.</p></div><div class="refsect1" lang="en"><a name="id272781"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities
200        were created by Andrew Tridgell. Samba is now developed
201        by the Samba Team as an Open Source project similar
202        to the way the Linux kernel is developed.</p><p>The original rpcclient man page was written by Matthew
203        Geddes, Luke Kenneth Casson Leighton, and rewritten by Gerald Carter. 
204        The conversion to DocBook for Samba 2.2 was done by Gerald
205        Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was
206        done by Alexander Bokovoy.</p></div></div></body></html>
Note: See TracBrowser for help on using the repository browser.