4e3d30c0970b6e84db0d78595a78e9b122f0c6a2
[sfrench/samba-autobuild/.git] / docs-xml / manpages / rpcclient.1.xml
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">
4
5 <refmeta>
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">3.6</refmiscinfo>
11 </refmeta>
12
13
14 <refnamediv>
15         <refname>rpcclient</refname>
16         <refpurpose>tool for executing client side 
17         MS-RPC functions</refpurpose>
18 </refnamediv>
19
20 <refsynopsisdiv>
21         <cmdsynopsis>
22                 <command>rpcclient</command>
23                 <arg choice="opt">-A authfile</arg>
24                 <arg choice="opt">-c &lt;command string&gt;</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 &lt;smb config file&gt;</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>
34         </cmdsynopsis>
35 </refsynopsisdiv>
36
37 <refsect1>
38         <title>DESCRIPTION</title>
39
40         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
41         <manvolnum>7</manvolnum></citerefentry> suite.</para>
42
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>
48 </refsect1>
49
50
51 <refsect1>
52         <title>OPTIONS</title>
53
54         <variablelist>
55                 <varlistentry>
56                 <term>server</term>
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>
61         </varlistentry>
62
63
64                 <varlistentry>
65                 <term>-c|--command=&lt;command string&gt;</term>
66                 <listitem><para>Execute semicolon separated commands (listed
67                 below) </para></listitem>
68                 </varlistentry>
69
70                 
71                 <varlistentry>
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>
75
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>
83
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>
87                 </varlistentry>
88
89                 <varlistentry>
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>
95                 </varlistentry>
96
97                 &stdarg.server.debug;
98                 &popt.common.samba;
99                 &popt.common.credentials;               
100                 &popt.common.connection;
101                 &stdarg.help;
102         </variablelist>
103 </refsect1>
104
105
106 <refsect1>
107         <title>COMMANDS</title>
108
109         <refsect2>
110         <title>LSARPC</title>
111
112         <variablelist>
113                 <varlistentry><term>lsaquery</term><listitem><para>Query info policy</para></listitem></varlistentry>
114                 
115                 <varlistentry><term>lookupsids</term><listitem><para>Resolve a list 
116                 of SIDs to usernames.
117                 </para></listitem></varlistentry>
118                 
119                 <varlistentry><term>lookupnames</term><listitem><para>Resolve a list 
120                 of usernames to SIDs.
121                 </para></listitem></varlistentry>
122                 
123                 <varlistentry><term>enumtrust</term><listitem><para>Enumerate trusted domains</para></listitem></varlistentry>
124
125                 <varlistentry><term>enumprivs</term><listitem><para>Enumerate privileges</para></listitem></varlistentry>
126
127                 <varlistentry><term>getdispname</term><listitem><para>Get the privilege name</para></listitem></varlistentry>
128
129                 <varlistentry><term>lsaenumsid</term><listitem><para>Enumerate the LSA SIDS</para></listitem></varlistentry>
130
131                 <varlistentry><term>lsaenumprivsaccount</term><listitem><para>Enumerate the privileges of an SID</para></listitem></varlistentry>
132
133                 <varlistentry><term>lsaenumacctrights</term><listitem><para>Enumerate the rights of an SID</para></listitem></varlistentry>
134
135                 <varlistentry><term>lsaenumacctwithright</term><listitem><para>Enumerate accounts with a right</para></listitem></varlistentry>
136
137                 <varlistentry><term>lsaaddacctrights</term><listitem><para>Add rights to an account</para></listitem></varlistentry>
138
139                 <varlistentry><term>lsaremoveacctrights</term><listitem><para>Remove rights from an account</para></listitem></varlistentry>
140
141                 <varlistentry><term>lsalookupprivvalue</term><listitem><para>Get a privilege value given its name</para></listitem></varlistentry>
142
143                 <varlistentry><term>lsaquerysecobj</term><listitem><para>Query LSA security object</para></listitem></varlistentry>
144
145         </variablelist> 
146         </refsect2>
147         
148         <refsect2>
149         <title>LSARPC-DS</title>
150         
151         <variablelist>
152                 <varlistentry><term>dsroledominfo</term><listitem><para>Get Primary Domain Information</para></listitem></varlistentry>
153         </variablelist>
154
155         <para> </para>
156
157         <para><emphasis>DFS</emphasis></para>
158         <variablelist>
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>
164         </variablelist>
165
166         </refsect2>
167
168         <refsect2>
169         <title>REG</title>
170         <variablelist>
171                 <varlistentry><term>shutdown</term><listitem><para>Remote Shutdown</para></listitem></varlistentry>
172                 <varlistentry><term>abortshutdown</term><listitem><para>Abort Shutdown</para></listitem></varlistentry>
173         </variablelist>
174
175         </refsect2>
176
177         <refsect2>
178         <title>SRVSVC</title>
179
180         <variablelist>
181                 <varlistentry><term>srvinfo</term><listitem><para>Server query info</para></listitem></varlistentry>
182                 
183                 <varlistentry><term>netshareenum</term><listitem><para>Enumerate shares</para></listitem></varlistentry>
184
185                 <varlistentry><term>netfileenum</term><listitem><para>Enumerate open files</para></listitem></varlistentry>
186                 
187                 <varlistentry><term>netremotetod</term><listitem><para>Fetch remote time of day</para></listitem></varlistentry>
188                 
189         </variablelist>
190
191         </refsect2>
192
193         <refsect2>
194         <title>SAMR</title>
195
196         <variablelist>
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>
214         </variablelist>
215
216         </refsect2>
217
218         <refsect2>
219         <title>SPOOLSS</title>
220
221         <variablelist>
222                 <varlistentry><term>adddriver &lt;arch&gt; &lt;config&gt; [&lt;version&gt;]</term> 
223                 <listitem><para>
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 
231                 follows: </para>
232                 
233 <para><programlisting>
234 Long Printer Name:\
235 Driver File Name:\
236 Data File Name:\
237 Config File Name:\
238 Help File Name:\
239 Language Monitor Name:\
240 Default Data Type:\
241 Comma Separated list of Files
242 </programlisting></para>
243
244                 <para>Any empty fields should be enter as the string "NULL". </para>
245                 
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>
252
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>
258         
259                 <varlistentry><term>addprinter &lt;printername&gt; 
260                 &lt;sharename&gt; &lt;drivername&gt; &lt;port&gt;</term>
261                 <listitem><para>
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>
268
269
270                 <varlistentry><term>deldriver &lt;driver&gt;</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>
275
276                 <varlistentry><term>deldriverex &lt;driver&gt; [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>
284
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>
291
292                 <varlistentry><term>enumdataex</term><listitem><para>Enumerate printer data for a key</para></listitem></varlistentry>
293
294                 <varlistentry><term>enumjobs &lt;printer&gt;</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>
298
299                 <varlistentry><term>enumkey</term><listitem><para>Enumerate
300                 printer keys</para></listitem></varlistentry>
301                 
302                 <varlistentry><term>enumports [level]</term>
303                 <listitem><para>
304                 Executes an EnumPorts() call using the specified 
305                 info level. Currently only info levels 1 and 2 are supported. 
306                 </para></listitem></varlistentry>
307
308
309
310                 <varlistentry><term>enumdrivers [level]</term> 
311                 <listitem><para>
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>
316
317
318
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>
324
325
326
327
328                 <varlistentry><term>getdata &lt;printername&gt; &lt;valuename;&gt;</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>
333
334                 <varlistentry><term>getdataex</term><listitem><para>Get
335                 printer driver data with
336                 keyname</para></listitem></varlistentry>
337
338                 
339                 <varlistentry><term>getdriver &lt;printername&gt;</term>
340                 <listitem><para>
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>
346         
347
348                 <varlistentry><term>getdriverdir &lt;arch&gt;</term>
349                 <listitem><para>
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>
356
357
358
359                 <varlistentry><term>getprinter &lt;printername&gt;</term> 
360                 <listitem><para>Retrieve the current printer information.  This command 
361                 corresponds to the GetPrinter() MS Platform SDK function. 
362                 </para></listitem></varlistentry>
363
364                 <varlistentry><term>getprintprocdir</term><listitem><para>Get
365                 print processor
366                 directory</para></listitem></varlistentry>
367                 
368                 <varlistentry><term>openprinter &lt;printername&gt;</term> 
369                 <listitem><para>Execute an OpenPrinterEx() and ClosePrinter() RPC 
370                 against a given printer. </para></listitem></varlistentry>
371
372                 <varlistentry><term>setdriver &lt;printername&gt;
373                 &lt;drivername&gt;</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>
377
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>
381
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>
389
390                 <varlistentry><term>setprintername &lt;printername&gt;
391                 &lt;newprintername&gt;</term>
392                 <listitem><para>Set printer name</para></listitem></varlistentry>
393
394                 <varlistentry><term>rffpcnex</term><listitem><para>Rffpcnex test</para></listitem></varlistentry>
395                 
396
397         </variablelist>
398
399         </refsect2>
400
401         <refsect2>
402         <title>NETLOGON</title>
403
404         <variablelist>
405
406         <varlistentry><term>logonctrl2</term>
407         <listitem><para>Logon Control 2</para></listitem>
408         </varlistentry>
409
410         <varlistentry><term>logonctrl</term>
411         <listitem><para>Logon Control</para></listitem>
412         </varlistentry>
413
414         <varlistentry><term>samsync</term>
415         <listitem><para>Sam Synchronisation</para></listitem>
416         </varlistentry>
417
418         <varlistentry><term>samdeltas</term>
419         <listitem><para>Query Sam Deltas</para></listitem>
420         </varlistentry>
421
422         <varlistentry><term>samlogon</term>
423         <listitem><para>Sam Logon</para></listitem>
424         </varlistentry>
425
426         </variablelist>
427         </refsect2>
428
429         <refsect2>
430         <title>FSRVP</title>
431         <variablelist>
432
433         <varlistentry><term>fss_is_path_sup</term>
434                 <listitem>
435                         <para>Check whether a share supports shadow-copy
436                         requests</para>
437                 </listitem>
438         </varlistentry>
439         <varlistentry><term>fss_get_sup_version</term>
440                 <listitem>
441                         <para>Get supported FSRVP version from server</para>
442                 </listitem>
443         </varlistentry>
444         <varlistentry><term>fss_create_expose</term>
445                 <listitem>
446                         <para>Request shadow-copy creation and exposure</para>
447                 </listitem>
448         </varlistentry>
449         <varlistentry><term>fss_delete</term>
450                 <listitem>
451                         <para>Request shadow-copy share deletion</para>
452         </listitem>
453         </varlistentry>
454         <varlistentry><term>fss_has_shadow_copy</term>
455                 <listitem>
456                         <para>Check for an associated share shadow-copy</para>
457                 </listitem>
458         </varlistentry>
459         <varlistentry><term>fss_get_mapping</term>
460                 <listitem>
461                         <para>Get shadow-copy share mapping information</para>
462                 </listitem>
463         </varlistentry>
464         <varlistentry><term>fss_recovery_complete</term>
465                 <listitem>
466                         <para>Flag read-write snapshot as recovery complete,
467                         allowing further shadow-copy requests</para>
468                 </listitem>
469         </varlistentry>
470
471         </variablelist>
472         </refsect2>
473
474         <refsect2>
475         <title>GENERAL COMMANDS</title>
476
477         <variablelist>
478                 <varlistentry><term>debuglevel</term><listitem><para>Set the current
479                 debug level used to log information.</para></listitem></varlistentry>
480
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>
484                 
485                 <varlistentry><term>quit (exit)</term><listitem><para>Exit <command>rpcclient
486                 </command>.</para></listitem></varlistentry>
487         </variablelist>
488         </refsect2>
489
490 </refsect1>
491
492 <refsect1>
493         <title>BUGS</title>
494         
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>
499
500         <para>From Luke Leighton's original rpcclient man page:</para>
501         
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>
508
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>
517 </refsect1>
518
519
520 <refsect1>
521         <title>VERSION</title>
522
523         <para>This man page is correct for version 3 of the Samba 
524         suite.</para>
525 </refsect1>
526
527 <refsect1>
528         <title>AUTHOR</title>
529         
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>
534         
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>
540 </refsect1>
541
542 </refentry>