1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
3 <refentry id="rpcclient.1">
6 <refentrytitle>rpcclient</refentrytitle>
7 <manvolnum>1</manvolnum>
8 <refmiscinfo class="source">Samba</refmiscinfo>
9 <refmiscinfo class="manual">User Commands</refmiscinfo>
10 <refmiscinfo class="version">4.0</refmiscinfo>
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">-I destinationIP</arg>
33 <arg choice="req">server</arg>
38 <title>DESCRIPTION</title>
40 <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
41 <manvolnum>7</manvolnum></citerefentry> suite.</para>
43 <para><command>rpcclient</command> is a utility initially developed
44 to test MS-RPC functionality in Samba itself. It has undergone
45 several stages of development and stability. Many system administrators
46 have now written scripts around it to manage Windows NT clients from
47 their UNIX workstation. </para>
52 <title>OPTIONS</title>
57 <listitem><para>NetBIOS name of Server to which to connect.
58 The server can be any SMB/CIFS server. The name is
59 resolved using the <smbconfoption name="name resolve order"/> line from <citerefentry><refentrytitle>smb.conf</refentrytitle>
60 <manvolnum>5</manvolnum></citerefentry>.</para></listitem>
65 <term>-c|--command=<command string></term>
66 <listitem><para>Execute semicolon separated commands (listed
67 below) </para></listitem>
72 <term>-I|--dest-ip IP-address</term>
73 <listitem><para><replaceable>IP address</replaceable> is the address of the server to connect to.
74 It should be specified in standard "a.b.c.d" notation. </para>
76 <para>Normally the client would attempt to locate a named
77 SMB/CIFS server by looking it up via the NetBIOS name resolution
78 mechanism described above in the <parameter>name resolve order</parameter>
79 parameter above. Using this parameter will force the client
80 to assume that the server is on the machine with the specified IP
81 address and the NetBIOS name component of the resource being
82 connected to will be ignored. </para>
84 <para>There is no default for this parameter. If not supplied,
85 it will be determined automatically by the client as described
86 above. </para></listitem>
90 <term>-p|--port port</term>
91 <listitem><para>This number is the TCP port number that will be used
92 when making connections to the server. The standard (well-known)
93 TCP port number for an SMB/CIFS server is 139, which is the
94 default. </para></listitem>
99 &popt.common.credentials;
100 &popt.common.connection;
107 <title>COMMANDS</title>
110 <title>LSARPC</title>
113 <varlistentry><term>lsaquery</term><listitem><para>Query info policy</para></listitem></varlistentry>
115 <varlistentry><term>lookupsids</term><listitem><para>Resolve a list
116 of SIDs to usernames.
117 </para></listitem></varlistentry>
119 <varlistentry><term>lookupnames</term><listitem><para>Resolve a list
120 of usernames to SIDs.
121 </para></listitem></varlistentry>
123 <varlistentry><term>enumtrust</term><listitem><para>Enumerate trusted domains</para></listitem></varlistentry>
125 <varlistentry><term>enumprivs</term><listitem><para>Enumerate privileges</para></listitem></varlistentry>
127 <varlistentry><term>getdispname</term><listitem><para>Get the privilege name</para></listitem></varlistentry>
129 <varlistentry><term>lsaenumsid</term><listitem><para>Enumerate the LSA SIDS</para></listitem></varlistentry>
131 <varlistentry><term>lsaenumprivsaccount</term><listitem><para>Enumerate the privileges of an SID</para></listitem></varlistentry>
133 <varlistentry><term>lsaenumacctrights</term><listitem><para>Enumerate the rights of an SID</para></listitem></varlistentry>
135 <varlistentry><term>lsaenumacctwithright</term><listitem><para>Enumerate accounts with a right</para></listitem></varlistentry>
137 <varlistentry><term>lsaaddacctrights</term><listitem><para>Add rights to an account</para></listitem></varlistentry>
139 <varlistentry><term>lsaremoveacctrights</term><listitem><para>Remove rights from an account</para></listitem></varlistentry>
141 <varlistentry><term>lsalookupprivvalue</term><listitem><para>Get a privilege value given its name</para></listitem></varlistentry>
143 <varlistentry><term>lsaquerysecobj</term><listitem><para>Query LSA security object</para></listitem></varlistentry>
149 <title>LSARPC-DS</title>
152 <varlistentry><term>dsroledominfo</term><listitem><para>Get Primary Domain Information</para></listitem></varlistentry>
157 <para><emphasis>DFS</emphasis></para>
159 <varlistentry><term>dfsexist</term><listitem><para>Query DFS support</para></listitem></varlistentry>
160 <varlistentry><term>dfsadd</term><listitem><para>Add a DFS share</para></listitem></varlistentry>
161 <varlistentry><term>dfsremove</term><listitem><para>Remove a DFS share</para></listitem></varlistentry>
162 <varlistentry><term>dfsgetinfo</term><listitem><para>Query DFS share info</para></listitem></varlistentry>
163 <varlistentry><term>dfsenum</term><listitem><para>Enumerate dfs shares</para></listitem></varlistentry>
171 <varlistentry><term>shutdown</term><listitem><para>Remote Shutdown</para></listitem></varlistentry>
172 <varlistentry><term>abortshutdown</term><listitem><para>Abort Shutdown</para></listitem></varlistentry>
178 <title>SRVSVC</title>
181 <varlistentry><term>srvinfo</term><listitem><para>Server query info</para></listitem></varlistentry>
183 <varlistentry><term>netshareenum</term><listitem><para>Enumerate shares</para></listitem></varlistentry>
185 <varlistentry><term>netfileenum</term><listitem><para>Enumerate open files</para></listitem></varlistentry>
187 <varlistentry><term>netremotetod</term><listitem><para>Fetch remote time of day</para></listitem></varlistentry>
197 <varlistentry><term>queryuser</term><listitem><para>Query user info</para></listitem></varlistentry>
198 <varlistentry><term>querygroup</term><listitem><para>Query group info</para></listitem></varlistentry>
199 <varlistentry><term>queryusergroups</term><listitem><para>Query user groups</para></listitem></varlistentry>
200 <varlistentry><term>querygroupmem</term><listitem><para>Query group membership</para></listitem></varlistentry>
201 <varlistentry><term>queryaliasmem</term><listitem><para>Query alias membership</para></listitem></varlistentry>
202 <varlistentry><term>querydispinfo</term><listitem><para>Query display info</para></listitem></varlistentry>
203 <varlistentry><term>querydominfo</term><listitem><para>Query domain info</para></listitem></varlistentry>
204 <varlistentry><term>enumdomusers</term><listitem><para>Enumerate domain users</para></listitem></varlistentry>
205 <varlistentry><term>enumdomgroups</term><listitem><para>Enumerate domain groups</para></listitem></varlistentry>
206 <varlistentry><term>enumalsgroups</term><listitem><para>Enumerate alias groups</para></listitem></varlistentry>
207 <varlistentry><term>createdomuser</term><listitem><para>Create domain user</para></listitem></varlistentry>
208 <varlistentry><term>samlookupnames</term><listitem><para>Look up names</para></listitem></varlistentry>
209 <varlistentry><term>samlookuprids</term><listitem><para>Look up names</para></listitem></varlistentry>
210 <varlistentry><term>deletedomuser</term><listitem><para>Delete domain user</para></listitem></varlistentry>
211 <varlistentry><term>samquerysecobj</term><listitem><para>Query SAMR security object</para></listitem></varlistentry>
212 <varlistentry><term>getdompwinfo</term><listitem><para>Retrieve domain password info</para></listitem></varlistentry>
213 <varlistentry><term>lookupdomain</term><listitem><para>Look up domain</para></listitem></varlistentry>
219 <title>SPOOLSS</title>
222 <varlistentry><term>adddriver <arch> <config> [<version>]</term>
224 Execute an AddPrinterDriver() RPC to install the printer driver
225 information on the server. Note that the driver files should
226 already exist in the directory returned by
227 <command>getdriverdir</command>. Possible values for
228 <parameter>arch</parameter> are the same as those for
229 the <command>getdriverdir</command> command.
230 The <parameter>config</parameter> parameter is defined as
233 <para><programlisting>
239 Language Monitor Name:\
241 Comma Separated list of Files
242 </programlisting></para>
244 <para>Any empty fields should be enter as the string "NULL". </para>
246 <para>Samba does not need to support the concept of Print Monitors
247 since these only apply to local printers whose driver can make
248 use of a bi-directional link for communication. This field should
249 be "NULL". On a remote NT print server, the Print Monitor for a
250 driver must already be installed prior to adding the driver or
251 else the RPC will fail. </para>
253 <para>The <parameter>version</parameter> parameter lets you
254 specify the printer driver version number. If omitted, the
255 default driver version for the specified architecture will
256 be used. This option can be used to upload Windows 2000
257 (version 3) printer drivers.</para></listitem></varlistentry>
259 <varlistentry><term>addprinter <printername>
260 <sharename> <drivername> <port></term>
262 Add a printer on the remote server. This printer
263 will be automatically shared. Be aware that the printer driver
264 must already be installed on the server (see <command>adddriver</command>)
265 and the <parameter>port</parameter>must be a valid port name (see
266 <command>enumports</command>.</para>
267 </listitem></varlistentry>
270 <varlistentry><term>deldriver <driver></term><listitem><para>Delete the
271 specified printer driver for all architectures. This
272 does not delete the actual driver files from the server,
273 only the entry from the server's list of drivers.
274 </para></listitem></varlistentry>
276 <varlistentry><term>deldriverex <driver> [architecture] [version] [flags]
277 </term><listitem><para>Delete the specified printer driver and optionally files
278 associated with the driver.
279 You can limit this action to a specific architecture and a specific version.
280 If no architecture is given, all driver files of that driver will be deleted.
281 <parameter>flags</parameter> correspond to numeric DPD_* values, i.e. a value
282 of 3 requests (DPD_DELETE_UNUSED_FILES | DPD_DELETE_SPECIFIC_VERSION).
283 </para></listitem></varlistentry>
285 <varlistentry><term>enumdata</term><listitem><para>Enumerate all
286 printer setting data stored on the server. On Windows NT clients,
287 these values are stored in the registry, while Samba servers
288 store them in the printers TDB. This command corresponds
289 to the MS Platform SDK GetPrinterData() function (* This
290 command is currently unimplemented).</para></listitem></varlistentry>
292 <varlistentry><term>enumdataex</term><listitem><para>Enumerate printer data for a key</para></listitem></varlistentry>
294 <varlistentry><term>enumjobs <printer></term>
295 <listitem><para>List the jobs and status of a given printer.
296 This command corresponds to the MS Platform SDK EnumJobs()
297 function</para></listitem></varlistentry>
299 <varlistentry><term>enumkey</term><listitem><para>Enumerate
300 printer keys</para></listitem></varlistentry>
302 <varlistentry><term>enumports [level]</term>
304 Executes an EnumPorts() call using the specified
305 info level. Currently only info levels 1 and 2 are supported.
306 </para></listitem></varlistentry>
310 <varlistentry><term>enumdrivers [level]</term>
312 Execute an EnumPrinterDrivers() call. This lists the various installed
313 printer drivers for all architectures. Refer to the MS Platform SDK
314 documentation for more details of the various flags and calling
315 options. Currently supported info levels are 1, 2, and 3.</para></listitem></varlistentry>
319 <varlistentry><term>enumprinters [level]</term>
320 <listitem><para>Execute an EnumPrinters() call. This lists the various installed
321 and share printers. Refer to the MS Platform SDK documentation for
322 more details of the various flags and calling options. Currently
323 supported info levels are 1, 2 and 5.</para></listitem></varlistentry>
328 <varlistentry><term>getdata <printername> <valuename;></term>
329 <listitem><para>Retrieve the data for a given printer setting. See
330 the <command>enumdata</command> command for more information.
331 This command corresponds to the GetPrinterData() MS Platform
332 SDK function. </para></listitem></varlistentry>
334 <varlistentry><term>getdataex</term><listitem><para>Get
335 printer driver data with
336 keyname</para></listitem></varlistentry>
339 <varlistentry><term>getdriver <printername></term>
341 Retrieve the printer driver information (such as driver file,
342 config file, dependent files, etc...) for
343 the given printer. This command corresponds to the GetPrinterDriver()
344 MS Platform SDK function. Currently info level 1, 2, and 3 are supported.
345 </para></listitem></varlistentry>
348 <varlistentry><term>getdriverdir <arch></term>
350 Execute a GetPrinterDriverDirectory()
351 RPC to retrieve the SMB share name and subdirectory for
352 storing printer driver files for a given architecture. Possible
353 values for <parameter>arch</parameter> are "Windows 4.0"
354 (for Windows 95/98), "Windows NT x86", "Windows NT PowerPC", "Windows
355 Alpha_AXP", and "Windows NT R4000". </para></listitem></varlistentry>
359 <varlistentry><term>getprinter <printername></term>
360 <listitem><para>Retrieve the current printer information. This command
361 corresponds to the GetPrinter() MS Platform SDK function.
362 </para></listitem></varlistentry>
364 <varlistentry><term>getprintprocdir</term><listitem><para>Get
366 directory</para></listitem></varlistentry>
368 <varlistentry><term>openprinter <printername></term>
369 <listitem><para>Execute an OpenPrinterEx() and ClosePrinter() RPC
370 against a given printer. </para></listitem></varlistentry>
372 <varlistentry><term>setdriver <printername>
373 <drivername></term>
374 <listitem><para>Execute a SetPrinter() command to update the printer driver
375 associated with an installed printer. The printer driver must
376 already be correctly installed on the print server. </para>
378 <para>See also the <command>enumprinters</command> and
379 <command>enumdrivers</command> commands for obtaining a list of
380 of installed printers and drivers.</para></listitem></varlistentry>
382 <varlistentry><term>addform</term><listitem><para>Add form</para></listitem></varlistentry>
383 <varlistentry><term>setform</term><listitem><para>Set form</para></listitem></varlistentry>
384 <varlistentry><term>getform</term><listitem><para>Get form</para></listitem></varlistentry>
385 <varlistentry><term>deleteform</term><listitem><para>Delete form</para></listitem></varlistentry>
386 <varlistentry><term>enumforms</term><listitem><para>Enumerate form</para></listitem></varlistentry>
387 <varlistentry><term>setprinter</term><listitem><para>Set printer comment</para></listitem></varlistentry>
388 <varlistentry><term>setprinterdata</term><listitem><para>Set REG_SZ printer data</para></listitem></varlistentry>
390 <varlistentry><term>setprintername <printername>
391 <newprintername></term>
392 <listitem><para>Set printer name</para></listitem></varlistentry>
394 <varlistentry><term>rffpcnex</term><listitem><para>Rffpcnex test</para></listitem></varlistentry>
402 <title>NETLOGON</title>
406 <varlistentry><term>logonctrl2</term>
407 <listitem><para>Logon Control 2</para></listitem>
410 <varlistentry><term>logonctrl</term>
411 <listitem><para>Logon Control</para></listitem>
414 <varlistentry><term>samsync</term>
415 <listitem><para>Sam Synchronisation</para></listitem>
418 <varlistentry><term>samdeltas</term>
419 <listitem><para>Query Sam Deltas</para></listitem>
422 <varlistentry><term>samlogon</term>
423 <listitem><para>Sam Logon</para></listitem>
433 <varlistentry><term>fss_is_path_sup</term>
435 <para>Check whether a share supports shadow-copy
439 <varlistentry><term>fss_get_sup_version</term>
441 <para>Get supported FSRVP version from server</para>
444 <varlistentry><term>fss_create_expose</term>
446 <para>Request shadow-copy creation and exposure</para>
449 <varlistentry><term>fss_delete</term>
451 <para>Request shadow-copy share deletion</para>
454 <varlistentry><term>fss_has_shadow_copy</term>
456 <para>Check for an associated share shadow-copy</para>
459 <varlistentry><term>fss_get_mapping</term>
461 <para>Get shadow-copy share mapping information</para>
464 <varlistentry><term>fss_recovery_complete</term>
466 <para>Flag read-write snapshot as recovery complete,
467 allowing further shadow-copy requests</para>
475 <title>GENERAL COMMANDS</title>
478 <varlistentry><term>debuglevel</term><listitem><para>Set the current
479 debug level used to log information.</para></listitem></varlistentry>
481 <varlistentry><term>help (?)</term><listitem><para>Print a listing of all
482 known commands or extended help on a particular command.
483 </para></listitem></varlistentry>
485 <varlistentry><term>quit (exit)</term><listitem><para>Exit <command>rpcclient
486 </command>.</para></listitem></varlistentry>
495 <para><command>rpcclient</command> is designed as a developer testing tool
496 and may not be robust in certain areas (such as command line parsing).
497 It has been known to generate a core dump upon failures when invalid
498 parameters where passed to the interpreter. </para>
500 <para>From Luke Leighton's original rpcclient man page:</para>
502 <para><emphasis>WARNING!</emphasis> The MSRPC over SMB code has
503 been developed from examining Network traces. No documentation is
504 available from the original creators (Microsoft) on how MSRPC over
505 SMB works, or how the individual MSRPC services work. Microsoft's
506 implementation of these services has been demonstrated (and reported)
507 to be... a bit flaky in places. </para>
509 <para>The development of Samba's implementation is also a bit rough,
510 and as more of the services are understood, it can even result in
511 versions of <citerefentry><refentrytitle>smbd</refentrytitle>
512 <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>rpcclient</refentrytitle>
513 <manvolnum>1</manvolnum></citerefentry> that are incompatible for some commands or services. Additionally,
514 the developers are sending reports to Microsoft, and problems found
515 or reported to Microsoft are fixed in Service Packs, which may
516 result in incompatibilities.</para>
521 <title>VERSION</title>
523 <para>This man page is correct for version 3 of the Samba
528 <title>AUTHOR</title>
530 <para>The original Samba software and related utilities
531 were created by Andrew Tridgell. Samba is now developed
532 by the Samba Team as an Open Source project similar
533 to the way the Linux kernel is developed.</para>
535 <para>The original rpcclient man page was written by Matthew
536 Geddes, Luke Kenneth Casson Leighton, and rewritten by Gerald Carter.
537 The conversion to DocBook for Samba 2.2 was done by Gerald
538 Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was
539 done by Alexander Bokovoy.</para>