source: trunk/samba/docs/manpages/rpcclient.1 @ 26

Last change on this file since 26 was 26, checked in by Paul Smedley, 14 years ago

Updated source to 3.0.25rc1

File size: 15.8 KB
Line 
1.\"Generated by db2man.xsl. Don't modify this, modify the source.
2.de Sh \" Subsection
3.br
4.if t .Sp
5.ne 5
6.PP
7\fB\\$1\fR
8.PP
9..
10.de Sp \" Vertical space (when we can't use .PP)
11.if t .sp .5v
12.if n .sp
13..
14.de Ip \" List item
15.br
16.ie \\n(.$>=3 .ne \\$3
17.el .ne 3
18.IP "\\$1" \\$2
19..
20.TH "RPCCLIENT" 1 "" "" ""
21.SH NAME
22rpcclient \- tool for executing client side MS-RPC functions
23.SH "SYNOPSIS"
24.ad l
25.hy 0
26.HP 10
27\fBrpcclient\fR [\-A\ authfile] [\-c\ <command\ string>] [\-d\ debuglevel] [\-h] [\-l\ logdir] [\-N] [\-s\ <smb\ config\ file>] [\-U\ username[%password]] [\-W\ workgroup] [\-N] [\-I\ destinationIP] {server}
28.ad
29.hy
30
31.SH "DESCRIPTION"
32
33.PP
34This tool is part of the \fBsamba\fR(7) suite\&.
35
36.PP
37\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\&.
38
39.SH "OPTIONS"
40
41.TP
42server
43NetBIOS name of Server to which to connect\&. The server can be any SMB/CIFS server\&. The name is resolved using the name resolve order line from \fBsmb\&.conf\fR(5)\&.
44
45.TP
46\-c|\-\-command='command string'
47execute semicolon separated commands (listed below))
48
49.TP
50\-I IP\-address
51\fIIP address\fR is the address of the server to connect to\&. It should be specified in standard "a\&.b\&.c\&.d" notation\&.
52
53Normally 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\&.
54
55There is no default for this parameter\&. If not supplied, it will be determined automatically by the client as described above\&.
56
57.TP
58\-V
59Prints the program version number\&.
60
61.TP
62\-s <configuration file>
63The 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 \fIsmb\&.conf\fR for more information\&. The default configuration file name is determined at compile time\&.
64
65.TP
66\-d|\-\-debuglevel=level
67\fIlevel\fR is an integer from 0 to 10\&. The default value if this parameter is not specified is zero\&.
68
69The 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\&.
70
71Levels 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\&.
72
73Note that specifying this parameter here will override the  parameter in the \fIsmb\&.conf\fR file\&.
74
75.TP
76\-l|\-\-logfile=logdirectory
77Base directory name for log/debug files\&. The extension \fB"\&.progname"\fR will be appended (e\&.g\&. log\&.smbclient, log\&.smbd, etc\&.\&.\&.)\&. The log file is never removed by the client\&.
78
79.TP
80\-N
81If 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\&.
82
83Unless a password is specified on the command line or this parameter is specified, the client will request a password\&.
84
85If a password is specified on the command line and this option is also defined the password on the command line will be silently ingnored and no password will be used\&.
86
87.TP
88\-k
89Try to authenticate with kerberos\&. Only useful in an Active Directory environment\&.
90
91.TP
92\-A|\-\-authentication\-file=filename
93This 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
94
95
96
97.nf
98
99username = <value>
100password = <value>
101domain   = <value>
102
103.fi
104
105
106Make certain that the permissions on the file restrict access from unwanted users\&.
107
108.TP
109\-U|\-\-user=username[%password]
110Sets the SMB username or username and password\&.
111
112If %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\&.
113
114A 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\&.
115
116Be 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\&.
117
118.TP
119\-n <primary NetBIOS name>
120This option allows you to override the NetBIOS name that Samba uses for itself\&. This is identical to setting the  parameter in the \fIsmb\&.conf\fR file\&. However, a command line setting will take precedence over settings in \fIsmb\&.conf\fR\&.
121
122.TP
123\-i <scope>
124This 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\&.
125
126.TP
127\-W|\-\-workgroup=domain
128Set 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)\&.
129
130.TP
131\-O socket options
132TCP socket options to set on the client socket\&. See the socket options parameter in the \fIsmb\&.conf\fR manual page for the list of valid options\&.
133
134.TP
135\-h|\-\-help
136Print a summary of command line options\&.
137
138.SH "COMMANDS"
139
140.SS "LSARPC"
141
142.TP
143lsaquery
144Query info policy
145
146.TP
147lookupsids
148Resolve a list of SIDs to usernames\&.
149
150.TP
151lookupnames
152Resolve a list of usernames to SIDs\&.
153
154.TP
155enumtrusts
156Enumerate trusted domains
157
158.TP
159enumprivs
160Enumerate privileges
161
162.TP
163getdispname
164Get the privilege name
165
166.TP
167lsaenumsid
168Enumerate the LSA SIDS
169
170.TP
171lsaenumprivsaccount
172Enumerate the privileges of an SID
173
174.TP
175lsaenumacctrights
176Enumerate the rights of an SID
177
178.TP
179lsaenumacctwithright
180Enumerate accounts with a right
181
182.TP
183lsaaddacctrights
184Add rights to an account
185
186.TP
187lsaremoveacctrights
188Remove rights from an account
189
190.TP
191lsalookupprivvalue
192Get a privilege value given its name
193
194.TP
195lsaquerysecobj
196Query LSA security object
197
198.SS "LSARPC-DS"
199
200.TP
201dsroledominfo
202Get Primary Domain Information
203
204.PP
205
206
207.PP
208\fBDFS\fR
209
210.TP
211dfsexist
212Query DFS support
213
214.TP
215dfsadd
216Add a DFS share
217
218.TP
219dfsremove
220Remove a DFS share
221
222.TP
223dfsgetinfo
224Query DFS share info
225
226.TP
227dfsenum
228Enumerate dfs shares
229
230.SS "REG"
231
232.TP
233shutdown
234Remote Shutdown
235
236.TP
237abortshutdown
238Abort Shutdown
239
240.SS "SRVSVC"
241
242.TP
243srvinfo
244Server query info
245
246.TP
247netshareenum
248Enumerate shares
249
250.TP
251netfileenum
252Enumerate open files
253
254.TP
255netremotetod
256Fetch remote time of day
257
258.SS "SAMR"
259
260.TP
261queryuser
262Query user info
263
264.TP
265querygroup
266Query group info
267
268.TP
269queryusergroups
270Query user groups
271
272.TP
273querygroupmem
274Query group membership
275
276.TP
277queryaliasmem
278Query alias membership
279
280.TP
281querydispinfo
282Query display info
283
284.TP
285querydominfo
286Query domain info
287
288.TP
289enumdomusers
290Enumerate domain users
291
292.TP
293enumdomgroups
294Enumerate domain groups
295
296.TP
297enumalsgroups
298Enumerate alias groups
299
300.TP
301createdomuser
302Create domain user
303
304.TP
305samlookupnames
306Look up names
307
308.TP
309samlookuprids
310Look up names
311
312.TP
313deletedomuser
314Delete domain user
315
316.TP
317samquerysecobj
318Query SAMR security object
319
320.TP
321getdompwinfo
322Retrieve domain password info
323
324.TP
325lookupdomain
326Look up domain
327
328.SS "SPOOLSS"
329
330.TP
331adddriver <arch> <config> [<version>]
332Execute 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:
333
334
335
336.nf
337
338Long Printer Name:\\
339Driver File Name:\\
340Data File Name:\\
341Config File Name:\\
342Help File Name:\\
343Language Monitor Name:\\
344Default Data Type:\\
345Comma Separated list of Files
346
347.fi
348
349
350Any empty fields should be enter as the string "NULL"\&.
351
352Samba 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\&.
353
354The \fIversion\fR 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\&.
355
356.TP
357addprinter <printername> <sharename> <drivername> <port>
358Add 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\&.
359
360.TP
361deldriver
362Delete 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\&.
363
364.TP
365deldriverex <driver> [architecture] [version]
366Delete the specified printer driver including driver files\&. You can limit this action to a specific architecture and a specific version\&. If no architecure is given, all driver files of that driver will be deleted\&.
367
368.TP
369enumdata
370Enumerate 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)\&.
371
372.TP
373enumdataex
374Enumerate printer data for a key
375
376.TP
377enumjobs <printer>
378List the jobs and status of a given printer\&. This command corresponds to the MS Platform SDK EnumJobs() function
379
380.TP
381enumkey
382Enumerate printer keys
383
384.TP
385enumports [level]
386Executes an EnumPorts() call using the specified info level\&. Currently only info levels 1 and 2 are supported\&.
387
388.TP
389enumdrivers [level]
390Execute 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\&.
391
392.TP
393enumprinters [level]
394Execute 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\&.
395
396.TP
397getdata <printername> <valuename;>
398Retrieve 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\&.
399
400.TP
401getdataex
402Get printer driver data with keyname
403
404.TP
405getdriver <printername>
406Retrieve 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\&.
407
408.TP
409getdriverdir <arch>
410Execute 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"\&.
411
412.TP
413getprinter <printername>
414Retrieve the current printer information\&. This command corresponds to the GetPrinter() MS Platform SDK function\&.
415
416.TP
417getprintprocdir
418Get print processor directory
419
420.TP
421openprinter <printername>
422Execute an OpenPrinterEx() and ClosePrinter() RPC against a given printer\&.
423
424.TP
425setdriver <printername> <drivername>
426Execute 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\&.
427
428See also the \fBenumprinters\fR and\fBenumdrivers\fR commands for obtaining a list of of installed printers and drivers\&.
429
430.TP
431addform
432Add form
433
434.TP
435setform
436Set form
437
438.TP
439getform
440Get form
441
442.TP
443deleteform
444Delete form
445
446.TP
447enumforms
448Enumerate form
449
450.TP
451setprinter
452Set printer comment
453
454.TP
455setprinterdata
456Set REG_SZ printer data
457
458.TP
459setprintername <printername> <newprintername>
460Set printer name
461
462.TP
463rffpcnex
464Rffpcnex test
465
466.SS "NETLOGON"
467
468.TP
469logonctrl2
470Logon Control 2
471
472.TP
473logonctrl
474Logon Control
475
476.TP
477samsync
478Sam Synchronisation
479
480.TP
481samdeltas
482Query Sam Deltas
483
484.TP
485samlogon
486Sam Logon
487
488.SS "GENERAL COMMANDS"
489
490.TP
491debuglevel
492Set the current debug level used to log information\&.
493
494.TP
495help (?)
496Print a listing of all known commands or extended help on a particular command\&.
497
498.TP
499quit (exit)
500Exit \fBrpcclient \fR\&.
501
502.SH "BUGS"
503
504.PP
505\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\&.
506
507.PP
508From Luke Leighton's original rpcclient man page:
509
510.PP
511\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\&.
512
513.PP
514The 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\&.
515
516.SH "VERSION"
517
518.PP
519This man page is correct for version 3\&.0 of the Samba suite\&.
520
521.SH "AUTHOR"
522
523.PP
524The 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\&.
525
526.PP
527The 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\&.
528
Note: See TracBrowser for help on using the repository browser.