1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
4 <!ENTITY % globalentities SYSTEM '../entities/global.entities'> %globalentities;
6 <refentry id="rpcclient.1">
9 <refentrytitle>rpcclient</refentrytitle>
10 <manvolnum>1</manvolnum>
15 <refname>rpcclient</refname>
16 <refpurpose>tool for executing client side
17 MS-RPC functions</refpurpose>
22 <command>rpcclient</command>
23 <arg choice="opt">-A authfile</arg>
24 <arg choice="opt">-c <command string></arg>
25 <arg choice="opt">-d debuglevel</arg>
26 <arg choice="opt">-h</arg>
27 <arg choice="opt">-l logdir</arg>
28 <arg choice="opt">-N</arg>
29 <arg choice="opt">-s <smb config file></arg>
30 <arg choice="opt">-U username[%password]</arg>
31 <arg choice="opt">-W workgroup</arg>
32 <arg choice="opt">-N</arg>
33 <arg choice="opt">-I destinationIP</arg>
34 <arg choice="req">server</arg>
39 <title>DESCRIPTION</title>
41 <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
42 <manvolnum>7</manvolnum></citerefentry> suite.</para>
44 <para><command>rpcclient</command> is a utility initially developed
45 to test MS-RPC functionality in Samba itself. It has undergone
46 several stages of development and stability. Many system administrators
47 have now written scripts around it to manage Windows NT clients from
48 their UNIX workstation. </para>
53 <title>OPTIONS</title>
58 <listitem><para>NetBIOS name of Server to which to connect.
59 The server can be any SMB/CIFS server. The name is
60 resolved using the <smbconfoption><name>name resolve order</name></smbconfoption> line from <citerefentry><refentrytitle>smb.conf</refentrytitle>
61 <manvolnum>5</manvolnum></citerefentry>.</para></listitem>
66 <term>-c|--command='command string'</term>
67 <listitem><para>execute semicolon separated commands (listed
68 below)) </para></listitem>
73 <term>-I IP-address</term>
74 <listitem><para><replaceable>IP address</replaceable> is the address of the server to connect to.
75 It should be specified in standard "a.b.c.d" notation. </para>
77 <para>Normally the client would attempt to locate a named
78 SMB/CIFS server by looking it up via the NetBIOS name resolution
79 mechanism described above in the <parameter>name resolve order</parameter>
80 parameter above. Using this parameter will force the client
81 to assume that the server is on the machine with the specified IP
82 address and the NetBIOS name component of the resource being
83 connected to will be ignored. </para>
85 <para>There is no default for this parameter. If not supplied,
86 it will be determined automatically by the client as described
87 above. </para></listitem>
91 &popt.common.credentials;
92 &popt.common.connection;
99 <title>COMMANDS</title>
102 <title>LSARPC</title>
105 <varlistentry><term>lsaquery</term><listitem><para>Query info policy</para></listitem></varlistentry>
107 <varlistentry><term>lookupsids</term><listitem><para>Resolve a list
108 of SIDs to usernames.
109 </para></listitem></varlistentry>
111 <varlistentry><term>lookupnames</term><listitem><para>Resolve a list
112 of usernames to SIDs.
113 </para></listitem></varlistentry>
115 <varlistentry><term>enumtrusts</term><listitem><para>Enumerate trusted domains</para></listitem></varlistentry>
117 <varlistentry><term>enumprivs</term><listitem><para>Enumerate privileges</para></listitem></varlistentry>
119 <varlistentry><term>getdispname</term><listitem><para>Get the privilege name</para></listitem></varlistentry>
121 <varlistentry><term>lsaenumsid</term><listitem><para>Enumerate the LSA SIDS</para></listitem></varlistentry>
123 <varlistentry><term>lsaenumprivsaccount</term><listitem><para>Enumerate the privileges of an SID</para></listitem></varlistentry>
125 <varlistentry><term>lsaenumacctrights</term><listitem><para>Enumerate the rights of an SID</para></listitem></varlistentry>
127 <varlistentry><term>lsaenumacctwithright</term><listitem><para>Enumerate accounts with a right</para></listitem></varlistentry>
129 <varlistentry><term>lsaaddacctrights</term><listitem><para>Add rights to an account</para></listitem></varlistentry>
131 <varlistentry><term>lsaremoveacctrights</term><listitem><para>Remove rights from an account</para></listitem></varlistentry>
133 <varlistentry><term>lsalookupprivvalue</term><listitem><para>Get a privilege value given its name</para></listitem></varlistentry>
135 <varlistentry><term>lsaquerysecobj</term><listitem><para>Query LSA security object</para></listitem></varlistentry>
141 <title>LSARPC-DS</title>
144 <varlistentry><term>dsroledominfo</term><listitem><para>Get Primary Domain Information</para></listitem></varlistentry>
149 <para><emphasis>DFS</emphasis></para>
151 <varlistentry><term>dfsexist</term><listitem><para>Query DFS support</para></listitem></varlistentry>
152 <varlistentry><term>dfsadd</term><listitem><para>Add a DFS share</para></listitem></varlistentry>
153 <varlistentry><term>dfsremove</term><listitem><para>Remove a DFS share</para></listitem></varlistentry>
154 <varlistentry><term>dfsgetinfo</term><listitem><para>Query DFS share info</para></listitem></varlistentry>
155 <varlistentry><term>dfsenum</term><listitem><para>Enumerate dfs shares</para></listitem></varlistentry>
163 <varlistentry><term>shutdown</term><listitem><para>Remote Shutdown</para></listitem></varlistentry>
164 <varlistentry><term>abortshutdown</term><listitem><para>Abort Shutdown</para></listitem></varlistentry>
170 <title>SRVSVC</title>
173 <varlistentry><term>srvinfo</term><listitem><para>Server query info</para></listitem></varlistentry>
175 <varlistentry><term>netshareenum</term><listitem><para>Enumerate shares</para></listitem></varlistentry>
177 <varlistentry><term>netfileenum</term><listitem><para>Enumerate open files</para></listitem></varlistentry>
179 <varlistentry><term>netremotetod</term><listitem><para>Fetch remote time of day</para></listitem></varlistentry>
189 <varlistentry><term>queryuser</term><listitem><para>Query user info</para></listitem></varlistentry>
190 <varlistentry><term>querygroup</term><listitem><para>Query group info</para></listitem></varlistentry>
191 <varlistentry><term>queryusergroups</term><listitem><para>Query user groups</para></listitem></varlistentry>
192 <varlistentry><term>querygroupmem</term><listitem><para>Query group membership</para></listitem></varlistentry>
193 <varlistentry><term>queryaliasmem</term><listitem><para>Query alias membership</para></listitem></varlistentry>
194 <varlistentry><term>querydispinfo</term><listitem><para>Query display info</para></listitem></varlistentry>
195 <varlistentry><term>querydominfo</term><listitem><para>Query domain info</para></listitem></varlistentry>
196 <varlistentry><term>enumdomusers</term><listitem><para>Enumerate domain users</para></listitem></varlistentry>
197 <varlistentry><term>enumdomgroups</term><listitem><para>Enumerate domain groups</para></listitem></varlistentry>
198 <varlistentry><term>enumalsgroups</term><listitem><para>Enumerate alias groups</para></listitem></varlistentry>
199 <varlistentry><term>createdomuser</term><listitem><para>Create domain user</para></listitem></varlistentry>
200 <varlistentry><term>samlookupnames</term><listitem><para>Look up names</para></listitem></varlistentry>
201 <varlistentry><term>samlookuprids</term><listitem><para>Look up names</para></listitem></varlistentry>
202 <varlistentry><term>deletedomuser</term><listitem><para>Delete domain user</para></listitem></varlistentry>
203 <varlistentry><term>samquerysecobj</term><listitem><para>Query SAMR security object</para></listitem></varlistentry>
204 <varlistentry><term>getdompwinfo</term><listitem><para>Retrieve domain password info</para></listitem></varlistentry>
205 <varlistentry><term>lookupdomain</term><listitem><para>Look up domain</para></listitem></varlistentry>
211 <title>SPOOLSS</title>
214 <varlistentry><term>adddriver <arch> <config> [<version>]</term>
216 Execute an AddPrinterDriver() RPC to install the printer driver
217 information on the server. Note that the driver files should
218 already exist in the directory returned by
219 <command>getdriverdir</command>. Possible values for
220 <parameter>arch</parameter> are the same as those for
221 the <command>getdriverdir</command> command.
222 The <parameter>config</parameter> parameter is defined as
225 <para><programlisting>
231 Language Monitor Name:\
233 Comma Separated list of Files
234 </programlisting></para>
236 <para>Any empty fields should be enter as the string "NULL". </para>
238 <para>Samba does not need to support the concept of Print Monitors
239 since these only apply to local printers whose driver can make
240 use of a bi-directional link for communication. This field should
241 be "NULL". On a remote NT print server, the Print Monitor for a
242 driver must already be installed prior to adding the driver or
243 else the RPC will fail. </para>
245 <para>The <parameter>version</parameter> parameter lets you
246 specify the printer driver version number. If omitted, the
247 default driver version for the specified architecture will
248 be used. This option can be used to upload Windows 2000
249 (version 3) printer drivers.</para></listitem></varlistentry>
251 <varlistentry><term>addprinter <printername>
252 <sharename> <drivername> <port></term>
254 Add a printer on the remote server. This printer
255 will be automatically shared. Be aware that the printer driver
256 must already be installed on the server (see <command>adddriver</command>)
257 and the <parameter>port</parameter>must be a valid port name (see
258 <command>enumports</command>.</para>
259 </listitem></varlistentry>
262 <varlistentry><term>deldriver</term><listitem><para>Delete the
263 specified printer driver for all architectures. This
264 does not delete the actual driver files from the server,
265 only the entry from the server's list of drivers.
266 </para></listitem></varlistentry>
268 <varlistentry><term>enumdata</term><listitem><para>Enumerate all
269 printer setting data stored on the server. On Windows NT clients,
270 these values are stored in the registry, while Samba servers
271 store them in the printers TDB. This command corresponds
272 to the MS Platform SDK GetPrinterData() function (* This
273 command is currently unimplemented).</para></listitem></varlistentry>
275 <varlistentry><term>enumdataex</term><listitem><para>Enumerate printer data for a key</para></listitem></varlistentry>
277 <varlistentry><term>enumjobs <printer></term>
278 <listitem><para>List the jobs and status of a given printer.
279 This command corresponds to the MS Platform SDK EnumJobs()
280 function</para></listitem></varlistentry>
282 <varlistentry><term>enumkey</term><listitem><para>Enumerate
283 printer keys</para></listitem></varlistentry>
285 <varlistentry><term>enumports [level]</term>
287 Executes an EnumPorts() call using the specified
288 info level. Currently only info levels 1 and 2 are supported.
289 </para></listitem></varlistentry>
293 <varlistentry><term>enumdrivers [level]</term>
295 Execute an EnumPrinterDrivers() call. This lists the various installed
296 printer drivers for all architectures. Refer to the MS Platform SDK
297 documentation for more details of the various flags and calling
298 options. Currently supported info levels are 1, 2, and 3.</para></listitem></varlistentry>
302 <varlistentry><term>enumprinters [level]</term>
303 <listitem><para>Execute an EnumPrinters() call. This lists the various installed
304 and share printers. Refer to the MS Platform SDK documentation for
305 more details of the various flags and calling options. Currently
306 supported info levels are 1, 2 and 5.</para></listitem></varlistentry>
311 <varlistentry><term>getdata <printername> <valuename;></term>
312 <listitem><para>Retrieve the data for a given printer setting. See
313 the <command>enumdata</command> command for more information.
314 This command corresponds to the GetPrinterData() MS Platform
315 SDK function. </para></listitem></varlistentry>
317 <varlistentry><term>getdataex</term><listitem><para>Get
318 printer driver data with
319 keyname</para></listitem></varlistentry>
322 <varlistentry><term>getdriver <printername></term>
324 Retrieve the printer driver information (such as driver file,
325 config file, dependent files, etc...) for
326 the given printer. This command corresponds to the GetPrinterDriver()
327 MS Platform SDK function. Currently info level 1, 2, and 3 are supported.
328 </para></listitem></varlistentry>
331 <varlistentry><term>getdriverdir <arch></term>
333 Execute a GetPrinterDriverDirectory()
334 RPC to retrieve the SMB share name and subdirectory for
335 storing printer driver files for a given architecture. Possible
336 values for <parameter>arch</parameter> are "Windows 4.0"
337 (for Windows 95/98), "Windows NT x86", "Windows NT PowerPC", "Windows
338 Alpha_AXP", and "Windows NT R4000". </para></listitem></varlistentry>
342 <varlistentry><term>getprinter <printername></term>
343 <listitem><para>Retrieve the current printer information. This command
344 corresponds to the GetPrinter() MS Platform SDK function.
345 </para></listitem></varlistentry>
347 <varlistentry><term>getprintprocdir</term><listitem><para>Get
349 directory</para></listitem></varlistentry>
351 <varlistentry><term>openprinter <printername></term>
352 <listitem><para>Execute an OpenPrinterEx() and ClosePrinter() RPC
353 against a given printer. </para></listitem></varlistentry>
355 <varlistentry><term>setdriver <printername>
356 <drivername></term>
357 <listitem><para>Execute a SetPrinter() command to update the printer driver
358 associated with an installed printer. The printer driver must
359 already be correctly installed on the print server. </para>
361 <para>See also the <command>enumprinters</command> and
362 <command>enumdrivers</command> commands for obtaining a list of
363 of installed printers and drivers.</para></listitem></varlistentry>
365 <varlistentry><term>addform</term><listitem><para>Add form</para></listitem></varlistentry>
366 <varlistentry><term>setform</term><listitem><para>Set form</para></listitem></varlistentry>
367 <varlistentry><term>getform</term><listitem><para>Get form</para></listitem></varlistentry>
368 <varlistentry><term>deleteform</term><listitem><para>Delete form</para></listitem></varlistentry>
369 <varlistentry><term>enumforms</term><listitem><para>Enumerate form</para></listitem></varlistentry>
370 <varlistentry><term>setprinter</term><listitem><para>Set printer comment</para></listitem></varlistentry>
371 <varlistentry><term>setprinterdata</term><listitem><para>Set REG_SZ printer data</para></listitem></varlistentry>
373 <varlistentry><term>setprintername <printername>
374 <newprintername></term>
375 <listitem><para>Set printer name</para></listitem></varlistentry>
377 <varlistentry><term>rffpcnex</term><listitem><para>Rffpcnex test</para></listitem></varlistentry>
385 <title>NETLOGON</title>
389 <varlistentry><term>logonctrl2</term>
390 <listitem><para>Logon Control 2</para></listitem>
393 <varlistentry><term>logonctrl</term>
394 <listitem><para>Logon Control</para></listitem>
397 <varlistentry><term>samsync</term>
398 <listitem><para>Sam Synchronisation</para></listitem>
401 <varlistentry><term>samdeltas</term>
402 <listitem><para>Query Sam Deltas</para></listitem>
405 <varlistentry><term>samlogon</term>
406 <listitem><para>Sam Logon</para></listitem>
413 <title>GENERAL COMMANDS</title>
416 <varlistentry><term>debuglevel</term><listitem><para>Set the current
417 debug level used to log information.</para></listitem></varlistentry>
419 <varlistentry><term>help (?)</term><listitem><para>Print a listing of all
420 known commands or extended help on a particular command.
421 </para></listitem></varlistentry>
423 <varlistentry><term>quit (exit)</term><listitem><para>Exit <command>rpcclient
424 </command>.</para></listitem></varlistentry>
433 <para><command>rpcclient</command> is designed as a developer testing tool
434 and may not be robust in certain areas (such as command line parsing).
435 It has been known to generate a core dump upon failures when invalid
436 parameters where passed to the interpreter. </para>
438 <para>From Luke Leighton's original rpcclient man page:</para>
440 <para><emphasis>WARNING!</emphasis> The MSRPC over SMB code has
441 been developed from examining Network traces. No documentation is
442 available from the original creators (Microsoft) on how MSRPC over
443 SMB works, or how the individual MSRPC services work. Microsoft's
444 implementation of these services has been demonstrated (and reported)
445 to be... a bit flaky in places. </para>
447 <para>The development of Samba's implementation is also a bit rough,
448 and as more of the services are understood, it can even result in
449 versions of <citerefentry><refentrytitle>smbd</refentrytitle>
450 <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>rpcclient</refentrytitle>
451 <manvolnum>1</manvolnum></citerefentry> that are incompatible for some commands or services. Additionally,
452 the developers are sending reports to Microsoft, and problems found
453 or reported to Microsoft are fixed in Service Packs, which may
454 result in incompatibilities.</para>
459 <title>VERSION</title>
461 <para>This man page is correct for version 3.0 of the Samba
466 <title>AUTHOR</title>
468 <para>The original Samba software and related utilities
469 were created by Andrew Tridgell. Samba is now developed
470 by the Samba Team as an Open Source project similar
471 to the way the Linux kernel is developed.</para>
473 <para>The original rpcclient man page was written by Matthew
474 Geddes, Luke Kenneth Casson Leighton, and rewritten by Gerald Carter.
475 The conversion to DocBook for Samba 2.2 was done by Gerald
476 Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was
477 done by Alexander Bokovoy.</para>