ctdb: setup $CTDB_BASE for deterministic ip alloc tests
[Samba.git] / docs-xml / manpages / rpcclient.1.xml
blobe57d614247f89b32a07562780346b7d7b0b54ef0
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">-c|--command=COMMANDS</arg>
24                 <arg choice="opt">-I|--dest-ip=IP</arg>
25                 <arg choice="opt">-p|--port=PORT</arg>
26                 <arg choice="opt">-?|--help</arg>
27                 <arg choice="opt">--usage</arg>
28                 <arg choice="opt">-d|--debuglevel=DEBUGLEVEL</arg>
29                 <arg choice="opt">--debug-stdout</arg>
30                 <arg choice="opt">--configfile=CONFIGFILE</arg>
31                 <arg choice="opt">--option=name=value</arg>
32                 <arg choice="opt">-l|--log-basename=LOGFILEBASE</arg>
33                 <arg choice="opt">--leak-report</arg>
34                 <arg choice="opt">--leak-report-full</arg>
35                 <arg choice="opt">-R|--name-resolve=NAME-RESOLVE-ORDER</arg>
36                 <arg choice="opt">-O|--socket-options=SOCKETOPTIONS</arg>
37                 <arg choice="opt">-m|--max-protocol=MAXPROTOCOL</arg>
38                 <arg choice="opt">-n|--netbiosname=NETBIOSNAME</arg>
39                 <arg choice="opt">--netbios-scope=SCOPE</arg>
40                 <arg choice="opt">-W|--workgroup=WORKGROUP</arg>
41                 <arg choice="opt">--realm=REALM</arg>
42                 <arg choice="opt">-U|--user=[DOMAIN/]USERNAME[%PASSWORD]</arg>
43                 <arg choice="opt">-N|--no-pass</arg>
44                 <arg choice="opt">--password=STRING</arg>
45                 <arg choice="opt">--pw-nt-hash</arg>
46                 <arg choice="opt">-A|--authentication-file=FILE</arg>
47                 <arg choice="opt">-P|--machine-pass</arg>
48                 <arg choice="opt">--simple-bind-dn=DN</arg>
49                 <arg choice="opt">--use-kerberos=desired|required|off</arg>
50                 <arg choice="opt">--use-krb5-ccache=CCACHE</arg>
51                 <arg choice="opt">--use-winbind-ccache</arg>
52                 <arg choice="opt">--client-protection=sign|encrypt|off</arg>
53                 <arg choice="opt">-V|--version</arg>
54                 <arg choice="req">BINDING-STRING|HOST</arg>
55         </cmdsynopsis>
56 </refsynopsisdiv>
58 <refsect1>
59         <title>DESCRIPTION</title>
61         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
62         <manvolnum>7</manvolnum></citerefentry> suite.</para>
64         <para><command>rpcclient</command> is a utility initially developed
65         to test MS-RPC functionality in Samba itself.  It has undergone
66         several stages of development and stability.  Many system administrators
67         have now written scripts around it to manage Windows NT clients from
68         their UNIX workstation. </para>
69 </refsect1>
72 <refsect1>
73         <title>OPTIONS</title>
75         <variablelist>
76                 <varlistentry>
77                 <term>BINDING-STRING|HOST</term>
78                 <listitem>
79                         <para>When connecting to a dcerpc service you need to
80                         specify a binding string.</para>
82                         <para>The format is:</para>
84                         <para>TRANSPORT:host[options]</para>
86                         <para>where TRANSPORT is either ncacn_np (named pipes) for SMB or
87                         ncacn_ip_tcp for DCERPC over TCP/IP.</para>
89                         <para>"host" is an IP or hostname or netbios name. If the binding
90                         string identifies the server side of an endpoint, "host" may be
91                         an empty string. See below for more details.</para>
93                         <para>"options" can include a SMB pipe name if using the ncacn_np
94                         transport or a TCP port number if using the ncacn_ip_tcp transport,
95                         otherwise they will be auto-determined.</para>
97                         <para>Examples:</para>
99                         <itemizedlist>
100                         <listitem><para><parameter moreinfo="none">ncacn_ip_tcp:samba.example.com[1024]</parameter></para></listitem>
101                         <listitem><para><parameter moreinfo="none">ncacn_ip_tcp:samba.example.com[sign,seal,krb5]</parameter></para></listitem>
102                         <listitem><para><parameter moreinfo="none">ncacn_ip_tcp:samba.example.com[sign,spnego]</parameter></para></listitem>
103                         <listitem><para><parameter moreinfo="none">ncacn_np:samba.example.com</parameter></para></listitem>
104                         <listitem><para><parameter moreinfo="none">ncacn_np:samba.example.com[samr]</parameter></para></listitem>
105                         <listitem><para><parameter moreinfo="none">ncacn_np:samba.example.com[samr,sign,print]</parameter></para></listitem>
106                         <listitem><para><parameter moreinfo="none">ncalrpc:/path/to/unix/socket</parameter></para></listitem>
107                         <listitem><para><parameter moreinfo="none">//SAMBA</parameter></para></listitem>
108                         </itemizedlist>
110                         <para>The supported transports are:</para>
112                         <itemizedlist>
113                         <listitem><para><parameter moreinfo="none">ncacn_np</parameter> - Connect using named pipes</para></listitem>
114                         <listitem><para><parameter moreinfo="none">ncacn_ip_tcp</parameter> - Connect over TCP/IP</para></listitem>
115                         <listitem><para><parameter moreinfo="none">ncalrpc</parameter> - Connect over local RPC (unix sockets)</para></listitem>
116                         </itemizedlist>
118                         <para>The supported options are:</para>
120                         <itemizedlist>
121                         <listitem><para><parameter moreinfo="none">sign</parameter> - Use RPC integrity authentication level</para></listitem>
122                         <listitem><para><parameter moreinfo="none">seal</parameter> - Enable RPC privacy (encryption) authentication level</para></listitem>
123                         <listitem><para><parameter moreinfo="none">connect</parameter> - Use RPC connect level authentication (auth, but no sign or seal)</para></listitem>
124                         <listitem><para><parameter moreinfo="none">packet</parameter> - Use RPC packet authentication level</para></listitem>
126                         <listitem><para><parameter moreinfo="none">spnego</parameter> - Use SPNEGO instead of NTLMSSP authentication</para></listitem>
127                         <listitem><para><parameter moreinfo="none">ntlm</parameter> - Use plain NTLM instead of SPNEGO or NTLMSSP</para></listitem>
128                         <listitem><para><parameter moreinfo="none">krb5</parameter> - Use Kerberos instead of NTLMSSP authentication</para></listitem>
129                         <listitem><para><parameter moreinfo="none">schannel</parameter> - Create a schannel connection</para></listitem>
131                         <listitem><para><parameter moreinfo="none">smb1</parameter> - Use SMB1 for named pipes</para></listitem>
132                         <listitem><para><parameter moreinfo="none">smb2</parameter> - Use SMB2/3 for named pipes</para></listitem>
134                         <listitem><para><parameter moreinfo="none">validate</parameter> - Enable the NDR validator</para></listitem>
135                         <listitem><para><parameter moreinfo="none">print</parameter> - Enable debug output of packets</para></listitem>
136                         <listitem><para><parameter moreinfo="none">padcheck</parameter> - Check reply data for non-zero pad bytes</para></listitem>
137                         <listitem><para><parameter moreinfo="none">bigendian</parameter> - Use big endian for RPC</para></listitem>
138                         <listitem><para><parameter moreinfo="none">ndr64</parameter> - Use NDR64 for RPC</para></listitem>
139                         </itemizedlist>
141                 </listitem>
142                 </varlistentry>
145                 <varlistentry>
146                 <term>-c|--command=&lt;command string&gt;</term>
147                 <listitem><para>Execute semicolon separated commands (listed
148                 below) </para></listitem>
149                 </varlistentry>
152                 <varlistentry>
153                 <term>-I|--dest-ip IP-address</term>
154                 <listitem><para><replaceable>IP address</replaceable> is the address of the server to connect to.
155                 It should be specified in standard "a.b.c.d" notation. </para>
157                 <para>Normally the client would attempt to locate a named
158                 SMB/CIFS server by looking it up via the NetBIOS name resolution
159                 mechanism described above in the <parameter>name resolve order</parameter>
160                 parameter above. Using this parameter will force the client
161                 to assume that the server is on the machine with the specified IP
162                 address and the NetBIOS name component of the resource being
163                 connected to will be ignored. </para>
165                 <para>There is no default for this parameter. If not supplied,
166                 it will be determined automatically by the client as described
167                 above. </para></listitem>
168                 </varlistentry>
170                 <varlistentry>
171                 <term>-p|--port port</term>
172                 <listitem><para>This number is the TCP port number that will be used
173                 when making connections to the server. The standard (well-known)
174                 TCP port number for an SMB/CIFS server is 139, which is the
175                 default. </para></listitem>
176                 </varlistentry>
178                 &popt.autohelp;
179                 &cmdline.common.samba.client;
180                 &cmdline.common.connection;
181                 &cmdline.common.credentials;
182         </variablelist>
183 </refsect1>
186 <refsect1>
187         <title>COMMANDS</title>
189         <refsect2>
190         <title>LSARPC</title>
191         <variablelist>
192                 <varlistentry><term>lsaquery</term><listitem><para>Query info policy</para></listitem></varlistentry>
193                 <varlistentry><term>lookupsids</term><listitem><para>Convert SIDs to names</para></listitem></varlistentry>
194                 <varlistentry><term>lookupsids3</term><listitem><para>Convert SIDs to names</para></listitem></varlistentry>
195                 <varlistentry><term>lookupsids_level</term><listitem><para>Convert SIDs to names</para></listitem></varlistentry>
196                 <varlistentry><term>lookupnames</term><listitem><para>Convert names to SIDs</para></listitem></varlistentry>
197                 <varlistentry><term>lookupnames4</term><listitem><para>Convert names to SIDs</para></listitem></varlistentry>
198                 <varlistentry><term>lookupnames_level</term><listitem><para>Convert names to SIDs</para></listitem></varlistentry>
199                 <varlistentry><term>enumtrust</term><listitem><para>Enumerate trusted domains</para></listitem></varlistentry>
200                 <varlistentry><term>enumprivs</term><listitem><para>Enumerate privileges</para></listitem></varlistentry>
201                 <varlistentry><term>getdispname</term><listitem><para>Get the privilege name</para></listitem></varlistentry>
202                 <varlistentry><term>lsaenumsid</term><listitem><para>Enumerate the LSA SIDS</para></listitem></varlistentry>
203                 <varlistentry><term>lsacreateaccount</term><listitem><para>Create a new lsa account</para></listitem></varlistentry>
204                 <varlistentry><term>lsaenumprivsaccount</term><listitem><para>Enumerate the privileges of an SID</para></listitem></varlistentry>
205                 <varlistentry><term>lsaenumacctrights</term><listitem><para>Enumerate the rights of an SID</para></listitem></varlistentry>
206                 <varlistentry><term>lsaaddpriv</term><listitem><para>Assign a privilege to a SID</para></listitem></varlistentry>
207                 <varlistentry><term>lsadelpriv</term><listitem><para>Revoke a privilege from a SID</para></listitem></varlistentry>
208                 <varlistentry><term>lsaaddacctrights</term><listitem><para>Add rights to an account</para></listitem></varlistentry>
209                 <varlistentry><term>lsaremoveacctrights</term><listitem><para>Remove rights from an account</para></listitem></varlistentry>
210                 <varlistentry><term>lsalookupprivvalue</term><listitem><para>Get a privilege value given its name</para></listitem></varlistentry>
211                 <varlistentry><term>lsaquerysecobj</term><listitem><para>Query LSA security object</para></listitem></varlistentry>
212                 <varlistentry><term>lsaquerytrustdominfo</term><listitem><para>Query LSA trusted domains info (given a SID)</para></listitem></varlistentry>
213                 <varlistentry><term>lsaquerytrustdominfobyname</term><listitem><para>Query LSA trusted domains info (given a name), only works for Windows > 2k</para></listitem></varlistentry>
214                 <varlistentry><term>lsaquerytrustdominfobysid</term><listitem><para>Query LSA trusted domains info (given a SID)</para></listitem></varlistentry>
215                 <varlistentry><term>lsasettrustdominfo</term><listitem><para>Set LSA trusted domain info</para></listitem></varlistentry>
216                 <varlistentry><term>getusername</term><listitem><para>Get username</para></listitem></varlistentry>
217                 <varlistentry><term>createsecret</term><listitem><para>Create Secret</para></listitem></varlistentry>
218                 <varlistentry><term>deletesecret</term><listitem><para>Delete Secret</para></listitem></varlistentry>
219                 <varlistentry><term>querysecret</term><listitem><para>Query Secret</para></listitem></varlistentry>
220                 <varlistentry><term>setsecret</term><listitem><para>Set Secret</para></listitem></varlistentry>
221                 <varlistentry><term>retrieveprivatedata</term><listitem><para>Retrieve Private Data</para></listitem></varlistentry>
222                 <varlistentry><term>storeprivatedata</term><listitem><para>Store Private Data</para></listitem></varlistentry>
223                 <varlistentry><term>createtrustdom</term><listitem><para>Create Trusted Domain</para></listitem></varlistentry>
224                 <varlistentry><term>deletetrustdom</term><listitem><para>Delete Trusted Domain</para></listitem></varlistentry>
225         </variablelist>
226         </refsect2>
229         <refsect2>
230         <title>LSARPC-DS</title>
231         <variablelist>
232                 <varlistentry><term>dsroledominfo</term><listitem><para>Get Primary Domain Information</para></listitem></varlistentry>
233         </variablelist>
234         </refsect2>
237         <refsect2>
238         <title>DFS</title>
239         <variablelist>
240                 <varlistentry><term>dfsversion</term><listitem><para>Query DFS support</para></listitem></varlistentry>
241                 <varlistentry><term>dfsadd</term><listitem><para>Add a DFS share</para></listitem></varlistentry>
242                 <varlistentry><term>dfsremove</term><listitem><para>Remove a DFS share</para></listitem></varlistentry>
243                 <varlistentry><term>dfsgetinfo</term><listitem><para>Query DFS share info</para></listitem></varlistentry>
244                 <varlistentry><term>dfsenum</term><listitem><para>Enumerate dfs shares</para></listitem></varlistentry>
245                 <varlistentry><term>dfsenumex</term><listitem><para>Enumerate dfs shares</para></listitem></varlistentry>
246         </variablelist>
247         </refsect2>
250         <refsect2>
251         <title>SHUTDOWN</title>
252         <variablelist>
253                 <varlistentry><term>shutdowninit</term><listitem><para>syntax: shutdown [-m message] </para></listitem></varlistentry>
254                 <varlistentry><term>shutdownabort</term><listitem><para>syntax: shutdownabort</para></listitem></varlistentry>
255         </variablelist>
256         </refsect2>
259         <refsect2>
260         <title>SRVSVC</title>
261         <variablelist>
262                 <varlistentry><term>srvinfo</term><listitem><para>Server query info</para></listitem></varlistentry>
263                 <varlistentry><term>netshareenum</term><listitem><para>Enumerate shares</para></listitem></varlistentry>
264                 <varlistentry><term>netshareenumall</term><listitem><para>Enumerate all shares</para></listitem></varlistentry>
265                 <varlistentry><term>netsharegetinfo</term><listitem><para>Get Share Info</para></listitem></varlistentry>
266                 <varlistentry><term>netsharesetinfo</term><listitem><para>Set Share Info</para></listitem></varlistentry>
267                 <varlistentry><term>netsharesetdfsflags</term><listitem><para>Set DFS flags</para></listitem></varlistentry>
268                 <varlistentry><term>netfileenum</term><listitem><para>Enumerate open files</para></listitem></varlistentry>
269                 <varlistentry><term>netremotetod</term><listitem><para>Fetch remote time of day</para></listitem></varlistentry>
270                 <varlistentry><term>netnamevalidate</term><listitem><para>Validate sharename</para></listitem></varlistentry>
271                 <varlistentry><term>netfilegetsec</term><listitem><para>Get File security</para></listitem></varlistentry>
272                 <varlistentry><term>netsessdel</term><listitem><para>Delete Session</para></listitem></varlistentry>
273                 <varlistentry><term>netsessenum</term><listitem><para>Enumerate Sessions</para></listitem></varlistentry>
274                 <varlistentry><term>netdiskenum</term><listitem><para>Enumerate Disks</para></listitem></varlistentry>
275                 <varlistentry><term>netconnenum</term><listitem><para>Enumerate Connections</para></listitem></varlistentry>
276                 <varlistentry><term>netshareadd</term><listitem><para>Add share</para></listitem></varlistentry>
277                 <varlistentry><term>netsharedel</term><listitem><para>Delete share</para></listitem></varlistentry>
278         </variablelist>
279         </refsect2>
282         <refsect2>
283         <title>SAMR</title>
284         <variablelist>
285                 <varlistentry><term>queryuser</term><listitem><para>Query user info</para></listitem></varlistentry>
286                 <varlistentry><term>querygroup</term><listitem><para>Query group info</para></listitem></varlistentry>
287                 <varlistentry><term>queryusergroups</term><listitem><para>Query user groups</para></listitem></varlistentry>
288                 <varlistentry><term>queryuseraliases</term><listitem><para>Query user aliases</para></listitem></varlistentry>
289                 <varlistentry><term>querygroupmem</term><listitem><para>Query group membership</para></listitem></varlistentry>
290                 <varlistentry><term>queryaliasmem</term><listitem><para>Query alias membership</para></listitem></varlistentry>
291                 <varlistentry><term>queryaliasinfo</term><listitem><para>Query alias info</para></listitem></varlistentry>
292                 <varlistentry><term>deletealias</term><listitem><para>Delete an alias</para></listitem></varlistentry>
293                 <varlistentry><term>querydispinfo</term><listitem><para>Query display info</para></listitem></varlistentry>
294                 <varlistentry><term>querydispinfo2</term><listitem><para>Query display info</para></listitem></varlistentry>
295                 <varlistentry><term>querydispinfo3</term><listitem><para>Query display info</para></listitem></varlistentry>
296                 <varlistentry><term>querydominfo</term><listitem><para>Query domain info</para></listitem></varlistentry>
297                 <varlistentry><term>enumdomusers</term><listitem><para>Enumerate domain users</para></listitem></varlistentry>
298                 <varlistentry><term>enumdomgroups</term><listitem><para>Enumerate domain groups</para></listitem></varlistentry>
299                 <varlistentry><term>enumalsgroups</term><listitem><para>Enumerate alias groups</para></listitem></varlistentry>
300                 <varlistentry><term>enumdomains</term><listitem><para>Enumerate domains</para></listitem></varlistentry>
301                 <varlistentry><term>createdomuser</term><listitem><para>Create domain user</para></listitem></varlistentry>
302                 <varlistentry><term>createdomgroup</term><listitem><para>Create domain group</para></listitem></varlistentry>
303                 <varlistentry><term>createdomalias</term><listitem><para>Create domain alias</para></listitem></varlistentry>
304                 <varlistentry><term>samlookupnames</term><listitem><para>Look up names</para></listitem></varlistentry>
305                 <varlistentry><term>samlookuprids</term><listitem><para>Look up names</para></listitem></varlistentry>
306                 <varlistentry><term>deletedomgroup</term><listitem><para>Delete domain group</para></listitem></varlistentry>
307                 <varlistentry><term>deletedomuser</term><listitem><para>Delete domain user</para></listitem></varlistentry>
308                 <varlistentry><term>samquerysecobj</term><listitem><para>Query SAMR security object</para></listitem></varlistentry>
309                 <varlistentry><term>getdompwinfo</term><listitem><para>Retrieve domain password info</para></listitem></varlistentry>
310                 <varlistentry><term>getusrdompwinfo</term><listitem><para>Retrieve user domain password info</para></listitem></varlistentry>
311                 <varlistentry><term>lookupdomain</term><listitem><para>Lookup Domain Name</para></listitem></varlistentry>
312                 <varlistentry><term>chgpasswd</term><listitem><para>Change user password</para></listitem></varlistentry>
313                 <varlistentry><term>chgpasswd2</term><listitem><para>Change user password</para></listitem></varlistentry>
314                 <varlistentry><term>chgpasswd3</term><listitem><para>Change user password (RC4 encrypted)</para></listitem></varlistentry>
315                 <varlistentry><term>chgpasswd4</term><listitem><para>Change user password (AES encrypted)</para></listitem></varlistentry>
316                 <varlistentry><term>getdispinfoidx</term><listitem><para>Get Display Information Index</para></listitem></varlistentry>
317                 <varlistentry><term>setuserinfo</term><listitem><para>Set user info</para></listitem></varlistentry>
318                 <varlistentry><term>setuserinfo2</term><listitem><para>Set user info2</para></listitem></varlistentry>
319         </variablelist>
320         </refsect2>
323         <refsect2>
324         <title>SPOOLSS</title>
326         <variablelist>
327                 <varlistentry><term>adddriver &lt;arch&gt; &lt;config&gt; [&lt;version&gt;]</term>
328                 <listitem><para>
329                 Execute an AddPrinterDriver() RPC to install the printer driver
330                 information on the server.  Note that the driver files should
331                 already exist in the directory returned by
332                 <command>getdriverdir</command>.  Possible values for
333                 <parameter>arch</parameter> are the same as those for
334                 the <command>getdriverdir</command> command.
335                 The <parameter>config</parameter> parameter is defined as
336                 follows: </para>
338 <para><programlisting>
339 Long Driver Name:\
340 Driver File Name:\
341 Data File Name:\
342 Config File Name:\
343 Help File Name:\
344 Language Monitor Name:\
345 Default Data Type:\
346 Comma Separated list of Files
347 </programlisting></para>
349                 <para>Any empty fields should be enter as the string "NULL". </para>
351                 <para>Samba does not need to support the concept of Print Monitors
352                 since these only apply to local printers whose driver can make
353                 use of a bi-directional link for communication.  This field should
354                 be "NULL".   On a remote NT print server, the Print Monitor for a
355                 driver must already be installed prior to adding the driver or
356                 else the RPC will fail. </para>
358                 <para>The <parameter>version</parameter> parameter lets you
359                 specify the printer driver version number.  If omitted, the
360                 default driver version for the specified architecture will
361                 be used.  This option can be used to upload Windows 2000
362                 (version 3) printer drivers.</para></listitem></varlistentry>
364                 <varlistentry><term>addprinter &lt;printername&gt;
365                 &lt;sharename&gt; &lt;drivername&gt; &lt;port&gt;</term>
366                 <listitem><para>
367                 Add a printer on the remote server.  This printer
368                 will be automatically shared.  Be aware that the printer driver
369                 must already be installed on the server (see <command>adddriver</command>)
370                 and the <parameter>port</parameter>must be a valid port name (see
371                 <command>enumports</command>.</para>
372                 </listitem></varlistentry>
374                 <varlistentry><term>deldriver &lt;driver&gt;</term><listitem><para>Delete the
375                 specified printer driver for all architectures.  This
376                 does not delete the actual driver files from the server,
377                 only the entry from the server's list of drivers.
378                 </para></listitem></varlistentry>
380                 <varlistentry><term>deldriverex &lt;driver&gt; [architecture] [version] [flags]
381                 </term><listitem><para>Delete the specified printer driver and optionally files
382                 associated with the driver.
383                 You can limit this action to a specific architecture and a specific version.
384                 If no architecture is given, all driver files of that driver will be deleted.
385                 <parameter>flags</parameter> correspond to numeric DPD_* values, i.e. a value
386                 of 3 requests (DPD_DELETE_UNUSED_FILES | DPD_DELETE_SPECIFIC_VERSION).
387                 </para></listitem></varlistentry>
389                 <varlistentry><term>enumdata</term><listitem><para>Enumerate all
390                 printer setting data stored on the server. On Windows NT  clients,
391                 these values are stored  in the registry, while Samba servers
392                 store them in the printers TDB.  This command corresponds
393                 to the MS Platform SDK GetPrinterData() function (* This
394                 command is currently unimplemented).</para></listitem></varlistentry>
396                 <varlistentry><term>enumdataex</term><listitem><para>Enumerate printer data for a key</para></listitem></varlistentry>
398                 <varlistentry><term>enumkey</term><listitem><para>Enumerate printer keys</para></listitem></varlistentry>
400                 <varlistentry><term>enumjobs &lt;printer&gt;</term>
401                 <listitem><para>List the jobs and status of a given printer.
402                 This command corresponds to the MS Platform SDK EnumJobs()
403                 function</para></listitem></varlistentry>
405                 <varlistentry><term>getjob</term><listitem><para>Get print job</para></listitem></varlistentry>
406                 <varlistentry><term>setjob</term><listitem><para>Set print job</para></listitem></varlistentry>
409                 <varlistentry><term>enumports [level]</term>
410                 <listitem><para>
411                 Executes an EnumPorts() call using the specified
412                 info level. Currently only info levels 1 and 2 are supported.
413                 </para></listitem></varlistentry>
415                 <varlistentry><term>enumdrivers [level]</term>
416                 <listitem><para>
417                 Execute an EnumPrinterDrivers() call.  This lists the various installed
418                 printer drivers for all architectures.  Refer to the MS Platform SDK
419                 documentation for more details of the various flags and calling
420                 options. Currently supported info levels are 1, 2, and 3.</para></listitem></varlistentry>
422                 <varlistentry><term>enumprinters [level]</term>
423                 <listitem><para>Execute an EnumPrinters() call.  This lists the various installed
424                 and share printers.  Refer to the MS Platform SDK documentation for
425                 more details of the various flags and calling options. Currently
426                 supported info levels are 1, 2 and 5.</para></listitem></varlistentry>
428                 <varlistentry><term>getdata &lt;printername&gt; &lt;valuename;&gt;</term>
429                 <listitem><para>Retrieve the data for a given printer setting.  See
430                 the  <command>enumdata</command> command for more information.
431                 This command corresponds to the GetPrinterData() MS Platform
432                 SDK function. </para></listitem></varlistentry>
434                 <varlistentry><term>getdataex</term><listitem><para>Get
435                 printer driver data with
436                 keyname</para></listitem></varlistentry>
439                 <varlistentry><term>getdriver &lt;printername&gt;</term>
440                 <listitem><para>
441                 Retrieve the printer driver information (such as driver file,
442                 config file, dependent files, etc...) for
443                 the given printer. This command corresponds to the GetPrinterDriver()
444                 MS Platform  SDK function. Currently info level 1, 2, and 3 are supported.
445                 </para></listitem></varlistentry>
447                 <varlistentry><term>getdriverdir &lt;arch&gt;</term>
448                 <listitem><para>
449                 Execute a GetPrinterDriverDirectory()
450                 RPC to retrieve the SMB share name and subdirectory for
451                 storing printer driver files for a given architecture.  Possible
452                 values for <parameter>arch</parameter> are "Windows 4.0"
453                 (for Windows 95/98), "Windows NT x86", "Windows NT PowerPC", "Windows
454                 Alpha_AXP", and "Windows NT R4000". </para></listitem></varlistentry>
456                 <varlistentry><term>getdriverpackagepath</term>
457                 <listitem><para>Get print driver package download directory</para></listitem></varlistentry>
459                 <varlistentry><term>getprinter &lt;printername&gt;</term>
460                 <listitem><para>Retrieve the current printer information.  This command
461                 corresponds to the GetPrinter() MS Platform SDK function.
462                 </para></listitem></varlistentry>
465                 <varlistentry><term>openprinter &lt;printername&gt;</term>
466                 <listitem><para>Execute an OpenPrinterEx() and ClosePrinter() RPC
467                 against a given printer. </para></listitem></varlistentry>
469                 <varlistentry><term>openprinter_ex &lt;printername&gt;</term>
470                 <listitem><para>Open printer handle</para></listitem></varlistentry>
472                 <varlistentry><term>setdriver &lt;printername&gt;
473                 &lt;drivername&gt;</term>
474                 <listitem><para>Execute a SetPrinter() command to update the printer driver
475                 associated with an installed printer.  The printer driver must
476                 already be correctly installed on the print server.  </para>
478                 <para>See also the <command>enumprinters</command> and
479                 <command>enumdrivers</command> commands for obtaining a list of
480                 of installed printers and drivers.</para></listitem></varlistentry>
482                 <varlistentry><term>getprintprocdir</term><listitem>
483                 <para>Get print processor directory</para></listitem></varlistentry>
485                 <varlistentry><term>addform</term><listitem><para>Add form</para></listitem></varlistentry>
486                 <varlistentry><term>setform</term><listitem><para>Set form</para></listitem></varlistentry>
487                 <varlistentry><term>getform</term><listitem><para>Get form</para></listitem></varlistentry>
488                 <varlistentry><term>deleteform</term><listitem><para>Delete form</para></listitem></varlistentry>
489                 <varlistentry><term>enumforms</term><listitem><para>Enumerate form</para></listitem></varlistentry>
490                 <varlistentry><term>setprinter</term><listitem><para>Set printer comment</para></listitem></varlistentry>
491                 <varlistentry><term>setprinterdata</term><listitem><para>Set REG_SZ printer data</para></listitem></varlistentry>
493                 <varlistentry><term>setprintername &lt;printername&gt; &lt;newprintername&gt;</term>
494                 <listitem><para>Set printer name</para></listitem></varlistentry>
496                 <varlistentry><term>rffpcnex</term><listitem><para>Rffpcnex test</para></listitem></varlistentry>
497                 <varlistentry><term>printercmp</term><listitem><para>Printer comparison test</para></listitem></varlistentry>
498                 <varlistentry><term>enumprocs</term><listitem><para>Enumerate Print Processors</para></listitem></varlistentry>
499                 <varlistentry><term>enumprocdatatypes</term><listitem><para>Enumerate Print Processor Data Types</para></listitem></varlistentry>
500                 <varlistentry><term>enummonitors</term><listitem><para>Enumerate Print Monitors</para></listitem></varlistentry>
501                 <varlistentry><term>createprinteric</term><listitem><para>Create Printer IC</para></listitem></varlistentry>
502                 <varlistentry><term>playgdiscriptonprinteric</term><listitem><para>Create Printer IC</para></listitem></varlistentry>
503                 <varlistentry><term>getcoreprinterdrivers</term><listitem><para>Get CorePrinterDriver</para></listitem></varlistentry>
504                 <varlistentry><term>enumpermachineconnections</term><listitem><para>Enumerate Per Machine Connections</para></listitem></varlistentry>
505                 <varlistentry><term>addpermachineconnection</term><listitem><para>Add Per Machine Connection</para></listitem></varlistentry>
506                 <varlistentry><term>delpermachineconnection</term><listitem><para>Delete Per Machine Connection</para></listitem></varlistentry>
507         </variablelist>
508         </refsect2>
511         <refsect2>
512         <title>NETLOGON</title>
513         <variablelist>
514                 <varlistentry><term>logonctrl2</term><listitem><para>Logon Control 2</para></listitem></varlistentry>
515                 <varlistentry><term>getanydcname</term><listitem><para>Get trusted DC name</para></listitem></varlistentry>
516                 <varlistentry><term>getdcname</term><listitem><para>Get trusted PDC name</para></listitem></varlistentry>
517                 <varlistentry><term>dsr_getdcname</term><listitem><para>Get trusted DC name</para></listitem></varlistentry>
518                 <varlistentry><term>dsr_getdcnameex</term><listitem><para>Get trusted DC name</para></listitem></varlistentry>
519                 <varlistentry><term>dsr_getdcnameex2</term><listitem><para>Get trusted DC name</para></listitem></varlistentry>
520                 <varlistentry><term>dsr_getsitename</term><listitem><para>Get sitename</para></listitem></varlistentry>
521                 <varlistentry><term>dsr_getforesttrustinfo</term><listitem><para>Get Forest Trust Info</para></listitem></varlistentry>
522                 <varlistentry><term>logonctrl</term><listitem><para>Logon Control</para></listitem></varlistentry>
523                 <varlistentry><term>samlogon</term><listitem><para>Sam Logon</para></listitem></varlistentry>
524                 <varlistentry><term>change_trust_pw</term><listitem><para>Change Trust Account Password</para></listitem></varlistentry>
525                 <varlistentry><term>gettrustrid</term><listitem><para>Get trust rid</para></listitem></varlistentry>
526                 <varlistentry><term>dsr_enumtrustdom</term><listitem><para>Enumerate trusted domains</para></listitem></varlistentry>
527                 <varlistentry><term>dsenumdomtrusts</term><listitem><para>Enumerate all trusted domains in an AD forest</para></listitem></varlistentry>
528                 <varlistentry><term>deregisterdnsrecords</term><listitem><para>Deregister DNS records</para></listitem></varlistentry>
529                 <varlistentry><term>netrenumtrusteddomains</term><listitem><para>Enumerate trusted domains</para></listitem></varlistentry>
530                 <varlistentry><term>netrenumtrusteddomainsex</term><listitem><para>Enumerate trusted domains</para></listitem></varlistentry>
531                 <varlistentry><term>getdcsitecoverage</term><listitem><para>Get the Site-Coverage from a DC</para></listitem></varlistentry>
532                 <varlistentry><term>capabilities</term><listitem><para>Return Capabilities</para></listitem></varlistentry>
533                 <varlistentry><term>logongetdomaininfo</term><listitem><para>Return LogonGetDomainInfo</para></listitem></varlistentry>
534         </variablelist>
535         </refsect2>
538         <refsect2>
539         <title>FSRVP</title>
540         <variablelist>
541                 <varlistentry><term>fss_is_path_sup</term><listitem><para>Check whether a share supports shadow-copy </para></listitem></varlistentry>
542                 <varlistentry><term>fss_get_sup_version</term><listitem><para>Get supported FSRVP version from server</para></listitem></varlistentry>
543                 <varlistentry><term>fss_create_expose</term><listitem><para>Request shadow-copy creation and exposure</para></listitem></varlistentry>
544                 <varlistentry><term>fss_delete</term><listitem><para>Request shadow-copy share deletion</para></listitem></varlistentry>
545                 <varlistentry><term>fss_has_shadow_copy</term><listitem><para>Check for an associated share shadow-copy</para></listitem></varlistentry>
546                 <varlistentry><term>fss_get_mapping</term><listitem><para>Get shadow-copy share mapping information</para></listitem></varlistentry>
547                 <varlistentry><term>fss_recovery_complete</term><listitem><para>Flag read-write snapshot as recovery complete, </para></listitem></varlistentry>
548         </variablelist>
549         </refsect2>
552         <refsect2>
553         <title>CLUSAPI</title>
554         <variablelist>
555                 <varlistentry><term>clusapi_open_cluster</term><listitem><para>Open cluster</para></listitem></varlistentry>
556                 <varlistentry><term>clusapi_get_cluster_name</term><listitem><para>Get cluster name</para></listitem></varlistentry>
557                 <varlistentry><term>clusapi_get_cluster_version</term><listitem><para>Get cluster version</para></listitem></varlistentry>
558                 <varlistentry><term>clusapi_get_quorum_resource</term><listitem><para>Get quorum resource</para></listitem></varlistentry>
559                 <varlistentry><term>clusapi_create_enum</term><listitem><para>Create enum query</para></listitem></varlistentry>
560                 <varlistentry><term>clusapi_create_enumex</term><listitem><para>Create enumex query</para></listitem></varlistentry>
561                 <varlistentry><term>clusapi_open_resource</term><listitem><para>Open cluster resource</para></listitem></varlistentry>
562                 <varlistentry><term>clusapi_online_resource</term><listitem><para>Set cluster resource online</para></listitem></varlistentry>
563                 <varlistentry><term>clusapi_offline_resource</term><listitem><para>Set cluster resource offline</para></listitem></varlistentry>
564                 <varlistentry><term>clusapi_get_resource_state</term><listitem><para>Get cluster resource state</para></listitem></varlistentry>
565                 <varlistentry><term>clusapi_get_cluster_version2</term><listitem><para>Get cluster version2</para></listitem></varlistentry>
566                 <varlistentry><term>clusapi_pause_node</term><listitem><para>Pause cluster node</para></listitem></varlistentry>
567                 <varlistentry><term>clusapi_resume_node</term><listitem><para>Resume cluster node</para></listitem></varlistentry>
568         </variablelist>
569         </refsect2>
572         <refsect2>
573         <title>DRSUAPI</title>
574         <variablelist>
575                 <varlistentry><term>dscracknames</term><listitem><para>Crack Name</para></listitem></varlistentry>
576                 <varlistentry><term>dsgetdcinfo</term><listitem><para>Get Domain Controller Info</para></listitem></varlistentry>
577                 <varlistentry><term>dsgetncchanges</term><listitem><para>Get NC Changes</para></listitem></varlistentry>
578                 <varlistentry><term>dswriteaccountspn</term><listitem><para>Write Account SPN</para></listitem></varlistentry>
579         </variablelist>
580         </refsect2>
583         <refsect2>
584         <title>ECHO</title>
585         <variablelist>
586                 <varlistentry><term>echoaddone</term><listitem><para>Add one to a number</para></listitem></varlistentry>
587                 <varlistentry><term>echodata</term><listitem><para>Echo data</para></listitem></varlistentry>
588                 <varlistentry><term>sinkdata</term><listitem><para>Sink data</para></listitem></varlistentry>
589                 <varlistentry><term>sourcedata</term><listitem><para>Source data</para></listitem></varlistentry>
590         </variablelist>
591         </refsect2>
594         <refsect2>
595         <title>EPMAPPER</title>
596         <variablelist>
597                 <varlistentry><term>epmmap</term><listitem><para>Map a binding</para></listitem></varlistentry>
598                 <varlistentry><term>epmlookup</term><listitem><para>Lookup bindings</para></listitem></varlistentry>
599         </variablelist>
600         </refsect2>
603         <refsect2>
604         <title>EVENTLOG</title>
605         <variablelist>
606                 <varlistentry><term>eventlog_readlog</term><listitem><para>Read Eventlog</para></listitem></varlistentry>
607                 <varlistentry><term>eventlog_numrecord</term><listitem><para>Get number of records</para></listitem></varlistentry>
608                 <varlistentry><term>eventlog_oldestrecord</term><listitem><para>Get oldest record</para></listitem></varlistentry>
609                 <varlistentry><term>eventlog_reportevent</term><listitem><para>Report event</para></listitem></varlistentry>
610                 <varlistentry><term>eventlog_reporteventsource</term><listitem><para>Report event and source</para></listitem></varlistentry>
611                 <varlistentry><term>eventlog_registerevsource</term><listitem><para>Register event source</para></listitem></varlistentry>
612                 <varlistentry><term>eventlog_backuplog</term><listitem><para>Backup Eventlog File</para></listitem></varlistentry>
613                 <varlistentry><term>eventlog_loginfo</term><listitem><para>Get Eventlog Information</para></listitem></varlistentry>
614         </variablelist>
615         </refsect2>
618         <refsect2>
619         <title>IRemoteWinspool</title>
620         <variablelist>
621                 <varlistentry><term>winspool_AsyncOpenPrinter</term><listitem><para>Open printer handle</para></listitem></varlistentry>
622                 <varlistentry><term>winspool_AsyncCorePrinterDriverInstalled</term><listitem><para>Query Core Printer Driver Installed</para></listitem></varlistentry>
623         </variablelist>
624         </refsect2>
627         <refsect2>
628         <title>NTSVCS</title>
629         <variablelist>
630                 <varlistentry><term>ntsvcs_getversion</term><listitem><para>Query NTSVCS version</para></listitem></varlistentry>
631                 <varlistentry><term>ntsvcs_validatedevinst</term><listitem><para>Query NTSVCS device instance</para></listitem></varlistentry>
632                 <varlistentry><term>ntsvcs_hwprofflags</term><listitem><para>Query NTSVCS HW prof flags</para></listitem></varlistentry>
633                 <varlistentry><term>ntsvcs_hwprofinfo</term><listitem><para>Query NTSVCS HW prof info</para></listitem></varlistentry>
634                 <varlistentry><term>ntsvcs_getdevregprop</term><listitem><para>Query NTSVCS device registry property</para></listitem></varlistentry>
635                 <varlistentry><term>ntsvcs_getdevlistsize</term><listitem><para>Query NTSVCS device list size</para></listitem></varlistentry>
636                 <varlistentry><term>ntsvcs_getdevlist</term><listitem><para>Query NTSVCS device list</para></listitem></varlistentry>
637         </variablelist>
638         </refsect2>
641         <refsect2>
642         <title>MDSSVC</title>
643         <variablelist>
644                 <varlistentry><term>fetch_properties</term><listitem><para>Fetch connection properties</para></listitem></varlistentry>
645                 <varlistentry><term>fetch_attributes</term><listitem><para>Fetch attributes for a CNID</para></listitem></varlistentry>
646         </variablelist>
647         </refsect2>
650         <refsect2>
651         <title>WINREG</title>
652         <variablelist>
653                 <varlistentry><term>winreg_enumkey</term><listitem><para>Enumerate Keys</para></listitem></varlistentry>
654                 <varlistentry><term>querymultiplevalues</term><listitem><para>Query multiple values</para></listitem></varlistentry>
655                 <varlistentry><term>querymultiplevalues2</term><listitem><para>Query multiple values</para></listitem></varlistentry>
656         </variablelist>
657         </refsect2>
660         <refsect2>
661         <title>WITNESS</title>
662         <variablelist>
663                 <varlistentry><term>GetInterfaceList</term><listitem><para>List the interfaces to which witness client connections can be made</para></listitem></varlistentry>
664                 <varlistentry><term>Register</term><listitem><para>Register for resource state change notifications of a NetName and IPAddress</para></listitem></varlistentry>
665                 <varlistentry><term>UnRegister</term><listitem><para>Unregister for notifications from the server</para></listitem></varlistentry>
666                 <varlistentry><term>AsyncNotify</term><listitem><para>Request notification of registered resource changes from the server</para></listitem></varlistentry>
667                 <varlistentry><term>RegisterEx</term><listitem><para>Register for resource state change notifications of a NetName, ShareName and multiple IPAddresses</para></listitem></varlistentry>
668         </variablelist>
669         </refsect2>
672         <refsect2>
673         <title>WKSSVC</title>
674         <variablelist>
675                 <varlistentry><term>wkssvc_wkstagetinfo</term><listitem><para>Query WKSSVC Workstation Information</para></listitem></varlistentry>
676                 <varlistentry><term>wkssvc_getjoininformation</term><listitem><para>Query WKSSVC Join Information</para></listitem></varlistentry>
677                 <varlistentry><term>wkssvc_messagebuffersend</term><listitem><para>Send WKSSVC message</para></listitem></varlistentry>
678                 <varlistentry><term>wkssvc_enumeratecomputernames</term><listitem><para>Enumerate WKSSVC computer names</para></listitem></varlistentry>
679                 <varlistentry><term>wkssvc_enumerateusers</term><listitem><para>Enumerate WKSSVC users</para></listitem></varlistentry>
680         </variablelist>
681         </refsect2>
684         <refsect2>
685         <title>GENERAL OPTIONS</title>
686         <variablelist>
687                 <varlistentry><term>help</term><listitem><para>Get help on commands</para></listitem></varlistentry>
688                 <varlistentry><term>?</term><listitem><para>Get help on commands</para></listitem></varlistentry>
689                 <varlistentry><term>debuglevel</term><listitem><para>Set debug level</para></listitem></varlistentry>
690                 <varlistentry><term>debug</term><listitem><para>Set debug level</para></listitem></varlistentry>
691                 <varlistentry><term>list</term><listitem><para>List available commands on pipe</para></listitem></varlistentry>
692                 <varlistentry><term>exit</term><listitem><para>Exit program</para></listitem></varlistentry>
693                 <varlistentry><term>quit</term><listitem><para>Exit program</para></listitem></varlistentry>
694                 <varlistentry><term>sign</term><listitem><para>Force RPC pipe connections to be signed</para></listitem></varlistentry>
695                 <varlistentry><term>seal</term><listitem><para>Force RPC pipe connections to be sealed</para></listitem></varlistentry>
696                 <varlistentry><term>packet</term><listitem><para>Force RPC pipe connections with packet authentication level</para></listitem></varlistentry>
697                 <varlistentry><term>schannel</term><listitem><para>Force RPC pipe connections to be sealed with 'schannel'. Force RPC pipe connections to be sealed with 'schannel'. Assumes valid machine account to this domain controller.</para></listitem></varlistentry>
698                 <varlistentry><term>schannelsign</term><listitem><para>Force RPC pipe connections to be signed (not sealed) with 'schannel'. Assumes valid machine account to this domain controller.</para></listitem></varlistentry>
699                 <varlistentry><term>timeout</term><listitem><para>Set timeout (in milliseconds) for RPC operations</para></listitem></varlistentry>
700                 <varlistentry><term>transport</term><listitem><para>Choose ncacn transport for RPC operations</para></listitem></varlistentry>
701                 <varlistentry><term>none</term><listitem><para>Force RPC pipe connections to have no special properties</para></listitem></varlistentry>
702         </variablelist>
703         </refsect2>
705 </refsect1>
707 <refsect1>
708         <title>BUGS</title>
710         <para><command>rpcclient</command> is designed as a developer testing tool
711         and may not be robust in certain areas (such as command line parsing).
712         It has been known to  generate a core dump upon failures when invalid
713         parameters where passed to the interpreter. </para>
715         <para>From Luke Leighton's original rpcclient man page:</para>
717         <para><emphasis>WARNING!</emphasis> The MSRPC over SMB code has
718         been developed from examining  Network traces. No documentation is
719         available from the original creators  (Microsoft) on how MSRPC over
720         SMB works, or how the individual MSRPC services  work. Microsoft's
721         implementation of these services has been demonstrated  (and reported)
722         to be... a bit flaky in places. </para>
724         <para>The development of Samba's implementation is also a bit rough,
725         and as more of the services are understood, it can even result in
726         versions of <citerefentry><refentrytitle>smbd</refentrytitle>
727         <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>rpcclient</refentrytitle>
728         <manvolnum>1</manvolnum></citerefentry> that are incompatible for some commands or  services. Additionally,
729         the developers are sending reports to Microsoft,  and problems found
730         or reported to Microsoft are fixed in Service Packs,  which may
731         result in incompatibilities.</para>
732 </refsect1>
735 <refsect1>
736         <title>VERSION</title>
738         <para>This man page is part of version &doc.version; of the Samba
739         suite.</para>
740 </refsect1>
742 <refsect1>
743         <title>AUTHOR</title>
745         <para>The original Samba software and related utilities
746         were created by Andrew Tridgell. Samba is now developed
747         by the Samba Team as an Open Source project similar
748         to the way the Linux kernel is developed.</para>
750         <para>The original rpcclient man page was written by Matthew
751         Geddes, Luke Kenneth Casson Leighton, and rewritten by Gerald Carter.
752         The conversion to DocBook for Samba 2.2 was done by Gerald
753         Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was
754         done by Alexander Bokovoy.</para>
755 </refsect1>
757 </refentry>