summaryrefslogtreecommitdiff
path: root/docs/manpages/rpcclient.1
blob: 7655d6c3128b1e6b11e58c7fdb0160edb0bfd435 (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
.\"Generated by db2man.xsl. Don't modify this, modify the source.
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH "RPCCLIENT" 1 "" "" ""
.SH NAME
rpcclient \- tool for executing client side MS-RPC functions
.SH "SYNOPSIS"

.nf
\fBrpcclient\fR [-A authfile] [-c <command string>] [-d debuglevel] [-h] [-l logfile]
          [-N] [-s <smb config file>] [-U username[%password]] [-W workgroup]
          [-N] [-I destinationIP] {server}
.fi

.SH "DESCRIPTION"

.PP
This tool is part of the \fBSamba\fR(7) suite\&.

.PP
\fBrpcclient\fR 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\&.

.SH "OPTIONS"

.TP
server
NetBIOS name of Server to which to connect\&. The server can be any SMB/CIFS server\&. The name is resolved using the \fIname resolve order\fR line from \fBsmb.conf\fR(5)\&.


.TP
-c|--command='command string'
execute semicolon separated commands (listed below))


.TP
-I IP-address
\fIIP address\fR is the address of the server to connect to\&. It should be specified in standard "a\&.b\&.c\&.d" notation\&.


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 \fIname resolve order\fR 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\&.


There is no default for this parameter\&. If not supplied, it will be determined automatically by the client as described above\&.


.TP
-V
Prints the version number for \fBsmbd\fR\&.


.TP
-s <configuration file>
The file specified contains the configuration details required by the server\&. The information in this file includes server-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\&. See \fI smb\&.conf(5)\fR for more information\&. The default configuration file name is determined at compile time\&.


.TP
-d|--debug=debuglevel
\fIdebuglevel\fR is an integer from 0 to 10\&. The default value if this parameter is not specified is zero\&.


The higher this value, the more detail will be logged to the log files about the activities of the server\&. At level 0, only critical errors and serious warnings will be logged\&. Level 1 is a reasonable level for day to day running - it generates a small amount of information about operations carried out\&.


Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\&. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\&.


Note that specifying this parameter here will override the log level parameter in the \fIsmb\&.conf(5)\fR file\&.


.TP
-l|--logfile=logbasename
File name for log/debug files\&. The extension \fB"\&.client"\fR will be appended\&. The log file is never removed by the client\&.


.TP
-N
If specified, this parameter suppresses the normal password prompt from the client to the user\&. This is useful when accessing a service that does not require a password\&.


Unless a password is specified on the command line or this parameter is specified, the client will request a password\&.


.TP
-k
Try to authenticate with kerberos\&. Only useful in an Active Directory environment\&.


.TP
-A|--authfile=filename
This option allows you to specify a file from which to read the username and password used in the connection\&. The format of the file is


.nf

username = <value>
password = <value>
domain   = <value>
.fi


Make certain that the permissions on the file restrict access from unwanted users\&.


.TP
-U|--user=username[%password]
Sets the SMB username or username and password\&.


If %password is not specified, the user will be prompted\&. The client will first check the \fBUSER\fR environment variable, then the \fBLOGNAME\fR variable and if either exists, the string is uppercased\&. If these environmental variables are not found, the username \fBGUEST\fR is used\&.


A third option is to use a credentials file which contains the plaintext of the username and password\&. This option is mainly provided for scripts where the admin does not wish to pass the credentials on the command line or via environment variables\&. If this method is used, make certain that the permissions on the file restrict access from unwanted users\&. See the \fI-A\fR for more details\&.


Be cautious about including passwords in scripts\&. Also, on many systems the command line of a running process may be seen via the \fBps\fR command\&. To be safe always allow \fBrpcclient\fR to prompt for a password and type it in directly\&.


.TP
-n <primary NetBIOS name>
This option allows you to override the NetBIOS name that Samba uses for itself\&. This is identical to setting the \fINetBIOS name\fR parameter in the \fBsmb.conf\fR(5) file\&. However, a command line setting will take precedence over settings in \fBsmb.conf\fR(5)\&.


.TP
-i <scope>
This specifies a NetBIOS scope that \fBnmblookup\fR will use to communicate with when generating NetBIOS names\&. For details on the use of NetBIOS scopes, see rfc1001\&.txt and rfc1002\&.txt\&. NetBIOS scopes are \fBvery\fR rarely used, only set this parameter if you are the system administrator in charge of all the NetBIOS systems you communicate with\&.


.TP
-W|--workgroup=domain
Set the SMB domain of the username\&. This overrides the default domain which is the domain defined in smb\&.conf\&. If the domain specified is the same as the servers NetBIOS name, it causes the client to log on using the servers local SAM (as opposed to the Domain SAM)\&.


.TP
-O socket options
TCP socket options to set on the client socket\&. See the socket options parameter in the \fBsmb.conf\fR(5) manual page for the list of valid options\&.


.TP
-h|--help
Print a summary of command line options\&.


.SH "COMMANDS"

.SS "LSARPC"

.TP
lsaquery
Query info policy


.TP
lookupsids
Resolve a list of SIDs to usernames\&.


.TP
lookupnames
Resolve a list of usernames to SIDs\&.


.TP
enumtrusts
Enumerate trusted domains


.TP
enumprivs
Enumerate privileges


.TP
getdispname
Get the privilege name


.TP
lsaenumsid
Enumerate the LSA SIDS


.TP
lsaenumprivsaccount
Enumerate the privileges of an SID


.TP
lsaenumacctrights
Enumerate the rights of an SID


.TP
lsaenumacctwithright
Enumerate accounts with a right


.TP
lsaaddacctrights
Add rights to an account


.TP
lsaremoveacctrights
Remove rights from an account


.TP
lsalookupprivvalue
Get a privilege value given its name


.TP
lsaquerysecobj
Query LSA security object


.SS "LSARPC-DS"

.TP
dsroledominfo
Get Primary Domain Information


.PP


.PP
\fBDFS\fR

.TP
dfsexist
Query DFS support


.TP
dfsadd
Add a DFS share


.TP
dfsremove
Remove a DFS share


.TP
dfsgetinfo
Query DFS share info


.TP
dfsenum
Enumerate dfs shares


.SS "REG"

.TP
shutdown
Remote Shutdown


.TP
abortshutdown
Abort Shutdown


.SS "SRVSVC"

.TP
srvinfo
Server query info


.TP
netshareenum
Enumerate shares


.TP
netfileenum
Enumerate open files


.TP
netremotetod
Fetch remote time of day


.SS "SAMR"

.TP
queryuser
Query user info


.TP
querygroup
Query group info


.TP
queryusergroups
Query user groups


.TP
querygroupmem
Query group membership


.TP
queryaliasmem
Query alias membership


.TP
querydispinfo
Query display info


.TP
querydominfo
Query domain info


.TP
enumdomusers
Enumerate domain users


.TP
enumdomgroups
Enumerate domain groups


.TP
enumalsgroups
Enumerate alias groups


.TP
createdomuser
Create domain user


.TP
samlookupnames
Look up names


.TP
samlookuprids
Look up names


.TP
deletedomuser
Delete domain user


.TP
samquerysecobj
Query SAMR security object


.TP
getdompwinfo
Retrieve domain password info


.TP
lookupdomain
Look up domain


.SS "SPOOLSS"

.TP
adddriver <arch> <config>
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 \fBgetdriverdir\fR\&. Possible values for \fIarch\fR are the same as those for the \fBgetdriverdir\fR command\&. The \fIconfig\fR parameter is defined as follows:


.nf

Long Printer Name:\\
Driver File Name:\\
Data File Name:\\
Config File Name:\\
Help File Name:\\
Language Monitor Name:\\
Default Data Type:\\
Comma Separated list of Files
.fi


Any empty fields should be enter as the string "NULL"\&.


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\&.


.TP
addprinter <printername> <sharename> <drivername> <port>
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 \fBadddriver\fR) and the \fIport\fRmust be a valid port name (see \fBenumports\fR\&.


.TP
deldriver
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\&.


.TP
enumdata
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)\&.


.TP
enumdataex
Enumerate printer data for a key


.TP
enumjobs <printer>
List the jobs and status of a given printer\&. This command corresponds to the MS Platform SDK EnumJobs() function


.TP
enumkey
Enumerate printer keys


.TP
enumports [level]
Executes an EnumPorts() call using the specified info level\&. Currently only info levels 1 and 2 are supported\&.


.TP
enumdrivers [level]
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\&.


.TP
enumprinters [level]
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 0, 1, and 2\&.


.TP
getdata <printername> <valuename;>
Retrieve the data for a given printer setting\&. See the \fBenumdata\fR command for more information\&. This command corresponds to the GetPrinterData() MS Platform SDK function\&.


.TP
getdataex
Get printer driver data with keyname


.TP
getdriver <printername>
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\&.


.TP
getdriverdir <arch>
Execute a GetPrinterDriverDirectory() RPC to retrieve the SMB share name and subdirectory for storing printer driver files for a given architecture\&. Possible values for \fIarch\fR are "Windows 4\&.0" (for Windows 95/98), "Windows NT x86", "Windows NT PowerPC", "Windows Alpha_AXP", and "Windows NT R4000"\&.


.TP
getprinter <printername>
Retrieve the current printer information\&. This command corresponds to the GetPrinter() MS Platform SDK function\&.


.TP
getprintprocdir
Get print processor directory


.TP
openprinter <printername>
Execute an OpenPrinterEx() and ClosePrinter() RPC against a given printer\&.


.TP
setdriver <printername> <drivername>
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\&.


See also the \fBenumprinters\fR and \fBenumdrivers\fR commands for obtaining a list of of installed printers and drivers\&.


.TP
addform
Add form


.TP
setform
Set form


.TP
getform
Get form


.TP
deleteform
Delete form


.TP
enumforms
Enumerate form


.TP
setprinter
Set printer comment


.TP
setprinterdata
Set REG_SZ printer data


.TP
rffpcnex
Rffpcnex test


.SS "NETLOGON"

.TP
logonctrl2
Logon Control 2


.TP
logonctrl
Logon Control


.TP
samsync
Sam Synchronisation


.TP
samdeltas
Query Sam Deltas


.TP
samlogon
Sam Logon


.SS "GENERAL COMMANDS"

.TP
debuglevel
Set the current debug level used to log information\&.


.TP
help (?)
Print a listing of all known commands or extended help on a particular command\&.


.TP
quit (exit)
Exit \fBrpcclient \fR\&.


.SH "BUGS"

.PP
\fBrpcclient\fR 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 where passed to the interpreter\&.

.PP
From Luke Leighton's original rpcclient man page:

.PP
\fBWARNING!\fR 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\&.

.PP
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 \fBsmbd\fR(8) and \fBrpcclient\fR(1) 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\&.

.SH "VERSION"

.PP
This man page is correct for version 3\&.0 of the Samba suite\&.

.SH "AUTHOR"

.PP
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\&.

.PP
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\&.