tests/krb5: Add parameter to enforce presence of ticket checksums
[Samba.git] / docs-xml / manpages / rpcclient.1.xml
blob18f9c14b09ea23a172b791c4df030ab6d372083e
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">
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">&doc.version;</refmiscinfo>
11 </refmeta>
14 <refnamediv>
15         <refname>rpcclient</refname>
16         <refpurpose>tool for executing client side 
17         MS-RPC functions</refpurpose>
18 </refnamediv>
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">-l logdir</arg>
27                 <arg choice="opt">-N</arg>
28                 <arg choice="opt">-s &lt;smb config file&gt;</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">BINDING-STRING|HOST</arg>
33         </cmdsynopsis>
34 </refsynopsisdiv>
36 <refsect1>
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>
47 </refsect1>
50 <refsect1>
51         <title>OPTIONS</title>
53         <variablelist>
54                 <varlistentry>
55                 <term>BINDING-STRING|HOST</term>
56                 <listitem>
57                         <para>When connecting to a dcerpc service you need to
58                         specify a binding string.</para>
60                         <para>The format is:</para>
62                         <para>TRANSPORT:host[options]</para>
64                         <para>where TRANSPORT is either ncacn_np (named pipes) for SMB or
65                         ncacn_ip_tcp for DCERPC over TCP/IP.</para>
67                         <para>"host" is an IP or hostname or netbios name. If the binding
68                         string identifies the server side of an endpoint, "host" may be
69                         an empty string. See below for more details.</para>
71                         <para>"options" can include a SMB pipe name if using the ncacn_np
72                         transport or a TCP port number if using the ncacn_ip_tcp transport,
73                         otherwise they will be auto-determined.</para>
75                         <para>Examples:</para>
77                         <itemizedlist>
78                         <listitem><para><parameter moreinfo="none">ncacn_ip_tcp:samba.example.com[1024]</parameter></para></listitem>
79                         <listitem><para><parameter moreinfo="none">ncacn_ip_tcp:samba.example.com[sign,seal,krb5]</parameter></para></listitem>
80                         <listitem><para><parameter moreinfo="none">ncacn_ip_tcp:samba.example.com[sign,spnego]</parameter></para></listitem>
81                         <listitem><para><parameter moreinfo="none">ncacn_np:samba.example.com</parameter></para></listitem>
82                         <listitem><para><parameter moreinfo="none">ncacn_np:samba.example.com[samr]</parameter></para></listitem>
83                         <listitem><para><parameter moreinfo="none">ncacn_np:samba.example.com[samr,sign,print]</parameter></para></listitem>
84                         <listitem><para><parameter moreinfo="none">ncalrpc:/path/to/unix/socket</parameter></para></listitem>
85                         <listitem><para><parameter moreinfo="none">//SAMBA</parameter></para></listitem>
86                         </itemizedlist>
88                         <para>The supported transports are:</para>
90                         <itemizedlist>
91                         <listitem><para><parameter moreinfo="none">ncacn_np</parameter> - Connect using named pipes</para></listitem>
92                         <listitem><para><parameter moreinfo="none">ncacn_ip_tcp</parameter> - Connect over TCP/IP</para></listitem>
93                         <listitem><para><parameter moreinfo="none">ncalrpc</parameter> - Connect over local RPC (unix sockets)</para></listitem>
94                         </itemizedlist>
96                         <para>The supported options are:</para>
98                         <itemizedlist>
99                         <listitem><para><parameter moreinfo="none">sign</parameter> - Use RPC integrity authentication level</para></listitem>
100                         <listitem><para><parameter moreinfo="none">seal</parameter> - Enable RPC privacy (encryption) authentication level</para></listitem>
101                         <listitem><para><parameter moreinfo="none">connect</parameter> - Use RPC connect level authentication (auth, but no sign or seal)</para></listitem>
102                         <listitem><para><parameter moreinfo="none">packet</parameter> - Use RPC packet authentication level</para></listitem>
104                         <listitem><para><parameter moreinfo="none">spnego</parameter> - Use SPNEGO instead of NTLMSSP authentication</para></listitem>
105                         <listitem><para><parameter moreinfo="none">ntlm</parameter> - Use plain NTLM instead of SPNEGO or NTLMSSP</para></listitem>
106                         <listitem><para><parameter moreinfo="none">krb5</parameter> - Use Kerberos instead of NTLMSSP authentication</para></listitem>
107                         <listitem><para><parameter moreinfo="none">schannel</parameter> - Create a schannel connection</para></listitem>
109                         <listitem><para><parameter moreinfo="none">smb1</parameter> - Use SMB1 for named pipes</para></listitem>
110                         <listitem><para><parameter moreinfo="none">smb2</parameter> - Use SMB2/3 for named pipes</para></listitem>
112                         <listitem><para><parameter moreinfo="none">validate</parameter> - Enable the NDR validator</para></listitem>
113                         <listitem><para><parameter moreinfo="none">print</parameter> - Enable debug output of packets</para></listitem>
114                         <listitem><para><parameter moreinfo="none">padcheck</parameter> - Check reply data for non-zero pad bytes</para></listitem>
115                         <listitem><para><parameter moreinfo="none">bigendian</parameter> - Use big endian for RPC</para></listitem>
116                         <listitem><para><parameter moreinfo="none">ndr64</parameter> - Use NDR64 for RPC</para></listitem>
117                         </itemizedlist>
119                 </listitem>
120                 </varlistentry>
123                 <varlistentry>
124                 <term>-c|--command=&lt;command string&gt;</term>
125                 <listitem><para>Execute semicolon separated commands (listed
126                 below) </para></listitem>
127                 </varlistentry>
129                 
130                 <varlistentry>
131                 <term>-I|--dest-ip IP-address</term>
132                 <listitem><para><replaceable>IP address</replaceable> is the address of the server to connect to. 
133                 It should be specified in standard "a.b.c.d" notation. </para>
135                 <para>Normally the client would attempt to locate a named 
136                 SMB/CIFS server by looking it up via the NetBIOS name resolution 
137                 mechanism described above in the <parameter>name resolve order</parameter> 
138                 parameter above. Using this parameter will force the client
139                 to assume that the server is on the machine with the specified IP 
140                 address and the NetBIOS name component of the resource being 
141                 connected to will be ignored. </para>
143                 <para>There is no default for this parameter. If not supplied, 
144                 it will be determined automatically by the client as described 
145                 above. </para></listitem>
146                 </varlistentry>
148                 <varlistentry>
149                 <term>-p|--port port</term>
150                 <listitem><para>This number is the TCP port number that will be used
151                 when making connections to the server. The standard (well-known)
152                 TCP port number for an SMB/CIFS server is 139, which is the
153                 default. </para></listitem>
154                 </varlistentry>
156                 &stdarg.server.debug;
157                 &popt.common.samba;
158                 &popt.common.credentials;               
159                 &popt.common.connection;
160                 &popt.autohelp;
161         </variablelist>
162 </refsect1>
165 <refsect1>
166         <title>COMMANDS</title>
168         <refsect2>
169         <title>LSARPC</title>
171         <variablelist>
172                 <varlistentry><term>lsaquery</term><listitem><para>Query info policy</para></listitem></varlistentry>
173                 
174                 <varlistentry><term>lookupsids</term><listitem><para>Resolve a list 
175                 of SIDs to usernames.
176                 </para></listitem></varlistentry>
177                 
178                 <varlistentry><term>lookupnames</term><listitem><para>Resolve a list 
179                 of usernames to SIDs.
180                 </para></listitem></varlistentry>
181                 
182                 <varlistentry><term>enumtrust</term><listitem><para>Enumerate trusted domains</para></listitem></varlistentry>
184                 <varlistentry><term>enumprivs</term><listitem><para>Enumerate privileges</para></listitem></varlistentry>
186                 <varlistentry><term>getdispname</term><listitem><para>Get the privilege name</para></listitem></varlistentry>
188                 <varlistentry><term>lsaenumsid</term><listitem><para>Enumerate the LSA SIDS</para></listitem></varlistentry>
190                 <varlistentry><term>lsaenumprivsaccount</term><listitem><para>Enumerate the privileges of an SID</para></listitem></varlistentry>
192                 <varlistentry><term>lsaenumacctrights</term><listitem><para>Enumerate the rights of an SID</para></listitem></varlistentry>
194                 <varlistentry><term>lsaenumacctwithright</term><listitem><para>Enumerate accounts with a right</para></listitem></varlistentry>
196                 <varlistentry><term>lsaaddacctrights</term><listitem><para>Add rights to an account</para></listitem></varlistentry>
198                 <varlistentry><term>lsaremoveacctrights</term><listitem><para>Remove rights from an account</para></listitem></varlistentry>
200                 <varlistentry><term>lsalookupprivvalue</term><listitem><para>Get a privilege value given its name</para></listitem></varlistentry>
202                 <varlistentry><term>lsaquerysecobj</term><listitem><para>Query LSA security object</para></listitem></varlistentry>
204         </variablelist> 
205         </refsect2>
206         
207         <refsect2>
208         <title>LSARPC-DS</title>
209         
210         <variablelist>
211                 <varlistentry><term>dsroledominfo</term><listitem><para>Get Primary Domain Information</para></listitem></varlistentry>
212         </variablelist>
214         <para> </para>
216         <para><emphasis>DFS</emphasis></para>
217         <variablelist>
218                 <varlistentry><term>dfsexist</term><listitem><para>Query DFS support</para></listitem></varlistentry>
219                 <varlistentry><term>dfsadd</term><listitem><para>Add a DFS share</para></listitem></varlistentry>
220                 <varlistentry><term>dfsremove</term><listitem><para>Remove a DFS share</para></listitem></varlistentry>
221                 <varlistentry><term>dfsgetinfo</term><listitem><para>Query DFS share info</para></listitem></varlistentry>
222                 <varlistentry><term>dfsenum</term><listitem><para>Enumerate dfs shares</para></listitem></varlistentry>
223         </variablelist>
225         </refsect2>
227         <refsect2>
228         <title>REG</title>
229         <variablelist>
230                 <varlistentry><term>shutdown</term><listitem><para>Remote Shutdown</para></listitem></varlistentry>
231                 <varlistentry><term>abortshutdown</term><listitem><para>Abort Shutdown</para></listitem></varlistentry>
232         </variablelist>
234         </refsect2>
236         <refsect2>
237         <title>SRVSVC</title>
239         <variablelist>
240                 <varlistentry><term>srvinfo</term><listitem><para>Server query info</para></listitem></varlistentry>
241                 <varlistentry><term>netshareenum</term><listitem><para>Enumerate shares</para></listitem></varlistentry>
242                 <varlistentry><term>netshareenumall</term><listitem><para>Enumerate all shares</para></listitem></varlistentry>
243                 <varlistentry><term>netsharegetinfo</term><listitem><para>Get Share Info</para></listitem></varlistentry>
244                 <varlistentry><term>netsharesetinfo</term><listitem><para>Set Share Info</para></listitem></varlistentry>
245                 <varlistentry><term>netsharesetdfsflags</term><listitem><para>Set DFS flags</para></listitem></varlistentry>
246                 <varlistentry><term>netfileenum</term><listitem><para>Enumerate open files</para></listitem></varlistentry>
247                 <varlistentry><term>netremotetod</term><listitem><para>Fetch remote time of day</para></listitem></varlistentry>
248                 <varlistentry><term>netnamevalidate</term><listitem><para>Validate sharename</para></listitem></varlistentry>
249                 <varlistentry><term>netfilegetsec</term><listitem><para>Get File security</para></listitem></varlistentry>
250                 <varlistentry><term>netsessdel</term><listitem><para>Delete Session</para></listitem></varlistentry>
251                 <varlistentry><term>netsessenum</term><listitem><para>Enumerate Sessions</para></listitem></varlistentry>
252                 <varlistentry><term>netdiskenum</term><listitem><para>Enumerate Disks</para></listitem></varlistentry>
253                 <varlistentry><term>netconnenum</term><listitem><para>Enumerate Connections</para></listitem></varlistentry>
254                 <varlistentry><term>netshareadd</term><listitem><para>Add share</para></listitem></varlistentry>
255                 <varlistentry><term>netsharedel</term><listitem><para>Delete share</para></listitem></varlistentry>
256         </variablelist>
258         </refsect2>
260         <refsect2>
261         <title>SAMR</title>
263         <variablelist>
264                 <varlistentry><term>queryuser</term><listitem><para>Query user info</para></listitem></varlistentry>
265                 <varlistentry><term>querygroup</term><listitem><para>Query group info</para></listitem></varlistentry>
266                 <varlistentry><term>queryusergroups</term><listitem><para>Query user groups</para></listitem></varlistentry>
267                 <varlistentry><term>querygroupmem</term><listitem><para>Query group membership</para></listitem></varlistentry>
268                 <varlistentry><term>queryaliasmem</term><listitem><para>Query alias membership</para></listitem></varlistentry>
269                 <varlistentry><term>querydispinfo</term><listitem><para>Query display info</para></listitem></varlistentry>
270                 <varlistentry><term>querydominfo</term><listitem><para>Query domain info</para></listitem></varlistentry>
271                 <varlistentry><term>enumdomusers</term><listitem><para>Enumerate domain users</para></listitem></varlistentry>
272                 <varlistentry><term>enumdomgroups</term><listitem><para>Enumerate domain groups</para></listitem></varlistentry>
273                 <varlistentry><term>enumalsgroups</term><listitem><para>Enumerate alias groups</para></listitem></varlistentry>
274                 <varlistentry><term>createdomuser</term><listitem><para>Create domain user</para></listitem></varlistentry>
275                 <varlistentry><term>samlookupnames</term><listitem><para>Look up names</para></listitem></varlistentry>
276                 <varlistentry><term>samlookuprids</term><listitem><para>Look up names</para></listitem></varlistentry>
277                 <varlistentry><term>deletedomuser</term><listitem><para>Delete domain user</para></listitem></varlistentry>
278                 <varlistentry><term>samquerysecobj</term><listitem><para>Query SAMR security object</para></listitem></varlistentry>
279                 <varlistentry><term>getdompwinfo</term><listitem><para>Retrieve domain password info</para></listitem></varlistentry>
280                 <varlistentry><term>lookupdomain</term><listitem><para>Look up domain</para></listitem></varlistentry>
281         </variablelist>
283         </refsect2>
285         <refsect2>
286         <title>SPOOLSS</title>
288         <variablelist>
289                 <varlistentry><term>adddriver &lt;arch&gt; &lt;config&gt; [&lt;version&gt;]</term> 
290                 <listitem><para>
291                 Execute an AddPrinterDriver() RPC to install the printer driver 
292                 information on the server.  Note that the driver files should 
293                 already exist in the directory returned by  
294                 <command>getdriverdir</command>.  Possible values for 
295                 <parameter>arch</parameter> are the same as those for 
296                 the <command>getdriverdir</command> command.
297                 The <parameter>config</parameter> parameter is defined as 
298                 follows: </para>
299                 
300 <para><programlisting>
301 Long Driver Name:\
302 Driver File Name:\
303 Data File Name:\
304 Config File Name:\
305 Help File Name:\
306 Language Monitor Name:\
307 Default Data Type:\
308 Comma Separated list of Files
309 </programlisting></para>
311                 <para>Any empty fields should be enter as the string "NULL". </para>
312                 
313                 <para>Samba does not need to support the concept of Print Monitors
314                 since these only apply to local printers whose driver can make
315                 use of a bi-directional link for communication.  This field should 
316                 be "NULL".   On a remote NT print server, the Print Monitor for a 
317                 driver must already be installed prior to adding the driver or 
318                 else the RPC will fail. </para>
320                 <para>The <parameter>version</parameter> parameter lets you
321                 specify the printer driver version number.  If omitted, the
322                 default driver version for the specified architecture will
323                 be used.  This option can be used to upload Windows 2000
324                 (version 3) printer drivers.</para></listitem></varlistentry>
325         
326                 <varlistentry><term>addprinter &lt;printername&gt; 
327                 &lt;sharename&gt; &lt;drivername&gt; &lt;port&gt;</term>
328                 <listitem><para>
329                 Add a printer on the remote server.  This printer 
330                 will be automatically shared.  Be aware that the printer driver 
331                 must already be installed on the server (see <command>adddriver</command>) 
332                 and the <parameter>port</parameter>must be a valid port name (see
333                 <command>enumports</command>.</para>
334                 </listitem></varlistentry>
337                 <varlistentry><term>deldriver &lt;driver&gt;</term><listitem><para>Delete the
338                 specified printer driver for all architectures.  This
339                 does not delete the actual driver files from the server,
340                 only the entry from the server's list of drivers.
341                 </para></listitem></varlistentry>
343                 <varlistentry><term>deldriverex &lt;driver&gt; [architecture] [version] [flags]
344                 </term><listitem><para>Delete the specified printer driver and optionally files
345                 associated with the driver.
346                 You can limit this action to a specific architecture and a specific version.
347                 If no architecture is given, all driver files of that driver will be deleted.
348                 <parameter>flags</parameter> correspond to numeric DPD_* values, i.e. a value
349                 of 3 requests (DPD_DELETE_UNUSED_FILES | DPD_DELETE_SPECIFIC_VERSION).
350                 </para></listitem></varlistentry>
352                 <varlistentry><term>enumdata</term><listitem><para>Enumerate all 
353                 printer setting data stored on the server. On Windows NT  clients, 
354                 these values are stored  in the registry, while Samba servers 
355                 store them in the printers TDB.  This command corresponds
356                 to the MS Platform SDK GetPrinterData() function (* This
357                 command is currently unimplemented).</para></listitem></varlistentry>
359                 <varlistentry><term>enumdataex</term><listitem><para>Enumerate printer data for a key</para></listitem></varlistentry>
361                 <varlistentry><term>enumjobs &lt;printer&gt;</term>
362                 <listitem><para>List the jobs and status of a given printer. 
363                 This command corresponds to the MS Platform SDK EnumJobs() 
364                 function</para></listitem></varlistentry>
366                 <varlistentry><term>enumkey</term><listitem><para>Enumerate
367                 printer keys</para></listitem></varlistentry>
368                 
369                 <varlistentry><term>enumports [level]</term>
370                 <listitem><para>
371                 Executes an EnumPorts() call using the specified 
372                 info level. Currently only info levels 1 and 2 are supported. 
373                 </para></listitem></varlistentry>
377                 <varlistentry><term>enumdrivers [level]</term> 
378                 <listitem><para>
379                 Execute an EnumPrinterDrivers() call.  This lists the various installed 
380                 printer drivers for all architectures.  Refer to the MS Platform SDK 
381                 documentation for more details of the various flags and calling 
382                 options. Currently supported info levels are 1, 2, and 3.</para></listitem></varlistentry>
386                 <varlistentry><term>enumprinters [level]</term>
387                 <listitem><para>Execute an EnumPrinters() call.  This lists the various installed 
388                 and share printers.  Refer to the MS Platform SDK documentation for 
389                 more details of the various flags and calling options. Currently
390                 supported info levels are 1, 2 and 5.</para></listitem></varlistentry>
395                 <varlistentry><term>getdata &lt;printername&gt; &lt;valuename;&gt;</term> 
396                 <listitem><para>Retrieve the data for a given printer setting.  See 
397                 the  <command>enumdata</command> command for more information.  
398                 This command corresponds to the GetPrinterData() MS Platform 
399                 SDK function. </para></listitem></varlistentry>
401                 <varlistentry><term>getdataex</term><listitem><para>Get
402                 printer driver data with
403                 keyname</para></listitem></varlistentry>
405                 
406                 <varlistentry><term>getdriver &lt;printername&gt;</term>
407                 <listitem><para>
408                 Retrieve the printer driver information (such as driver file, 
409                 config file, dependent files, etc...) for 
410                 the given printer. This command corresponds to the GetPrinterDriver()
411                 MS Platform  SDK function. Currently info level 1, 2, and 3 are supported.
412                 </para></listitem></varlistentry>
413         
415                 <varlistentry><term>getdriverdir &lt;arch&gt;</term>
416                 <listitem><para>
417                 Execute a GetPrinterDriverDirectory()
418                 RPC to retrieve the SMB share name and subdirectory for 
419                 storing printer driver files for a given architecture.  Possible 
420                 values for <parameter>arch</parameter> are "Windows 4.0" 
421                 (for Windows 95/98), "Windows NT x86", "Windows NT PowerPC", "Windows
422                 Alpha_AXP", and "Windows NT R4000". </para></listitem></varlistentry>
426                 <varlistentry><term>getprinter &lt;printername&gt;</term> 
427                 <listitem><para>Retrieve the current printer information.  This command 
428                 corresponds to the GetPrinter() MS Platform SDK function. 
429                 </para></listitem></varlistentry>
431                 <varlistentry><term>getprintprocdir</term><listitem><para>Get
432                 print processor
433                 directory</para></listitem></varlistentry>
434                 
435                 <varlistentry><term>openprinter &lt;printername&gt;</term> 
436                 <listitem><para>Execute an OpenPrinterEx() and ClosePrinter() RPC 
437                 against a given printer. </para></listitem></varlistentry>
439                 <varlistentry><term>setdriver &lt;printername&gt;
440                 &lt;drivername&gt;</term>
441                 <listitem><para>Execute a SetPrinter() command to update the printer driver
442                 associated with an installed printer.  The printer driver must
443                 already be correctly installed on the print server.  </para>
445                 <para>See also the <command>enumprinters</command> and 
446                 <command>enumdrivers</command> commands for obtaining a list of
447                 of installed printers and drivers.</para></listitem></varlistentry>
449                 <varlistentry><term>addform</term><listitem><para>Add form</para></listitem></varlistentry>
450                 <varlistentry><term>setform</term><listitem><para>Set form</para></listitem></varlistentry>
451                 <varlistentry><term>getform</term><listitem><para>Get form</para></listitem></varlistentry>
452                 <varlistentry><term>deleteform</term><listitem><para>Delete form</para></listitem></varlistentry>
453                 <varlistentry><term>enumforms</term><listitem><para>Enumerate form</para></listitem></varlistentry>
454                 <varlistentry><term>setprinter</term><listitem><para>Set printer comment</para></listitem></varlistentry>
455                 <varlistentry><term>setprinterdata</term><listitem><para>Set REG_SZ printer data</para></listitem></varlistentry>
457                 <varlistentry><term>setprintername &lt;printername&gt;
458                 &lt;newprintername&gt;</term>
459                 <listitem><para>Set printer name</para></listitem></varlistentry>
461                 <varlistentry><term>rffpcnex</term><listitem><para>Rffpcnex test</para></listitem></varlistentry>
462                 
464         </variablelist>
466         </refsect2>
468         <refsect2>
469         <title>NETLOGON</title>
471         <variablelist>
473         <varlistentry><term>logonctrl2</term>
474         <listitem><para>Logon Control 2</para></listitem>
475         </varlistentry>
477         <varlistentry><term>logonctrl</term>
478         <listitem><para>Logon Control</para></listitem>
479         </varlistentry>
481         <varlistentry><term>samsync</term>
482         <listitem><para>Sam Synchronisation</para></listitem>
483         </varlistentry>
485         <varlistentry><term>samdeltas</term>
486         <listitem><para>Query Sam Deltas</para></listitem>
487         </varlistentry>
489         <varlistentry><term>samlogon</term>
490         <listitem><para>Sam Logon</para></listitem>
491         </varlistentry>
493         </variablelist>
494         </refsect2>
496         <refsect2>
497         <title>FSRVP</title>
498         <variablelist>
500         <varlistentry><term>fss_is_path_sup &lt;share&gt;</term>
501                 <listitem>
502                         <para>Check whether a share supports shadow-copy
503                         requests</para>
504                 </listitem>
505         </varlistentry>
506         <varlistentry><term>fss_get_sup_version</term>
507                 <listitem>
508                         <para>Get supported FSRVP version from server</para>
509                 </listitem>
510         </varlistentry>
511         <varlistentry><term>fss_create_expose &lt;context&gt; &lt;[ro|rw]&gt;
512                                               &lt;share1&gt;
513                                               [share2] ... [shareN]</term>
514                 <listitem>
515                         <para>Request shadow-copy creation and exposure as a
516                         new share</para>
517                 </listitem>
518         </varlistentry>
519         <varlistentry><term>fss_delete &lt;base_share&gt;
520                                        &lt;shadow_copy_set_id&gt;
521                                        &lt;shadow_copy_id&gt;</term>
522                 <listitem>
523                         <para>Request shadow-copy share deletion</para>
524         </listitem>
525         </varlistentry>
526         <varlistentry><term>fss_has_shadow_copy &lt;base_share&gt;</term>
527                 <listitem>
528                         <para>Check for an associated share shadow-copy</para>
529                 </listitem>
530         </varlistentry>
531         <varlistentry><term>fss_get_mapping &lt;base_share&gt;
532                                             &lt;shadow_copy_set_id&gt;
533                                             &lt;shadow_copy_id&gt;</term>
534                 <listitem>
535                         <para>Get shadow-copy share mapping information</para>
536                 </listitem>
537         </varlistentry>
538         <varlistentry><term>fss_recovery_complete &lt;shadow_copy_set_id&gt;</term>
539                 <listitem>
540                         <para>Flag read-write shadow-copy as recovery complete,
541                         allowing further shadow-copy requests</para>
542                 </listitem>
543         </varlistentry>
545         </variablelist>
546         </refsect2>
548         <refsect2>
549         <title>GENERAL COMMANDS</title>
551         <variablelist>
552                 <varlistentry><term>debuglevel</term><listitem><para>Set the current
553                 debug level used to log information.</para></listitem></varlistentry>
555                 <varlistentry><term>help (?)</term><listitem><para>Print a listing of all 
556                 known commands or extended help  on a particular command. 
557                 </para></listitem></varlistentry>
558                 
559                 <varlistentry><term>quit (exit)</term><listitem><para>Exit <command>rpcclient
560                 </command>.</para></listitem></varlistentry>
561         </variablelist>
562         </refsect2>
564 </refsect1>
566 <refsect1>
567         <title>BUGS</title>
568         
569         <para><command>rpcclient</command> is designed as a developer testing tool 
570         and may not be robust in certain areas (such as command line parsing).  
571         It has been known to  generate a core dump upon failures when invalid 
572         parameters where passed to the interpreter. </para>
574         <para>From Luke Leighton's original rpcclient man page:</para>
575         
576         <para><emphasis>WARNING!</emphasis> The MSRPC over SMB code has 
577         been developed from examining  Network traces. No documentation is 
578         available from the original creators  (Microsoft) on how MSRPC over 
579         SMB works, or how the individual MSRPC services  work. Microsoft's 
580         implementation of these services has been demonstrated  (and reported) 
581         to be... a bit flaky in places. </para>
583         <para>The development of Samba's implementation is also a bit rough, 
584         and as more of the services are understood, it can even result in 
585         versions of <citerefentry><refentrytitle>smbd</refentrytitle>
586         <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>rpcclient</refentrytitle>
587         <manvolnum>1</manvolnum></citerefentry> that are incompatible for some commands or  services. Additionally, 
588         the developers are sending reports to Microsoft,  and problems found 
589         or reported to Microsoft are fixed in Service Packs,  which may 
590         result in incompatibilities.</para>
591 </refsect1>
594 <refsect1>
595         <title>VERSION</title>
597         <para>This man page is part of version &doc.version; of the Samba
598         suite.</para>
599 </refsect1>
601 <refsect1>
602         <title>AUTHOR</title>
603         
604         <para>The original Samba software and related utilities 
605         were created by Andrew Tridgell. Samba is now developed
606         by the Samba Team as an Open Source project similar 
607         to the way the Linux kernel is developed.</para>
608         
609         <para>The original rpcclient man page was written by Matthew 
610         Geddes, Luke Kenneth Casson Leighton, and rewritten by Gerald Carter.  
611         The conversion to DocBook for Samba 2.2 was done by Gerald 
612         Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was
613         done by Alexander Bokovoy.</para>
614 </refsect1>
616 </refentry>