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">&doc.version;</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">-l logdir</arg>
27 <arg choice="opt">-N</arg>
28 <arg choice="opt">-s <smb config file></arg>
29 <arg choice="opt">-U username[%password]</arg>
30 <arg choice="opt">-W workgroup</arg>
31 <arg choice="opt">-I destinationIP</arg>
32 <arg choice="req">server</arg>
37 <title>DESCRIPTION</title>
39 <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
40 <manvolnum>7</manvolnum></citerefentry> suite.</para>
42 <para><command>rpcclient</command> is a utility initially developed
43 to test MS-RPC functionality in Samba itself. It has undergone
44 several stages of development and stability. Many system administrators
45 have now written scripts around it to manage Windows NT clients from
46 their UNIX workstation. </para>
51 <title>OPTIONS</title>
56 <listitem><para>NetBIOS name of Server to which to connect.
57 The server can be any SMB/CIFS server. The name is
58 resolved using the <smbconfoption name="name resolve order"/> line from <citerefentry><refentrytitle>smb.conf</refentrytitle>
59 <manvolnum>5</manvolnum></citerefentry>.</para></listitem>
64 <term>-c|--command=<command string></term>
65 <listitem><para>Execute semicolon separated commands (listed
66 below) </para></listitem>
71 <term>-I|--dest-ip IP-address</term>
72 <listitem><para><replaceable>IP address</replaceable> is the address of the server to connect to.
73 It should be specified in standard "a.b.c.d" notation. </para>
75 <para>Normally the client would attempt to locate a named
76 SMB/CIFS server by looking it up via the NetBIOS name resolution
77 mechanism described above in the <parameter>name resolve order</parameter>
78 parameter above. Using this parameter will force the client
79 to assume that the server is on the machine with the specified IP
80 address and the NetBIOS name component of the resource being
81 connected to will be ignored. </para>
83 <para>There is no default for this parameter. If not supplied,
84 it will be determined automatically by the client as described
85 above. </para></listitem>
89 <term>-p|--port port</term>
90 <listitem><para>This number is the TCP port number that will be used
91 when making connections to the server. The standard (well-known)
92 TCP port number for an SMB/CIFS server is 139, which is the
93 default. </para></listitem>
98 &popt.common.credentials;
99 &popt.common.connection;
106 <title>COMMANDS</title>
109 <title>LSARPC</title>
112 <varlistentry><term>lsaquery</term><listitem><para>Query info policy</para></listitem></varlistentry>
114 <varlistentry><term>lookupsids</term><listitem><para>Resolve a list
115 of SIDs to usernames.
116 </para></listitem></varlistentry>
118 <varlistentry><term>lookupnames</term><listitem><para>Resolve a list
119 of usernames to SIDs.
120 </para></listitem></varlistentry>
122 <varlistentry><term>enumtrust</term><listitem><para>Enumerate trusted domains</para></listitem></varlistentry>
124 <varlistentry><term>enumprivs</term><listitem><para>Enumerate privileges</para></listitem></varlistentry>
126 <varlistentry><term>getdispname</term><listitem><para>Get the privilege name</para></listitem></varlistentry>
128 <varlistentry><term>lsaenumsid</term><listitem><para>Enumerate the LSA SIDS</para></listitem></varlistentry>
130 <varlistentry><term>lsaenumprivsaccount</term><listitem><para>Enumerate the privileges of an SID</para></listitem></varlistentry>
132 <varlistentry><term>lsaenumacctrights</term><listitem><para>Enumerate the rights of an SID</para></listitem></varlistentry>
134 <varlistentry><term>lsaenumacctwithright</term><listitem><para>Enumerate accounts with a right</para></listitem></varlistentry>
136 <varlistentry><term>lsaaddacctrights</term><listitem><para>Add rights to an account</para></listitem></varlistentry>
138 <varlistentry><term>lsaremoveacctrights</term><listitem><para>Remove rights from an account</para></listitem></varlistentry>
140 <varlistentry><term>lsalookupprivvalue</term><listitem><para>Get a privilege value given its name</para></listitem></varlistentry>
142 <varlistentry><term>lsaquerysecobj</term><listitem><para>Query LSA security object</para></listitem></varlistentry>
148 <title>LSARPC-DS</title>
151 <varlistentry><term>dsroledominfo</term><listitem><para>Get Primary Domain Information</para></listitem></varlistentry>
156 <para><emphasis>DFS</emphasis></para>
158 <varlistentry><term>dfsexist</term><listitem><para>Query DFS support</para></listitem></varlistentry>
159 <varlistentry><term>dfsadd</term><listitem><para>Add a DFS share</para></listitem></varlistentry>
160 <varlistentry><term>dfsremove</term><listitem><para>Remove a DFS share</para></listitem></varlistentry>
161 <varlistentry><term>dfsgetinfo</term><listitem><para>Query DFS share info</para></listitem></varlistentry>
162 <varlistentry><term>dfsenum</term><listitem><para>Enumerate dfs shares</para></listitem></varlistentry>
170 <varlistentry><term>shutdown</term><listitem><para>Remote Shutdown</para></listitem></varlistentry>
171 <varlistentry><term>abortshutdown</term><listitem><para>Abort Shutdown</para></listitem></varlistentry>
177 <title>SRVSVC</title>
180 <varlistentry><term>srvinfo</term><listitem><para>Server query info</para></listitem></varlistentry>
181 <varlistentry><term>netshareenum</term><listitem><para>Enumerate shares</para></listitem></varlistentry>
182 <varlistentry><term>netshareenumall</term><listitem><para>Enumerate all shares</para></listitem></varlistentry>
183 <varlistentry><term>netsharegetinfo</term><listitem><para>Get Share Info</para></listitem></varlistentry>
184 <varlistentry><term>netsharesetinfo</term><listitem><para>Set Share Info</para></listitem></varlistentry>
185 <varlistentry><term>netsharesetdfsflags</term><listitem><para>Set DFS flags</para></listitem></varlistentry>
186 <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>
188 <varlistentry><term>netnamevalidate</term><listitem><para>Validate sharename</para></listitem></varlistentry>
189 <varlistentry><term>netfilegetsec</term><listitem><para>Get File security</para></listitem></varlistentry>
190 <varlistentry><term>netsessdel</term><listitem><para>Delete Session</para></listitem></varlistentry>
191 <varlistentry><term>netsessenum</term><listitem><para>Enumerate Sessions</para></listitem></varlistentry>
192 <varlistentry><term>netdiskenum</term><listitem><para>Enumerate Disks</para></listitem></varlistentry>
193 <varlistentry><term>netconnenum</term><listitem><para>Enumerate Connections</para></listitem></varlistentry>
194 <varlistentry><term>netshareadd</term><listitem><para>Add share</para></listitem></varlistentry>
195 <varlistentry><term>netsharedel</term><listitem><para>Delete share</para></listitem></varlistentry>
204 <varlistentry><term>queryuser</term><listitem><para>Query user info</para></listitem></varlistentry>
205 <varlistentry><term>querygroup</term><listitem><para>Query group info</para></listitem></varlistentry>
206 <varlistentry><term>queryusergroups</term><listitem><para>Query user groups</para></listitem></varlistentry>
207 <varlistentry><term>querygroupmem</term><listitem><para>Query group membership</para></listitem></varlistentry>
208 <varlistentry><term>queryaliasmem</term><listitem><para>Query alias membership</para></listitem></varlistentry>
209 <varlistentry><term>querydispinfo</term><listitem><para>Query display info</para></listitem></varlistentry>
210 <varlistentry><term>querydominfo</term><listitem><para>Query domain info</para></listitem></varlistentry>
211 <varlistentry><term>enumdomusers</term><listitem><para>Enumerate domain users</para></listitem></varlistentry>
212 <varlistentry><term>enumdomgroups</term><listitem><para>Enumerate domain groups</para></listitem></varlistentry>
213 <varlistentry><term>enumalsgroups</term><listitem><para>Enumerate alias groups</para></listitem></varlistentry>
214 <varlistentry><term>createdomuser</term><listitem><para>Create domain user</para></listitem></varlistentry>
215 <varlistentry><term>samlookupnames</term><listitem><para>Look up names</para></listitem></varlistentry>
216 <varlistentry><term>samlookuprids</term><listitem><para>Look up names</para></listitem></varlistentry>
217 <varlistentry><term>deletedomuser</term><listitem><para>Delete domain user</para></listitem></varlistentry>
218 <varlistentry><term>samquerysecobj</term><listitem><para>Query SAMR security object</para></listitem></varlistentry>
219 <varlistentry><term>getdompwinfo</term><listitem><para>Retrieve domain password info</para></listitem></varlistentry>
220 <varlistentry><term>lookupdomain</term><listitem><para>Look up domain</para></listitem></varlistentry>
226 <title>SPOOLSS</title>
229 <varlistentry><term>adddriver <arch> <config> [<version>]</term>
231 Execute an AddPrinterDriver() RPC to install the printer driver
232 information on the server. Note that the driver files should
233 already exist in the directory returned by
234 <command>getdriverdir</command>. Possible values for
235 <parameter>arch</parameter> are the same as those for
236 the <command>getdriverdir</command> command.
237 The <parameter>config</parameter> parameter is defined as
240 <para><programlisting>
246 Language Monitor Name:\
248 Comma Separated list of Files
249 </programlisting></para>
251 <para>Any empty fields should be enter as the string "NULL". </para>
253 <para>Samba does not need to support the concept of Print Monitors
254 since these only apply to local printers whose driver can make
255 use of a bi-directional link for communication. This field should
256 be "NULL". On a remote NT print server, the Print Monitor for a
257 driver must already be installed prior to adding the driver or
258 else the RPC will fail. </para>
260 <para>The <parameter>version</parameter> parameter lets you
261 specify the printer driver version number. If omitted, the
262 default driver version for the specified architecture will
263 be used. This option can be used to upload Windows 2000
264 (version 3) printer drivers.</para></listitem></varlistentry>
266 <varlistentry><term>addprinter <printername>
267 <sharename> <drivername> <port></term>
269 Add a printer on the remote server. This printer
270 will be automatically shared. Be aware that the printer driver
271 must already be installed on the server (see <command>adddriver</command>)
272 and the <parameter>port</parameter>must be a valid port name (see
273 <command>enumports</command>.</para>
274 </listitem></varlistentry>
277 <varlistentry><term>deldriver <driver></term><listitem><para>Delete the
278 specified printer driver for all architectures. This
279 does not delete the actual driver files from the server,
280 only the entry from the server's list of drivers.
281 </para></listitem></varlistentry>
283 <varlistentry><term>deldriverex <driver> [architecture] [version] [flags]
284 </term><listitem><para>Delete the specified printer driver and optionally files
285 associated with the driver.
286 You can limit this action to a specific architecture and a specific version.
287 If no architecture is given, all driver files of that driver will be deleted.
288 <parameter>flags</parameter> correspond to numeric DPD_* values, i.e. a value
289 of 3 requests (DPD_DELETE_UNUSED_FILES | DPD_DELETE_SPECIFIC_VERSION).
290 </para></listitem></varlistentry>
292 <varlistentry><term>enumdata</term><listitem><para>Enumerate all
293 printer setting data stored on the server. On Windows NT clients,
294 these values are stored in the registry, while Samba servers
295 store them in the printers TDB. This command corresponds
296 to the MS Platform SDK GetPrinterData() function (* This
297 command is currently unimplemented).</para></listitem></varlistentry>
299 <varlistentry><term>enumdataex</term><listitem><para>Enumerate printer data for a key</para></listitem></varlistentry>
301 <varlistentry><term>enumjobs <printer></term>
302 <listitem><para>List the jobs and status of a given printer.
303 This command corresponds to the MS Platform SDK EnumJobs()
304 function</para></listitem></varlistentry>
306 <varlistentry><term>enumkey</term><listitem><para>Enumerate
307 printer keys</para></listitem></varlistentry>
309 <varlistentry><term>enumports [level]</term>
311 Executes an EnumPorts() call using the specified
312 info level. Currently only info levels 1 and 2 are supported.
313 </para></listitem></varlistentry>
317 <varlistentry><term>enumdrivers [level]</term>
319 Execute an EnumPrinterDrivers() call. This lists the various installed
320 printer drivers for all architectures. Refer to the MS Platform SDK
321 documentation for more details of the various flags and calling
322 options. Currently supported info levels are 1, 2, and 3.</para></listitem></varlistentry>
326 <varlistentry><term>enumprinters [level]</term>
327 <listitem><para>Execute an EnumPrinters() call. This lists the various installed
328 and share printers. Refer to the MS Platform SDK documentation for
329 more details of the various flags and calling options. Currently
330 supported info levels are 1, 2 and 5.</para></listitem></varlistentry>
335 <varlistentry><term>getdata <printername> <valuename;></term>
336 <listitem><para>Retrieve the data for a given printer setting. See
337 the <command>enumdata</command> command for more information.
338 This command corresponds to the GetPrinterData() MS Platform
339 SDK function. </para></listitem></varlistentry>
341 <varlistentry><term>getdataex</term><listitem><para>Get
342 printer driver data with
343 keyname</para></listitem></varlistentry>
346 <varlistentry><term>getdriver <printername></term>
348 Retrieve the printer driver information (such as driver file,
349 config file, dependent files, etc...) for
350 the given printer. This command corresponds to the GetPrinterDriver()
351 MS Platform SDK function. Currently info level 1, 2, and 3 are supported.
352 </para></listitem></varlistentry>
355 <varlistentry><term>getdriverdir <arch></term>
357 Execute a GetPrinterDriverDirectory()
358 RPC to retrieve the SMB share name and subdirectory for
359 storing printer driver files for a given architecture. Possible
360 values for <parameter>arch</parameter> are "Windows 4.0"
361 (for Windows 95/98), "Windows NT x86", "Windows NT PowerPC", "Windows
362 Alpha_AXP", and "Windows NT R4000". </para></listitem></varlistentry>
366 <varlistentry><term>getprinter <printername></term>
367 <listitem><para>Retrieve the current printer information. This command
368 corresponds to the GetPrinter() MS Platform SDK function.
369 </para></listitem></varlistentry>
371 <varlistentry><term>getprintprocdir</term><listitem><para>Get
373 directory</para></listitem></varlistentry>
375 <varlistentry><term>openprinter <printername></term>
376 <listitem><para>Execute an OpenPrinterEx() and ClosePrinter() RPC
377 against a given printer. </para></listitem></varlistentry>
379 <varlistentry><term>setdriver <printername>
380 <drivername></term>
381 <listitem><para>Execute a SetPrinter() command to update the printer driver
382 associated with an installed printer. The printer driver must
383 already be correctly installed on the print server. </para>
385 <para>See also the <command>enumprinters</command> and
386 <command>enumdrivers</command> commands for obtaining a list of
387 of installed printers and drivers.</para></listitem></varlistentry>
389 <varlistentry><term>addform</term><listitem><para>Add form</para></listitem></varlistentry>
390 <varlistentry><term>setform</term><listitem><para>Set form</para></listitem></varlistentry>
391 <varlistentry><term>getform</term><listitem><para>Get form</para></listitem></varlistentry>
392 <varlistentry><term>deleteform</term><listitem><para>Delete form</para></listitem></varlistentry>
393 <varlistentry><term>enumforms</term><listitem><para>Enumerate form</para></listitem></varlistentry>
394 <varlistentry><term>setprinter</term><listitem><para>Set printer comment</para></listitem></varlistentry>
395 <varlistentry><term>setprinterdata</term><listitem><para>Set REG_SZ printer data</para></listitem></varlistentry>
397 <varlistentry><term>setprintername <printername>
398 <newprintername></term>
399 <listitem><para>Set printer name</para></listitem></varlistentry>
401 <varlistentry><term>rffpcnex</term><listitem><para>Rffpcnex test</para></listitem></varlistentry>
409 <title>NETLOGON</title>
413 <varlistentry><term>logonctrl2</term>
414 <listitem><para>Logon Control 2</para></listitem>
417 <varlistentry><term>logonctrl</term>
418 <listitem><para>Logon Control</para></listitem>
421 <varlistentry><term>samsync</term>
422 <listitem><para>Sam Synchronisation</para></listitem>
425 <varlistentry><term>samdeltas</term>
426 <listitem><para>Query Sam Deltas</para></listitem>
429 <varlistentry><term>samlogon</term>
430 <listitem><para>Sam Logon</para></listitem>
440 <varlistentry><term>fss_is_path_sup <share></term>
442 <para>Check whether a share supports shadow-copy
446 <varlistentry><term>fss_get_sup_version</term>
448 <para>Get supported FSRVP version from server</para>
451 <varlistentry><term>fss_create_expose <context> <[ro|rw]>
453 [share2] ... [shareN]</term>
455 <para>Request shadow-copy creation and exposure as a
459 <varlistentry><term>fss_delete <base_share>
460 <shadow_copy_set_id>
461 <shadow_copy_id></term>
463 <para>Request shadow-copy share deletion</para>
466 <varlistentry><term>fss_has_shadow_copy <base_share></term>
468 <para>Check for an associated share shadow-copy</para>
471 <varlistentry><term>fss_get_mapping <base_share>
472 <shadow_copy_set_id>
473 <shadow_copy_id></term>
475 <para>Get shadow-copy share mapping information</para>
478 <varlistentry><term>fss_recovery_complete <shadow_copy_set_id></term>
480 <para>Flag read-write shadow-copy as recovery complete,
481 allowing further shadow-copy requests</para>
489 <title>GENERAL COMMANDS</title>
492 <varlistentry><term>debuglevel</term><listitem><para>Set the current
493 debug level used to log information.</para></listitem></varlistentry>
495 <varlistentry><term>help (?)</term><listitem><para>Print a listing of all
496 known commands or extended help on a particular command.
497 </para></listitem></varlistentry>
499 <varlistentry><term>quit (exit)</term><listitem><para>Exit <command>rpcclient
500 </command>.</para></listitem></varlistentry>
509 <para><command>rpcclient</command> is designed as a developer testing tool
510 and may not be robust in certain areas (such as command line parsing).
511 It has been known to generate a core dump upon failures when invalid
512 parameters where passed to the interpreter. </para>
514 <para>From Luke Leighton's original rpcclient man page:</para>
516 <para><emphasis>WARNING!</emphasis> The MSRPC over SMB code has
517 been developed from examining Network traces. No documentation is
518 available from the original creators (Microsoft) on how MSRPC over
519 SMB works, or how the individual MSRPC services work. Microsoft's
520 implementation of these services has been demonstrated (and reported)
521 to be... a bit flaky in places. </para>
523 <para>The development of Samba's implementation is also a bit rough,
524 and as more of the services are understood, it can even result in
525 versions of <citerefentry><refentrytitle>smbd</refentrytitle>
526 <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>rpcclient</refentrytitle>
527 <manvolnum>1</manvolnum></citerefentry> that are incompatible for some commands or services. Additionally,
528 the developers are sending reports to Microsoft, and problems found
529 or reported to Microsoft are fixed in Service Packs, which may
530 result in incompatibilities.</para>
535 <title>VERSION</title>
537 <para>This man page is part of version &doc.version; of the Samba
542 <title>AUTHOR</title>
544 <para>The original Samba software and related utilities
545 were created by Andrew Tridgell. Samba is now developed
546 by the Samba Team as an Open Source project similar
547 to the way the Linux kernel is developed.</para>
549 <para>The original rpcclient man page was written by Matthew
550 Geddes, Luke Kenneth Casson Leighton, and rewritten by Gerald Carter.
551 The conversion to DocBook for Samba 2.2 was done by Gerald
552 Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was
553 done by Alexander Bokovoy.</para>