source: branches/samba-3.3.x/docs/htmldocs/manpages/rpcclient.1.html

Last change on this file was 411, checked in by Herwig Bauernfeind, 15 years ago

Update Samba 3.3.x to 3.3.11
File size: 23.1 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.74.0"></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="literal">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="id2483375"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a class="citerefentry" href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p><code class="literal">rpcclient</code> 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="id2483528"></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="link" href="smb.conf.5.html#NAMERESOLVEORDER" target="_top">name resolve order</a> line from <a class="citerefentry" 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">-d|--debuglevel=level</span></dt><dd><p><em class="replaceable"><code>level</code></em> is an integer
19from 0 to 10. The default value if this parameter is
20not specified is 0.</p><p>The higher this value, the more detail will be
21logged to the log files about the activities of the
22server. At level 0, only critical errors and serious
23warnings will be logged. Level 1 is a reasonable level for
24day-to-day running - it generates a small amount of
25information about operations carried out.</p><p>Levels above 1 will generate considerable
26amounts of log data, and should only be used when
27investigating a problem. Levels above 3 are designed for
28use only by developers and generate HUGE amounts of log
29data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will
30override the <a class="link" href="smb.conf.5.html#" target="_top"></a> parameter
31in the <code class="filename">smb.conf</code> file.</p></dd><dt><span class="term">-V|--version</span></dt><dd><p>Prints the program version number.
32</p></dd><dt><span class="term">-s|--configfile &lt;configuration file&gt;</span></dt><dd><p>The file specified contains the
33configuration details required by the server. The
34information in this file includes server-specific
35information such as what printcap file to use, as well
36as descriptions of all the services that the server is
37to provide. See <code class="filename">smb.conf</code> for more information.
38The default configuration file name is determined at
39compile time.</p></dd><dt><span class="term">-l|--log-basename=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|--no-pass</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|--kerberos</span></dt><dd><p>
49Try to authenticate with kerberos. Only useful in
50an Active Directory environment.
51</p></dd><dt><span class="term">-C|--use-ccache</span></dt><dd><p>
52Try to use the credentials cached by winbind.
53</p></dd><dt><span class="term">-A|--authentication-file=filename</span></dt><dd><p>This option allows
54you to specify a file from which to read the username and
55password used in the connection. The format of the file is
56</p><pre class="programlisting">
57username = &lt;value&gt;
58password = &lt;value&gt;
59domain = &lt;value&gt;
60</pre><p>Make certain that the permissions on the file restrict
61access 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
62client will first check the <code class="envar">USER</code> environment variable, then the
63<code class="envar">LOGNAME</code> variable and if either exists, the
64string is uppercased. If these environmental variables are not
65found, the username <code class="constant">GUEST</code> is used. </p><p>A third option is to use a credentials file which
66contains the plaintext of the username and password. This
67option is mainly provided for scripts where the admin does not
68wish to pass the credentials on the command line or via environment
69variables. If this method is used, make certain that the permissions
70on the file restrict access from unwanted users. See the
71<em class="parameter"><code>-A</code></em> for more details. </p><p>Be cautious about including passwords in scripts. Also, on
72many systems the command line of a running process may be seen
73via the <code class="literal">ps</code> command. To be safe always allow
74<code class="literal">rpcclient</code> to prompt for a password and type
75it in directly. </p></dd><dt><span class="term">-n|--netbiosname &lt;primary NetBIOS name&gt;</span></dt><dd><p>This option allows you to override
76the NetBIOS name that Samba uses for itself. This is identical
77to setting the <a class="link" href="smb.conf.5.html#" target="_top"></a> parameter in the <code class="filename">smb.conf</code> file.
78However, a command
79line setting will take precedence over settings in
80<code class="filename">smb.conf</code>.</p></dd><dt><span class="term">-i|--scope &lt;scope&gt;</span></dt><dd><p>This specifies a NetBIOS scope that
81<code class="literal">nmblookup</code> will use to communicate with when
82generating NetBIOS names. For details on the use of NetBIOS
83scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are
84<span class="emphasis"><em>very</em></span> rarely used, only set this parameter
85if you are the system administrator in charge of all the
86NetBIOS 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
87overrides the default domain which is the domain defined in
88smb.conf. If the domain specified is the same as the servers
89NetBIOS name, it causes the client to log on using the servers local
90SAM (as opposed to the Domain SAM). </p></dd><dt><span class="term">-O|--socket-options socket options</span></dt><dd><p>TCP socket options to set on the client
91socket. See the socket options parameter in
92the <code class="filename">smb.conf</code> manual page for the list of valid
93options. </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options.
94</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2481745"></a><h2>COMMANDS</h2><div class="refsect2" lang="en"><a name="id2481751"></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
95 of SIDs to usernames.
96 </p></dd><dt><span class="term">lookupnames</span></dt><dd><p>Resolve a list
97 of usernames to SIDs.
98 </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="id2481876"></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="id2481945"></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="id2481972"></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="id2482014"></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="id2532616"></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>
99 Execute an AddPrinterDriver() RPC to install the printer driver
100 information on the server. Note that the driver files should
101 already exist in the directory returned by
102 <code class="literal">getdriverdir</code>. Possible values for
103 <em class="parameter"><code>arch</code></em> are the same as those for
104 the <code class="literal">getdriverdir</code> command.
105 The <em class="parameter"><code>config</code></em> parameter is defined as
106 follows: </p><pre class="programlisting">
107Long Printer Name:\
108Driver File Name:\
109Data File Name:\
110Config File Name:\
111Help File Name:\
112Language Monitor Name:\
113Default Data Type:\
114Comma Separated list of Files
115</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
116 since these only apply to local printers whose driver can make
117 use of a bi-directional link for communication. This field should
118 be "NULL". On a remote NT print server, the Print Monitor for a
119 driver must already be installed prior to adding the driver or
120 else the RPC will fail. </p><p>The <em class="parameter"><code>version</code></em> parameter lets you
121 specify the printer driver version number. If omitted, the
122 default driver version for the specified architecture will
123 be used. This option can be used to upload Windows 2000
124 (version 3) printer drivers.</p></dd><dt><span class="term">addprinter &lt;printername&gt;
125 &lt;sharename&gt; &lt;drivername&gt; &lt;port&gt;</span></dt><dd><p>
126 Add a printer on the remote server. This printer
127 will be automatically shared. Be aware that the printer driver
128 must already be installed on the server (see <code class="literal">adddriver</code>)
129 and the <em class="parameter"><code>port</code></em>must be a valid port name (see
130 <code class="literal">enumports</code>.</p></dd><dt><span class="term">deldriver</span></dt><dd><p>Delete the
131 specified printer driver for all architectures. This
132 does not delete the actual driver files from the server,
133 only the entry from the server's list of drivers.
134 </p></dd><dt><span class="term">deldriverex &lt;driver&gt; [architecture] [version]
135 </span></dt><dd><p>Delete the specified printer driver including driver files.
136 You can limit this action to a specific architecture and a specific version.
137 If no architecure is given, all driver files of that driver will be deleted.
138 </p></dd><dt><span class="term">enumdata</span></dt><dd><p>Enumerate all
139 printer setting data stored on the server. On Windows NT clients,
140 these values are stored in the registry, while Samba servers
141 store them in the printers TDB. This command corresponds
142 to the MS Platform SDK GetPrinterData() function (* This
143 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.
144 This command corresponds to the MS Platform SDK EnumJobs()
145 function</p></dd><dt><span class="term">enumkey</span></dt><dd><p>Enumerate
146 printer keys</p></dd><dt><span class="term">enumports [level]</span></dt><dd><p>
147 Executes an EnumPorts() call using the specified
148 info level. Currently only info levels 1 and 2 are supported.
149 </p></dd><dt><span class="term">enumdrivers [level]</span></dt><dd><p>
150 Execute an EnumPrinterDrivers() call. This lists the various installed
151 printer drivers for all architectures. Refer to the MS Platform SDK
152 documentation for more details of the various flags and calling
153 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
154 and share printers. Refer to the MS Platform SDK documentation for
155 more details of the various flags and calling options. Currently
156 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
157 the <code class="literal">enumdata</code> command for more information.
158 This command corresponds to the GetPrinterData() MS Platform
159 SDK function. </p></dd><dt><span class="term">getdataex</span></dt><dd><p>Get
160 printer driver data with
161 keyname</p></dd><dt><span class="term">getdriver &lt;printername&gt;</span></dt><dd><p>
162 Retrieve the printer driver information (such as driver file,
163 config file, dependent files, etc...) for
164 the given printer. This command corresponds to the GetPrinterDriver()
165 MS Platform SDK function. Currently info level 1, 2, and 3 are supported.
166 </p></dd><dt><span class="term">getdriverdir &lt;arch&gt;</span></dt><dd><p>
167 Execute a GetPrinterDriverDirectory()
168 RPC to retrieve the SMB share name and subdirectory for
169 storing printer driver files for a given architecture. Possible
170 values for <em class="parameter"><code>arch</code></em> are "Windows 4.0"
171 (for Windows 95/98), "Windows NT x86", "Windows NT PowerPC", "Windows
172 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
173 corresponds to the GetPrinter() MS Platform SDK function.
174 </p></dd><dt><span class="term">getprintprocdir</span></dt><dd><p>Get
175 print processor
176 directory</p></dd><dt><span class="term">openprinter &lt;printername&gt;</span></dt><dd><p>Execute an OpenPrinterEx() and ClosePrinter() RPC
177 against a given printer. </p></dd><dt><span class="term">setdriver &lt;printername&gt;
178 &lt;drivername&gt;</span></dt><dd><p>Execute a SetPrinter() command to update the printer driver
179 associated with an installed printer. The printer driver must
180 already be correctly installed on the print server. </p><p>See also the <code class="literal">enumprinters</code> and
181 <code class="literal">enumdrivers</code> commands for obtaining a list of
182 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;
183 &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="id2533011"></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="id2533069"></a><h3>GENERAL COMMANDS</h3><div class="variablelist"><dl><dt><span class="term">debuglevel</span></dt><dd><p>Set the current
184 debug level used to log information.</p></dd><dt><span class="term">help (?)</span></dt><dd><p>Print a listing of all
185 known commands or extended help on a particular command.
186 </p></dd><dt><span class="term">quit (exit)</span></dt><dd><p>Exit <code class="literal">rpcclient
187 </code>.</p></dd></dl></div></div></div><div class="refsect1" lang="en"><a name="id2533110"></a><h2>BUGS</h2><p><code class="literal">rpcclient</code> is designed as a developer testing tool
188 and may not be robust in certain areas (such as command line parsing).
189 It has been known to generate a core dump upon failures when invalid
190 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
191 been developed from examining Network traces. No documentation is
192 available from the original creators (Microsoft) on how MSRPC over
193 SMB works, or how the individual MSRPC services work. Microsoft's
194 implementation of these services has been demonstrated (and reported)
195 to be... a bit flaky in places. </p><p>The development of Samba's implementation is also a bit rough,
196 and as more of the services are understood, it can even result in
197 versions of <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> and <a class="citerefentry" href="rpcclient.1.html"><span class="citerefentry"><span class="refentrytitle">rpcclient</span>(1)</span></a> that are incompatible for some commands or services. Additionally,
198 the developers are sending reports to Microsoft, and problems found
199 or reported to Microsoft are fixed in Service Packs, which may
200 result in incompatibilities.</p></div><div class="refsect1" lang="en"><a name="id2533168"></a><h2>VERSION</h2><p>This man page is correct for version 3 of the Samba
201 suite.</p></div><div class="refsect1" lang="en"><a name="id2533179"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities
202 were created by Andrew Tridgell. Samba is now developed
203 by the Samba Team as an Open Source project similar
204 to the way the Linux kernel is developed.</p><p>The original rpcclient man page was written by Matthew
205 Geddes, Luke Kenneth Casson Leighton, and rewritten by Gerald Carter.
206 The conversion to DocBook for Samba 2.2 was done by Gerald
207 Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was
208 done by Alexander Bokovoy.</p></div></div></body></html>
Note: See TracBrowser for help on using the repository browser.