summaryrefslogtreecommitdiffstats
path: root/docs-xml/manpages/rpcclient.1.xml
blob: 164a2dbc0bddf2f2d352ba3ba3e5c0c9ac59f567 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
<refentry id="rpcclient.1">

<refmeta>
	<refentrytitle>rpcclient</refentrytitle>
	<manvolnum>1</manvolnum>
	<refmiscinfo class="source">Samba</refmiscinfo>
	<refmiscinfo class="manual">User Commands</refmiscinfo>
	<refmiscinfo class="version">&doc.version;</refmiscinfo>
</refmeta>


<refnamediv>
	<refname>rpcclient</refname>
	<refpurpose>tool for executing client side
	MS-RPC functions</refpurpose>
</refnamediv>

<refsynopsisdiv>
	<cmdsynopsis>
		<command>rpcclient</command>
		<arg choice="opt">-c|--command=COMMANDS</arg>
		<arg choice="opt">-I|--dest-ip=IP</arg>
		<arg choice="opt">-p|--port=PORT</arg>
		<arg choice="opt">-?|--help</arg>
		<arg choice="opt">--usage</arg>
		<arg choice="opt">-d|--debuglevel=DEBUGLEVEL</arg>
		<arg choice="opt">--debug-stdout</arg>
		<arg choice="opt">--configfile=CONFIGFILE</arg>
		<arg choice="opt">--option=name=value</arg>
		<arg choice="opt">-l|--log-basename=LOGFILEBASE</arg>
		<arg choice="opt">--leak-report</arg>
		<arg choice="opt">--leak-report-full</arg>
		<arg choice="opt">-R|--name-resolve=NAME-RESOLVE-ORDER</arg>
		<arg choice="opt">-O|--socket-options=SOCKETOPTIONS</arg>
		<arg choice="opt">-m|--max-protocol=MAXPROTOCOL</arg>
		<arg choice="opt">-n|--netbiosname=NETBIOSNAME</arg>
		<arg choice="opt">--netbios-scope=SCOPE</arg>
		<arg choice="opt">-W|--workgroup=WORKGROUP</arg>
		<arg choice="opt">--realm=REALM</arg>
		<arg choice="opt">-U|--user=[DOMAIN/]USERNAME[%PASSWORD]</arg>
		<arg choice="opt">-N|--no-pass</arg>
		<arg choice="opt">--password=STRING</arg>
		<arg choice="opt">--pw-nt-hash</arg>
		<arg choice="opt">-A|--authentication-file=FILE</arg>
		<arg choice="opt">-P|--machine-pass</arg>
		<arg choice="opt">--simple-bind-dn=DN</arg>
		<arg choice="opt">--use-kerberos=desired|required|off</arg>
		<arg choice="opt">--use-krb5-ccache=CCACHE</arg>
		<arg choice="opt">--use-winbind-ccache</arg>
		<arg choice="opt">--client-protection=sign|encrypt|off</arg>
		<arg choice="opt">-V|--version</arg>
		<arg choice="req">BINDING-STRING|HOST</arg>
	</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
	<title>DESCRIPTION</title>

	<para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
	<manvolnum>7</manvolnum></citerefentry> suite.</para>

	<para><command>rpcclient</command> is a utility initially developed
	to test MS-RPC functionality in Samba itself.  It has undergone
	several stages of development and stability.  Many system administrators
	have now written scripts around it to manage Windows NT clients from
	their UNIX workstation. </para>
</refsect1>


<refsect1>
	<title>OPTIONS</title>

	<variablelist>
		<varlistentry>
		<term>BINDING-STRING|HOST</term>
		<listitem>
			<para>When connecting to a dcerpc service you need to
			specify a binding string.</para>

			<para>The format is:</para>

			<para>TRANSPORT:host[options]</para>

			<para>where TRANSPORT is either ncacn_np (named pipes) for SMB or
			ncacn_ip_tcp for DCERPC over TCP/IP.</para>

			<para>"host" is an IP or hostname or netbios name. If the binding
			string identifies the server side of an endpoint, "host" may be
			an empty string. See below for more details.</para>

			<para>"options" can include a SMB pipe name if using the ncacn_np
			transport or a TCP port number if using the ncacn_ip_tcp transport,
			otherwise they will be auto-determined.</para>

			<para>Examples:</para>

			<itemizedlist>
			<listitem><para><parameter moreinfo="none">ncacn_ip_tcp:samba.example.com[1024]</parameter></para></listitem>
			<listitem><para><parameter moreinfo="none">ncacn_ip_tcp:samba.example.com[sign,seal,krb5]</parameter></para></listitem>
			<listitem><para><parameter moreinfo="none">ncacn_ip_tcp:samba.example.com[sign,spnego]</parameter></para></listitem>
			<listitem><para><parameter moreinfo="none">ncacn_np:samba.example.com</parameter></para></listitem>
			<listitem><para><parameter moreinfo="none">ncacn_np:samba.example.com[samr]</parameter></para></listitem>
			<listitem><para><parameter moreinfo="none">ncacn_np:samba.example.com[samr,sign,print]</parameter></para></listitem>
			<listitem><para><parameter moreinfo="none">ncalrpc:/path/to/unix/socket</parameter></para></listitem>
			<listitem><para><parameter moreinfo="none">//SAMBA</parameter></para></listitem>
			</itemizedlist>

			<para>The supported transports are:</para>

			<itemizedlist>
			<listitem><para><parameter moreinfo="none">ncacn_np</parameter> - Connect using named pipes</para></listitem>
			<listitem><para><parameter moreinfo="none">ncacn_ip_tcp</parameter> - Connect over TCP/IP</para></listitem>
			<listitem><para><parameter moreinfo="none">ncalrpc</parameter> - Connect over local RPC (unix sockets)</para></listitem>
			</itemizedlist>

			<para>The supported options are:</para>

			<itemizedlist>
			<listitem><para><parameter moreinfo="none">sign</parameter> - Use RPC integrity authentication level</para></listitem>
			<listitem><para><parameter moreinfo="none">seal</parameter> - Enable RPC privacy (encryption) authentication level</para></listitem>
			<listitem><para><parameter moreinfo="none">connect</parameter> - Use RPC connect level authentication (auth, but no sign or seal)</para></listitem>
			<listitem><para><parameter moreinfo="none">packet</parameter> - Use RPC packet authentication level</para></listitem>

			<listitem><para><parameter moreinfo="none">spnego</parameter> - Use SPNEGO instead of NTLMSSP authentication</para></listitem>
			<listitem><para><parameter moreinfo="none">ntlm</parameter> - Use plain NTLM instead of SPNEGO or NTLMSSP</para></listitem>
			<listitem><para><parameter moreinfo="none">krb5</parameter> - Use Kerberos instead of NTLMSSP authentication</para></listitem>
			<listitem><para><parameter moreinfo="none">schannel</parameter> - Create a schannel connection</para></listitem>

			<listitem><para><parameter moreinfo="none">smb1</parameter> - Use SMB1 for named pipes</para></listitem>
			<listitem><para><parameter moreinfo="none">smb2</parameter> - Use SMB2/3 for named pipes</para></listitem>

			<listitem><para><parameter moreinfo="none">validate</parameter> - Enable the NDR validator</para></listitem>
			<listitem><para><parameter moreinfo="none">print</parameter> - Enable debug output of packets</para></listitem>
			<listitem><para><parameter moreinfo="none">padcheck</parameter> - Check reply data for non-zero pad bytes</para></listitem>
			<listitem><para><parameter moreinfo="none">bigendian</parameter> - Use big endian for RPC</para></listitem>
			<listitem><para><parameter moreinfo="none">ndr64</parameter> - Use NDR64 for RPC</para></listitem>
			</itemizedlist>

		</listitem>
		</varlistentry>


		<varlistentry>
		<term>-c|--command=&lt;command string&gt;</term>
		<listitem><para>Execute semicolon separated commands (listed
		below) </para></listitem>
		</varlistentry>


		<varlistentry>
		<term>-I|--dest-ip IP-address</term>
		<listitem><para><replaceable>IP address</replaceable> is the address of the server to connect to.
		It should be specified in standard "a.b.c.d" notation. </para>

		<para>Normally the client would attempt to locate a named
		SMB/CIFS server by looking it up via the NetBIOS name resolution
		mechanism described above in the <parameter>name resolve order</parameter>
		parameter above. Using this parameter will force the client
		to assume that the server is on the machine with the specified IP
		address and the NetBIOS name component of the resource being
		connected to will be ignored. </para>

		<para>There is no default for this parameter. If not supplied,
		it will be determined automatically by the client as described
		above. </para></listitem>
		</varlistentry>

		<varlistentry>
		<term>-p|--port port</term>
		<listitem><para>This number is the TCP port number that will be used
		when making connections to the server. The standard (well-known)
		TCP port number for an SMB/CIFS server is 139, which is the
		default. </para></listitem>
		</varlistentry>

		&popt.autohelp;
		&cmdline.common.samba.client;
		&cmdline.common.connection;
		&cmdline.common.credentials;
	</variablelist>
</refsect1>


<refsect1>
	<title>COMMANDS</title>

	<refsect2>
	<title>LSARPC</title>
	<variablelist>
		<varlistentry><term>lsaquery</term><listitem><para>Query info policy</para></listitem></varlistentry>
		<varlistentry><term>lookupsids</term><listitem><para>Convert SIDs to names</para></listitem></varlistentry>
		<varlistentry><term>lookupsids3</term><listitem><para>Convert SIDs to names</para></listitem></varlistentry>
		<varlistentry><term>lookupsids_level</term><listitem><para>Convert SIDs to names</para></listitem></varlistentry>
		<varlistentry><term>lookupnames</term><listitem><para>Convert names to SIDs</para></listitem></varlistentry>
		<varlistentry><term>lookupnames4</term><listitem><para>Convert names to SIDs</para></listitem></varlistentry>
		<varlistentry><term>lookupnames_level</term><listitem><para>Convert names to SIDs</para></listitem></varlistentry>
		<varlistentry><term>enumtrust</term><listitem><para>Enumerate trusted domains</para></listitem></varlistentry>
		<varlistentry><term>enumprivs</term><listitem><para>Enumerate privileges</para></listitem></varlistentry>
		<varlistentry><term>getdispname</term><listitem><para>Get the privilege name</para></listitem></varlistentry>
		<varlistentry><term>lsaenumsid</term><listitem><para>Enumerate the LSA SIDS</para></listitem></varlistentry>
		<varlistentry><term>lsacreateaccount</term><listitem><para>Create a new lsa account</para></listitem></varlistentry>
		<varlistentry><term>lsaenumprivsaccount</term><listitem><para>Enumerate the privileges of an SID</para></listitem></varlistentry>
		<varlistentry><term>lsaenumacctrights</term><listitem><para>Enumerate the rights of an SID</para></listitem></varlistentry>
		<varlistentry><term>lsaaddpriv</term><listitem><para>Assign a privilege to a SID</para></listitem></varlistentry>
		<varlistentry><term>lsadelpriv</term><listitem><para>Revoke a privilege from a SID</para></listitem></varlistentry>
		<varlistentry><term>lsaaddacctrights</term><listitem><para>Add rights to an account</para></listitem></varlistentry>
		<varlistentry><term>lsaremoveacctrights</term><listitem><para>Remove rights from an account</para></listitem></varlistentry>
		<varlistentry><term>lsalookupprivvalue</term><listitem><para>Get a privilege value given its name</para></listitem></varlistentry>
		<varlistentry><term>lsaquerysecobj</term><listitem><para>Query LSA security object</para></listitem></varlistentry>
		<varlistentry><term>lsaquerytrustdominfo</term><listitem><para>Query LSA trusted domains info (given a SID)</para></listitem></varlistentry>
		<varlistentry><term>lsaquerytrustdominfobyname</term><listitem><para>Query LSA trusted domains info (given a name), only works for Windows > 2k</para></listitem></varlistentry>
		<varlistentry><term>lsaquerytrustdominfobysid</term><listitem><para>Query LSA trusted domains info (given a SID)</para></listitem></varlistentry>
		<varlistentry><term>lsasettrustdominfo</term><listitem><para>Set LSA trusted domain info</para></listitem></varlistentry>
		<varlistentry><term>getusername</term><listitem><para>Get username</para></listitem></varlistentry>
		<varlistentry><term>createsecret</term><listitem><para>Create Secret</para></listitem></varlistentry>
		<varlistentry><term>deletesecret</term><listitem><para>Delete Secret</para></listitem></varlistentry>
		<varlistentry><term>querysecret</term><listitem><para>Query Secret</para></listitem></varlistentry>
		<varlistentry><term>setsecret</term><listitem><para>Set Secret</para></listitem></varlistentry>
		<varlistentry><term>retrieveprivatedata</term><listitem><para>Retrieve Private Data</para></listitem></varlistentry>
		<varlistentry><term>storeprivatedata</term><listitem><para>Store Private Data</para></listitem></varlistentry>
		<varlistentry><term>createtrustdom</term><listitem><para>Create Trusted Domain</para></listitem></varlistentry>
		<varlistentry><term>deletetrustdom</term><listitem><para>Delete Trusted Domain</para></listitem></varlistentry>
	</variablelist>
	</refsect2>


	<refsect2>
	<title>LSARPC-DS</title>
	<variablelist>
		<varlistentry><term>dsroledominfo</term><listitem><para>Get Primary Domain Information</para></listitem></varlistentry>
	</variablelist>
	</refsect2>


	<refsect2>
	<title>DFS</title>
	<variablelist>
		<varlistentry><term>dfsversion</term><listitem><para>Query DFS support</para></listitem></varlistentry>
		<varlistentry><term>dfsadd</term><listitem><para>Add a DFS share</para></listitem></varlistentry>
		<varlistentry><term>dfsremove</term><listitem><para>Remove a DFS share</para></listitem></varlistentry>
		<varlistentry><term>dfsgetinfo</term><listitem><para>Query DFS share info</para></listitem></varlistentry>
		<varlistentry><term>dfsenum</term><listitem><para>Enumerate dfs shares</para></listitem></varlistentry>
		<varlistentry><term>dfsenumex</term><listitem><para>Enumerate dfs shares</para></listitem></varlistentry>
	</variablelist>
	</refsect2>


	<refsect2>
	<title>SHUTDOWN</title>
	<variablelist>
		<varlistentry><term>shutdowninit</term><listitem><para>syntax: shutdown [-m message] </para></listitem></varlistentry>
		<varlistentry><term>shutdownabort</term><listitem><para>syntax: shutdownabort</para></listitem></varlistentry>
	</variablelist>
	</refsect2>


	<refsect2>
	<title>SRVSVC</title>
	<variablelist>
		<varlistentry><term>srvinfo</term><listitem><para>Server query info</para></listitem></varlistentry>
		<varlistentry><term>netshareenum</term><listitem><para>Enumerate shares</para></listitem></varlistentry>
		<varlistentry><term>netshareenumall</term><listitem><para>Enumerate all shares</para></listitem></varlistentry>
		<varlistentry><term>netsharegetinfo</term><listitem><para>Get Share Info</para></listitem></varlistentry>
		<varlistentry><term>netsharesetinfo</term><listitem><para>Set Share Info</para></listitem></varlistentry>
		<varlistentry><term>netsharesetdfsflags</term><listitem><para>Set DFS flags</para></listitem></varlistentry>
		<varlistentry><term>netfileenum</term><listitem><para>Enumerate open files</para></listitem></varlistentry>
		<varlistentry><term>netremotetod</term><listitem><para>Fetch remote time of day</para></listitem></varlistentry>
		<varlistentry><term>netnamevalidate</term><listitem><para>Validate sharename</para></listitem></varlistentry>
		<varlistentry><term>netfilegetsec</term><listitem><para>Get File security</para></listitem></varlistentry>
		<varlistentry><term>netsessdel</term><listitem><para>Delete Session</para></listitem></varlistentry>
		<varlistentry><term>netsessenum</term><listitem><para>Enumerate Sessions</para></listitem></varlistentry>
		<varlistentry><term>netdiskenum</term><listitem><para>Enumerate Disks</para></listitem></varlistentry>
		<varlistentry><term>netconnenum</term><listitem><para>Enumerate Connections</para></listitem></varlistentry>
		<varlistentry><term>netshareadd</term><listitem><para>Add share</para></listitem></varlistentry>
		<varlistentry><term>netsharedel</term><listitem><para>Delete share</para></listitem></varlistentry>
	</variablelist>
	</refsect2>


	<refsect2>
	<title>SAMR</title>
	<variablelist>
		<varlistentry><term>queryuser</term><listitem><para>Query user info</para></listitem></varlistentry>
		<varlistentry><term>querygroup</term><listitem><para>Query group info</para></listitem></varlistentry>
		<varlistentry><term>queryusergroups</term><listitem><para>Query user groups</para></listitem></varlistentry>
		<varlistentry><term>queryuseraliases</term><listitem><para>Query user aliases</para></listitem></varlistentry>
		<varlistentry><term>querygroupmem</term><listitem><para>Query group membership</para></listitem></varlistentry>
		<varlistentry><term>queryaliasmem</term><listitem><para>Query alias membership</para></listitem></varlistentry>
		<varlistentry><term>queryaliasinfo</term><listitem><para>Query alias info</para></listitem></varlistentry>
		<varlistentry><term>deletealias</term><listitem><para>Delete an alias</para></listitem></varlistentry>
		<varlistentry><term>querydispinfo</term><listitem><para>Query display info</para></listitem></varlistentry>
		<varlistentry><term>querydispinfo2</term><listitem><para>Query display info</para></listitem></varlistentry>
		<varlistentry><term>querydispinfo3</term><listitem><para>Query display info</para></listitem></varlistentry>
		<varlistentry><term>querydominfo</term><listitem><para>Query domain info</para></listitem></varlistentry>
		<varlistentry><term>enumdomusers</term><listitem><para>Enumerate domain users</para></listitem></varlistentry>
		<varlistentry><term>enumdomgroups</term><listitem><para>Enumerate domain groups</para></listitem></varlistentry>
		<varlistentry><term>enumalsgroups</term><listitem><para>Enumerate alias groups</para></listitem></varlistentry>
		<varlistentry><term>enumdomains</term><listitem><para>Enumerate domains</para></listitem></varlistentry>
		<varlistentry><term>createdomuser</term><listitem><para>Create domain user</para></listitem></varlistentry>
		<varlistentry><term>createdomgroup</term><listitem><para>Create domain group</para></listitem></varlistentry>
		<varlistentry><term>createdomalias</term><listitem><para>Create domain alias</para></listitem></varlistentry>
		<varlistentry><term>samlookupnames</term><listitem><para>Look up names</para></listitem></varlistentry>
		<varlistentry><term>samlookuprids</term><listitem><para>Look up names</para></listitem></varlistentry>
		<varlistentry><term>deletedomgroup</term><listitem><para>Delete domain group</para></listitem></varlistentry>
		<varlistentry><term>deletedomuser</term><listitem><para>Delete domain user</para></listitem></varlistentry>
		<varlistentry><term>samquerysecobj</term><listitem><para>Query SAMR security object</para></listitem></varlistentry>
		<varlistentry><term>getdompwinfo</term><listitem><para>Retrieve domain password info</para></listitem></varlistentry>
		<varlistentry><term>getusrdompwinfo</term><listitem><para>Retrieve user domain password info</para></listitem></varlistentry>
		<varlistentry><term>lookupdomain</term><listitem><para>Lookup Domain Name</para></listitem></varlistentry>
		<varlistentry><term>chgpasswd</term><listitem><para>Change user password</para></listitem></varlistentry>
		<varlistentry><term>chgpasswd2</term><listitem><para>Change user password</para></listitem></varlistentry>
		<varlistentry><term>chgpasswd3</term><listitem><para>Change user password (RC4 encrypted)</para></listitem></varlistentry>
		<varlistentry><term>chgpasswd4</term><listitem><para>Change user password (AES encrypted)</para></listitem></varlistentry>
		<varlistentry><term>getdispinfoidx</term><listitem><para>Get Display Information Index</para></listitem></varlistentry>
		<varlistentry><term>setuserinfo</term><listitem><para>Set user info</para></listitem></varlistentry>
		<varlistentry><term>setuserinfo2</term><listitem><para>Set user info2</para></listitem></varlistentry>
	</variablelist>
	</refsect2>


	<refsect2>
	<title>SPOOLSS</title>

	<variablelist>
		<varlistentry><term>adddriver &lt;arch&gt; &lt;config&gt; [&lt;version&gt;]</term>
		<listitem><para>
		Execute an AddPrinterDriver() RPC to install the printer driver
		information on the server.  Note that the driver files should
		already exist in the directory returned by
		<command>getdriverdir</command>.  Possible values for
		<parameter>arch</parameter> are the same as those for
		the <command>getdriverdir</command> command.
		The <parameter>config</parameter> parameter is defined as
		follows: </para>

<para><programlisting>
Long Driver Name:\
Driver File Name:\
Data File Name:\
Config File Name:\
Help File Name:\
Language Monitor Name:\
Default Data Type:\
Comma Separated list of Files
</programlisting></para>

		<para>Any empty fields should be enter as the string "NULL". </para>

		<para>Samba does not need to support the concept of Print Monitors
		since these only apply to local printers whose driver can make
		use of a bi-directional link for communication.  This field should
		be "NULL".   On a remote NT print server, the Print Monitor for a
		driver must already be installed prior to adding the driver or
		else the RPC will fail. </para>

		<para>The <parameter>version</parameter> parameter lets you
		specify the printer driver version number.  If omitted, the
		default driver version for the specified architecture will
		be used.  This option can be used to upload Windows 2000
		(version 3) printer drivers.</para></listitem></varlistentry>

		<varlistentry><term>addprinter &lt;printername&gt;
		&lt;sharename&gt; &lt;drivername&gt; &lt;port&gt;</term>
		<listitem><para>
		Add a printer on the remote server.  This printer
		will be automatically shared.  Be aware that the printer driver
		must already be installed on the server (see <command>adddriver</command>)
		and the <parameter>port</parameter>must be a valid port name (see
		<command>enumports</command>.</para>
		</listitem></varlistentry>

		<varlistentry><term>deldriver &lt;driver&gt;</term><listitem><para>Delete the
		specified printer driver for all architectures.  This
		does not delete the actual driver files from the server,
		only the entry from the server's list of drivers.
		</para></listitem></varlistentry>

		<varlistentry><term>deldriverex &lt;driver&gt; [architecture] [version] [flags]
		</term><listitem><para>Delete the specified printer driver and optionally files
		associated with the driver.
		You can limit this action to a specific architecture and a specific version.
		If no architecture is given, all driver files of that driver will be deleted.
		<parameter>flags</parameter> correspond to numeric DPD_* values, i.e. a value
		of 3 requests (DPD_DELETE_UNUSED_FILES | DPD_DELETE_SPECIFIC_VERSION).
		</para></listitem></varlistentry>

		<varlistentry><term>enumdata</term><listitem><para>Enumerate all
		printer setting data stored on the server. On Windows NT  clients,
		these values are stored  in the registry, while Samba servers
		store them in the printers TDB.  This command corresponds
		to the MS Platform SDK GetPrinterData() function (* This
		command is currently unimplemented).</para></listitem></varlistentry>

		<varlistentry><term>enumdataex</term><listitem><para>Enumerate printer data for a key</para></listitem></varlistentry>

		<varlistentry><term>enumkey</term><listitem><para>Enumerate printer keys</para></listitem></varlistentry>

		<varlistentry><term>enumjobs &lt;printer&gt;</term>
		<listitem><para>List the jobs and status of a given printer.
		This command corresponds to the MS Platform SDK EnumJobs()
		function</para></listitem></varlistentry>

		<varlistentry><term>getjob</term><listitem><para>Get print job</para></listitem></varlistentry>
		<varlistentry><term>setjob</term><listitem><para>Set print job</para></listitem></varlistentry>


		<varlistentry><term>enumports [level]</term>
		<listitem><para>
		Executes an EnumPorts() call using the specified
		info level. Currently only info levels 1 and 2 are supported.
		</para></listitem></varlistentry>

		<varlistentry><term>enumdrivers [level]</term>
		<listitem><para>
		Execute an EnumPrinterDrivers() call.  This lists the various installed
		printer drivers for all architectures.  Refer to the MS Platform SDK
		documentation for more details of the various flags and calling
		options. Currently supported info levels are 1, 2, and 3.</para></listitem></varlistentry>

		<varlistentry><term>enumprinters [level]</term>
		<listitem><para>Execute an EnumPrinters() call.  This lists the various installed
		and share printers.  Refer to the MS Platform SDK documentation for
		more details of the various flags and calling options. Currently
		supported info levels are 1, 2 and 5.</para></listitem></varlistentry>

		<varlistentry><term>getdata &lt;printername&gt; &lt;valuename;&gt;</term>
		<listitem><para>Retrieve the data for a given printer setting.  See
		the  <command>enumdata</command> command for more information.
		This command corresponds to the GetPrinterData() MS Platform
		SDK function. </para></listitem></varlistentry>

		<varlistentry><term>getdataex</term><listitem><para>Get
		printer driver data with
		keyname</para></listitem></varlistentry>


		<varlistentry><term>getdriver &lt;printername&gt;</term>
		<listitem><para>
		Retrieve the printer driver information (such as driver file,
		config file, dependent files, etc...) for
		the given printer. This command corresponds to the GetPrinterDriver()
		MS Platform  SDK function. Currently info level 1, 2, and 3 are supported.
		</para></listitem></varlistentry>

		<varlistentry><term>getdriverdir &lt;arch&gt;</term>
		<listitem><para>
		Execute a GetPrinterDriverDirectory()
		RPC to retrieve the SMB share name and subdirectory for
		storing printer driver files for a given architecture.  Possible
		values for <parameter>arch</parameter> are "Windows 4.0"
		(for Windows 95/98), "Windows NT x86", "Windows NT PowerPC", "Windows
		Alpha_AXP", and "Windows NT R4000". </para></listitem></varlistentry>

		<varlistentry><term>getdriverpackagepath</term>
		<listitem><para>Get print driver package download directory</para></listitem></varlistentry>

		<varlistentry><term>getprinter &lt;printername&gt;</term>
		<listitem><para>Retrieve the current printer information.  This command
		corresponds to the GetPrinter() MS Platform SDK function.
		</para></listitem></varlistentry>


		<varlistentry><term>openprinter &lt;printername&gt;</term>
		<listitem><para>Execute an OpenPrinterEx() and ClosePrinter() RPC
		against a given printer. </para></listitem></varlistentry>

		<varlistentry><term>openprinter_ex &lt;printername&gt;</term>
		<listitem><para>Open printer handle</para></listitem></varlistentry>

		<varlistentry><term>setdriver &lt;printername&gt;
		&lt;drivername&gt;</term>
		<listitem><para>Execute a SetPrinter() command to update the printer driver
		associated with an installed printer.  The printer driver must
		already be correctly installed on the print server.  </para>

		<para>See also the <command>enumprinters</command> and
		<command>enumdrivers</command> commands for obtaining a list of
		of installed printers and drivers.</para></listitem></varlistentry>

		<varlistentry><term>getprintprocdir</term><listitem>
		<para>Get print processor directory</para></listitem></varlistentry>

		<varlistentry><term>addform</term><listitem><para>Add form</para></listitem></varlistentry>
		<varlistentry><term>setform</term><listitem><para>Set form</para></listitem></varlistentry>
		<varlistentry><term>getform</term><listitem><para>Get form</para></listitem></varlistentry>
		<varlistentry><term>deleteform</term><listitem><para>Delete form</para></listitem></varlistentry>
		<varlistentry><term>enumforms</term><listitem><para>Enumerate form</para></listitem></varlistentry>
		<varlistentry><term>setprinter</term><listitem><para>Set printer comment</para></listitem></varlistentry>
		<varlistentry><term>setprinterdata</term><listitem><para>Set REG_SZ printer data</para></listitem></varlistentry>

		<varlistentry><term>setprintername &lt;printername&gt; &lt;newprintername&gt;</term>
		<listitem><para>Set printer name</para></listitem></varlistentry>

		<varlistentry><term>rffpcnex</term><listitem><para>Rffpcnex test</para></listitem></varlistentry>
		<varlistentry><term>printercmp</term><listitem><para>Printer comparison test</para></listitem></varlistentry>
		<varlistentry><term>enumprocs</term><listitem><para>Enumerate Print Processors</para></listitem></varlistentry>
		<varlistentry><term>enumprocdatatypes</term><listitem><para>Enumerate Print Processor Data Types</para></listitem></varlistentry>
		<varlistentry><term>enummonitors</term><listitem><para>Enumerate Print Monitors</para></listitem></varlistentry>
		<varlistentry><term>createprinteric</term><listitem><para>Create Printer IC</para></listitem></varlistentry>
		<varlistentry><term>playgdiscriptonprinteric</term><listitem><para>Create Printer IC</para></listitem></varlistentry>
		<varlistentry><term>getcoreprinterdrivers</term><listitem><para>Get CorePrinterDriver</para></listitem></varlistentry>
		<varlistentry><term>enumpermachineconnections</term><listitem><para>Enumerate Per Machine Connections</para></listitem></varlistentry>
		<varlistentry><term>addpermachineconnection</term><listitem><para>Add Per Machine Connection</para></listitem></varlistentry>
		<varlistentry><term>delpermachineconnection</term><listitem><para>Delete Per Machine Connection</para></listitem></varlistentry>
	</variablelist>
	</refsect2>


	<refsect2>
	<title>NETLOGON</title>
	<variablelist>
		<varlistentry><term>logonctrl2</term><listitem><para>Logon Control 2</para></listitem></varlistentry>
		<varlistentry><term>getanydcname</term><listitem><para>Get trusted DC name</para></listitem></varlistentry>
		<varlistentry><term>getdcname</term><listitem><para>Get trusted PDC name</para></listitem></varlistentry>
		<varlistentry><term>dsr_getdcname</term><listitem><para>Get trusted DC name</para></listitem></varlistentry>
		<varlistentry><term>dsr_getdcnameex</term><listitem><para>Get trusted DC name</para></listitem></varlistentry>
		<varlistentry><term>dsr_getdcnameex2</term><listitem><para>Get trusted DC name</para></listitem></varlistentry>
		<varlistentry><term>dsr_getsitename</term><listitem><para>Get sitename</para></listitem></varlistentry>
		<varlistentry><term>dsr_getforesttrustinfo</term><listitem><para>Get Forest Trust Info</para></listitem></varlistentry>
		<varlistentry><term>logonctrl</term><listitem><para>Logon Control</para></listitem></varlistentry>
		<varlistentry><term>samlogon</term><listitem><para>Sam Logon</para></listitem></varlistentry>
		<varlistentry><term>change_trust_pw</term><listitem><para>Change Trust Account Password</para></listitem></varlistentry>
		<varlistentry><term>gettrustrid</term><listitem><para>Get trust rid</para></listitem></varlistentry>
		<varlistentry><term>dsr_enumtrustdom</term><listitem><para>Enumerate trusted domains</para></listitem></varlistentry>
		<varlistentry><term>dsenumdomtrusts</term><listitem><para>Enumerate all trusted domains in an AD forest</para></listitem></varlistentry>
		<varlistentry><term>deregisterdnsrecords</term><listitem><para>Deregister DNS records</para></listitem></varlistentry>
		<varlistentry><term>netrenumtrusteddomains</term><listitem><para>Enumerate trusted domains</para></listitem></varlistentry>
		<varlistentry><term>netrenumtrusteddomainsex</term><listitem><para>Enumerate trusted domains</para></listitem></varlistentry>
		<varlistentry><term>getdcsitecoverage</term><listitem><para>Get the Site-Coverage from a DC</para></listitem></varlistentry>
		<varlistentry><term>capabilities</term><listitem><para>Return Capabilities</para></listitem></varlistentry>
		<varlistentry><term>logongetdomaininfo</term><listitem><para>Return LogonGetDomainInfo</para></listitem></varlistentry>
	</variablelist>
	</refsect2>


	<refsect2>
	<title>FSRVP</title>
	<variablelist>
		<varlistentry><term>fss_is_path_sup</term><listitem><para>Check whether a share supports shadow-copy </para></listitem></varlistentry>
		<varlistentry><term>fss_get_sup_version</term><listitem><para>Get supported FSRVP version from server</para></listitem></varlistentry>
		<varlistentry><term>fss_create_expose</term><listitem><para>Request shadow-copy creation and exposure</para></listitem></varlistentry>
		<varlistentry><term>fss_delete</term><listitem><para>Request shadow-copy share deletion</para></listitem></varlistentry>
		<varlistentry><term>fss_has_shadow_copy</term><listitem><para>Check for an associated share shadow-copy</para></listitem></varlistentry>
		<varlistentry><term>fss_get_mapping</term><listitem><para>Get shadow-copy share mapping information</para></listitem></varlistentry>
		<varlistentry><term>fss_recovery_complete</term><listitem><para>Flag read-write snapshot as recovery complete, </para></listitem></varlistentry>
	</variablelist>
	</refsect2>


	<refsect2>
	<title>CLUSAPI</title>
	<variablelist>
		<varlistentry><term>clusapi_open_cluster</term><listitem><para>Open cluster</para></listitem></varlistentry>
		<varlistentry><term>clusapi_get_cluster_name</term><listitem><para>Get cluster name</para></listitem></varlistentry>
		<varlistentry><term>clusapi_get_cluster_version</term><listitem><para>Get cluster version</para></listitem></varlistentry>
		<varlistentry><term>clusapi_get_quorum_resource</term><listitem><para>Get quorum resource</para></listitem></varlistentry>
		<varlistentry><term>clusapi_create_enum</term><listitem><para>Create enum query</para></listitem></varlistentry>
		<varlistentry><term>clusapi_create_enumex</term><listitem><para>Create enumex query</para></listitem></varlistentry>
		<varlistentry><term>clusapi_open_resource</term><listitem><para>Open cluster resource</para></listitem></varlistentry>
		<varlistentry><term>clusapi_online_resource</term><listitem><para>Set cluster resource online</para></listitem></varlistentry>
		<varlistentry><term>clusapi_offline_resource</term><listitem><para>Set cluster resource offline</para></listitem></varlistentry>
		<varlistentry><term>clusapi_get_resource_state</term><listitem><para>Get cluster resource state</para></listitem></varlistentry>
		<varlistentry><term>clusapi_get_cluster_version2</term><listitem><para>Get cluster version2</para></listitem></varlistentry>
		<varlistentry><term>clusapi_pause_node</term><listitem><para>Pause cluster node</para></listitem></varlistentry>
		<varlistentry><term>clusapi_resume_node</term><listitem><para>Resume cluster node</para></listitem></varlistentry>
	</variablelist>
	</refsect2>


	<refsect2>
	<title>DRSUAPI</title>
	<variablelist>
		<varlistentry><term>dscracknames</term><listitem><para>Crack Name</para></listitem></varlistentry>
		<varlistentry><term>dsgetdcinfo</term><listitem><para>Get Domain Controller Info</para></listitem></varlistentry>
		<varlistentry><term>dsgetncchanges</term><listitem><para>Get NC Changes</para></listitem></varlistentry>
		<varlistentry><term>dswriteaccountspn</term><listitem><para>Write Account SPN</para></listitem></varlistentry>
	</variablelist>
	</refsect2>


	<refsect2>
	<title>ECHO</title>
	<variablelist>
		<varlistentry><term>echoaddone</term><listitem><para>Add one to a number</para></listitem></varlistentry>
		<varlistentry><term>echodata</term><listitem><para>Echo data</para></listitem></varlistentry>
		<varlistentry><term>sinkdata</term><listitem><para>Sink data</para></listitem></varlistentry>
		<varlistentry><term>sourcedata</term><listitem><para>Source data</para></listitem></varlistentry>
	</variablelist>
	</refsect2>


	<refsect2>
	<title>EPMAPPER</title>
	<variablelist>
		<varlistentry><term>epmmap</term><listitem><para>Map a binding</para></listitem></varlistentry>
		<varlistentry><term>epmlookup</term><listitem><para>Lookup bindings</para></listitem></varlistentry>
	</variablelist>
	</refsect2>


	<refsect2>
	<title>EVENTLOG</title>
	<variablelist>
		<varlistentry><term>eventlog_readlog</term><listitem><para>Read Eventlog</para></listitem></varlistentry>
		<varlistentry><term>eventlog_numrecord</term><listitem><para>Get number of records</para></listitem></varlistentry>
		<varlistentry><term>eventlog_oldestrecord</term><listitem><para>Get oldest record</para></listitem></varlistentry>
		<varlistentry><term>eventlog_reportevent</term><listitem><para>Report event</para></listitem></varlistentry>
		<varlistentry><term>eventlog_reporteventsource</term><listitem><para>Report event and source</para></listitem></varlistentry>
		<varlistentry><term>eventlog_registerevsource</term><listitem><para>Register event source</para></listitem></varlistentry>
		<varlistentry><term>eventlog_backuplog</term><listitem><para>Backup Eventlog File</para></listitem></varlistentry>
		<varlistentry><term>eventlog_loginfo</term><listitem><para>Get Eventlog Information</para></listitem></varlistentry>
	</variablelist>
	</refsect2>


	<refsect2>
	<title>IRemoteWinspool</title>
	<variablelist>
		<varlistentry><term>winspool_AsyncOpenPrinter</term><listitem><para>Open printer handle</para></listitem></varlistentry>
		<varlistentry><term>winspool_AsyncCorePrinterDriverInstalled</term><listitem><para>Query Core Printer Driver Installed</para></listitem></varlistentry>
	</variablelist>
	</refsect2>


	<refsect2>
	<title>NTSVCS</title>
	<variablelist>
		<varlistentry><term>ntsvcs_getversion</term><listitem><para>Query NTSVCS version</para></listitem></varlistentry>
		<varlistentry><term>ntsvcs_validatedevinst</term><listitem><para>Query NTSVCS device instance</para></listitem></varlistentry>
		<varlistentry><term>ntsvcs_hwprofflags</term><listitem><para>Query NTSVCS HW prof flags</para></listitem></varlistentry>
		<varlistentry><term>ntsvcs_hwprofinfo</term><listitem><para>Query NTSVCS HW prof info</para></listitem></varlistentry>
		<varlistentry><term>ntsvcs_getdevregprop</term><listitem><para>Query NTSVCS device registry property</para></listitem></varlistentry>
		<varlistentry><term>ntsvcs_getdevlistsize</term><listitem><para>Query NTSVCS device list size</para></listitem></varlistentry>
		<varlistentry><term>ntsvcs_getdevlist</term><listitem><para>Query NTSVCS device list</para></listitem></varlistentry>
	</variablelist>
	</refsect2>


	<refsect2>
	<title>MDSSVC</title>
	<variablelist>
		<varlistentry><term>fetch_properties</term><listitem><para>Fetch connection properties</para></listitem></varlistentry>
		<varlistentry><term>fetch_attributes</term><listitem><para>Fetch attributes for a CNID</para></listitem></varlistentry>
	</variablelist>
	</refsect2>


	<refsect2>
	<title>WINREG</title>
	<variablelist>
		<varlistentry><term>winreg_enumkey</term><listitem><para>Enumerate Keys</para></listitem></varlistentry>
		<varlistentry><term>querymultiplevalues</term><listitem><para>Query multiple values</para></listitem></varlistentry>
		<varlistentry><term>querymultiplevalues2</term><listitem><para>Query multiple values</para></listitem></varlistentry>
	</variablelist>
	</refsect2>


	<refsect2>
	<title>WITNESS</title>
	<variablelist>
		<varlistentry><term>GetInterfaceList</term><listitem><para>List the interfaces to which witness client connections can be made</para></listitem></varlistentry>
		<varlistentry><term>Register</term><listitem><para>Register for resource state change notifications of a NetName and IPAddress</para></listitem></varlistentry>
		<varlistentry><term>UnRegister</term><listitem><para>Unregister for notifications from the server</para></listitem></varlistentry>
		<varlistentry><term>AsyncNotify</term><listitem><para>Request notification of registered resource changes from the server</para></listitem></varlistentry>
		<varlistentry><term>RegisterEx</term><listitem><para>Register for resource state change notifications of a NetName, ShareName and multiple IPAddresses</para></listitem></varlistentry>
	</variablelist>
	</refsect2>


	<refsect2>
	<title>WKSSVC</title>
	<variablelist>
		<varlistentry><term>wkssvc_wkstagetinfo</term><listitem><para>Query WKSSVC Workstation Information</para></listitem></varlistentry>
		<varlistentry><term>wkssvc_getjoininformation</term><listitem><para>Query WKSSVC Join Information</para></listitem></varlistentry>
		<varlistentry><term>wkssvc_messagebuffersend</term><listitem><para>Send WKSSVC message</para></listitem></varlistentry>
		<varlistentry><term>wkssvc_enumeratecomputernames</term><listitem><para>Enumerate WKSSVC computer names</para></listitem></varlistentry>
		<varlistentry><term>wkssvc_enumerateusers</term><listitem><para>Enumerate WKSSVC users</para></listitem></varlistentry>
	</variablelist>
	</refsect2>


	<refsect2>
	<title>GENERAL OPTIONS</title>
	<variablelist>
		<varlistentry><term>help</term><listitem><para>Get help on commands</para></listitem></varlistentry>
		<varlistentry><term>?</term><listitem><para>Get help on commands</para></listitem></varlistentry>
		<varlistentry><term>debuglevel</term><listitem><para>Set debug level</para></listitem></varlistentry>
		<varlistentry><term>debug</term><listitem><para>Set debug level</para></listitem></varlistentry>
		<varlistentry><term>list</term><listitem><para>List available commands on pipe</para></listitem></varlistentry>
		<varlistentry><term>exit</term><listitem><para>Exit program</para></listitem></varlistentry>
		<varlistentry><term>quit</term><listitem><para>Exit program</para></listitem></varlistentry>
		<varlistentry><term>sign</term><listitem><para>Force RPC pipe connections to be signed</para></listitem></varlistentry>
		<varlistentry><term>seal</term><listitem><para>Force RPC pipe connections to be sealed</para></listitem></varlistentry>
		<varlistentry><term>packet</term><listitem><para>Force RPC pipe connections with packet authentication level</para></listitem></varlistentry>
		<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>
		<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>
		<varlistentry><term>timeout</term><listitem><para>Set timeout (in milliseconds) for RPC operations</para></listitem></varlistentry>
		<varlistentry><term>transport</term><listitem><para>Choose ncacn transport for RPC operations</para></listitem></varlistentry>
		<varlistentry><term>none</term><listitem><para>Force RPC pipe connections to have no special properties</para></listitem></varlistentry>
	</variablelist>
	</refsect2>

</refsect1>

<refsect1>
	<title>BUGS</title>

	<para><command>rpcclient</command> is designed as a developer testing tool
	and may not be robust in certain areas (such as command line parsing).
	It has been known to  generate a core dump upon failures when invalid
	parameters were passed to the interpreter. </para>

	<para>From Luke Leighton's original rpcclient man page:</para>

	<para><emphasis>WARNING!</emphasis> The MSRPC over SMB code has
	been developed from examining  Network traces. No documentation is
	available from the original creators  (Microsoft) on how MSRPC over
	SMB works, or how the individual MSRPC services  work. Microsoft's
	implementation of these services has been demonstrated  (and reported)
	to be... a bit flaky in places. </para>

	<para>The development of Samba's implementation is also a bit rough,
	and as more of the services are understood, it can even result in
	versions of <citerefentry><refentrytitle>smbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>rpcclient</refentrytitle>
	<manvolnum>1</manvolnum></citerefentry> that are incompatible for some commands or  services. Additionally,
	the developers are sending reports to Microsoft,  and problems found
	or reported to Microsoft are fixed in Service Packs,  which may
	result in incompatibilities.</para>
</refsect1>


<refsect1>
	<title>VERSION</title>

	<para>This man page is part of version &doc.version; of the Samba
	suite.</para>
</refsect1>

<refsect1>
	<title>AUTHOR</title>

	<para>The original Samba software and related utilities
	were created by Andrew Tridgell. Samba is now developed
	by the Samba Team as an Open Source project similar
	to the way the Linux kernel is developed.</para>

	<para>The original rpcclient man page was written by Matthew
	Geddes, Luke Kenneth Casson Leighton, and rewritten by Gerald Carter.
	The conversion to DocBook for Samba 2.2 was done by Gerald
	Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was
	done by Alexander Bokovoy.</para>
</refsect1>

</refentry>