source: vendor/3.5.6/docs/htmldocs/manpages/rpcclient.1.html

Last change on this file was 427, checked in by Silvan Scherrer, 15 years ago

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