20
20
.TH "RPCCLIENT" 1 "" "" ""
22
rpcclient \- tool for executing client side MS-RPC functions
22
rpcclient - tool for executing client side MS-RPC functions
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}
25
\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}
34
This tool is part of the \fBsamba\fR(7) suite\&.
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\&.
28
This tool is part of the
33
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.
43
NetBIOS 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)\&.
46
\-c|\-\-command='command string'
37
NetBIOS name of Server to which to connect. The server can be any SMB/CIFS server. The name is resolved using the
38
name resolve order line from
41
-c|--command='command string'
47
42
execute semicolon separated commands (listed below))
51
\fIIP address\fR is the address of the server to connect to\&. It should be specified in standard "a\&.b\&.c\&.d" notation\&.
53
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\&.
55
There is no default for this parameter\&. If not supplied, it will be determined automatically by the client as described above\&.
59
Prints the program version number\&.
62
\-s <configuration file>
63
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 \fIsmb\&.conf\fR for more information\&. The default configuration file name is determined at compile time\&.
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\&.
69
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\&.
71
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\&.
73
Note that specifying this parameter here will override the parameter in the \fIsmb\&.conf\fR file\&.
76
\-l|\-\-logfile=logdirectory
77
Base 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\&.
81
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\&.
83
Unless a password is specified on the command line or this parameter is specified, the client will request a password\&.
87
Try to authenticate with kerberos\&. Only useful in an Active Directory environment\&.
90
\-A|\-\-authentication\-file=filename
91
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
46
is the address of the server to connect to. It should be specified in standard "a.b.c.d" notation.
48
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
49
\fIname resolve order\fR
50
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.
52
There is no default for this parameter. If not supplied, it will be determined automatically by the client as described above.
55
Prints the program version number.
57
-s <configuration file>
58
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
60
for more information. The default configuration file name is determined at compile time.
64
is an integer from 0 to 10. The default value if this parameter is not specified is zero.
66
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.
68
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.
70
Note that specifying this parameter here will override the
76
-l|--logfile=logdirectory
77
Base directory name for log/debug files. The extension
79
will be appended (e.g. log.smbclient, log.smbd, etc...). The log file is never removed by the client.
82
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.
84
Unless a password is specified on the command line or this parameter is specified, the client will request a password.
87
Try to authenticate with kerberos. Only useful in an Active Directory environment.
89
-A|--authentication-file=filename
90
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
102
Make certain that the permissions on the file restrict access from unwanted users\&.
105
\-U|\-\-user=username[%password]
106
Sets the SMB username or username and password\&.
108
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\&.
110
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\&.
112
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\&.
115
\-n <primary NetBIOS name>
116
This 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\&.
120
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\&.
123
\-W|\-\-workgroup=domain
124
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)\&.
128
TCP 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\&.
132
Print a summary of command line options\&.
102
Make certain that the permissions on the file restrict access from unwanted users.
104
-U|--user=username[%password]
105
Sets the SMB username or username and password.
107
If %password is not specified, the user will be prompted. The client will first check the
109
environment variable, then the
111
variable and if either exists, the string is uppercased. If these environmental variables are not found, the username
115
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
119
Be cautious about including passwords in scripts. Also, on many systems the command line of a running process may be seen via the
121
command. To be safe always allow
123
to prompt for a password and type it in directly.
125
-n <primary NetBIOS name>
126
This option allows you to override the NetBIOS name that Samba uses for itself. This is identical to setting the
130
file. However, a command line setting will take precedence over settings in
134
This specifies a NetBIOS scope that
136
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
138
rarely used, only set this parameter if you are the system administrator in charge of all the NetBIOS systems you communicate with.
140
-W|--workgroup=domain
141
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).
144
TCP socket options to set on the client socket. See the socket options parameter in the
146
manual page for the list of valid options.
149
Print a summary of command line options.
140
154
Query info policy
144
Resolve a list of SIDs to usernames\&.
157
Resolve a list of SIDs to usernames.
148
Resolve a list of usernames to SIDs\&.
160
Resolve a list of usernames to SIDs.
152
163
Enumerate trusted domains
156
166
Enumerate privileges
160
169
Get the privilege name
164
172
Enumerate the LSA SIDS
167
174
lsaenumprivsaccount
168
175
Enumerate the privileges of an SID
171
177
lsaenumacctrights
172
178
Enumerate the rights of an SID
175
180
lsaenumacctwithright
176
181
Enumerate accounts with a right
180
184
Add rights to an account
183
186
lsaremoveacctrights
184
187
Remove rights from an account
187
189
lsalookupprivvalue
188
190
Get a privilege value given its name
192
193
Query LSA security object
194
.\" end of SS subsection "LSARPC"
198
198
Get Primary Domain Information
208
205
Query DFS support
216
211
Remove a DFS share
220
214
Query DFS share info
224
217
Enumerate dfs shares
218
.\" end of SS subsection "LSARPC-DS"
226
.\" end of SS subsection "REG"
240
230
Server query info
248
236
Enumerate open files
252
239
Fetch remote time of day
240
.\" end of SS subsection "SRVSVC"
266
250
Query user groups
270
253
Query group membership
274
256
Query alias membership
278
259
Query display info
282
262
Query domain info
286
265
Enumerate domain users
290
268
Enumerate domain groups
294
271
Enumerate alias groups
298
274
Create domain user
310
283
Delete domain user
314
286
Query SAMR security object
318
289
Retrieve domain password info
293
.\" end of SS subsection "SAMR"
327
296
adddriver <arch> <config> [<version>]
328
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:
297
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
298
\fBgetdriverdir\fR. Possible values for
300
are the same as those for the
304
parameter is defined as follows:
338
Language Monitor Name:\\
315
Language Monitor Name:\
340
317
Comma Separated list of Files
344
Any empty fields should be enter as the string "NULL"\&.
346
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\&.
348
The \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\&.
321
Any empty fields should be enter as the string "NULL".
323
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.
327
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.
351
329
addprinter <printername> <sharename> <drivername> <port>
352
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\&.
330
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
331
\fBadddriver\fR) and the
332
\fIport\fRmust be a valid port name (see
356
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\&.
336
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.
359
338
deldriverex <driver> [architecture] [version]
360
Delete 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\&.
339
Delete 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.
364
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)\&.
342
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).
368
345
Enumerate printer data for a key
371
347
enumjobs <printer>
372
List the jobs and status of a given printer\&. This command corresponds to the MS Platform SDK EnumJobs() function
348
List the jobs and status of a given printer. This command corresponds to the MS Platform SDK EnumJobs() function
376
351
Enumerate printer keys
379
353
enumports [level]
380
Executes an EnumPorts() call using the specified info level\&. Currently only info levels 1 and 2 are supported\&.
354
Executes an EnumPorts() call using the specified info level. Currently only info levels 1 and 2 are supported.
383
356
enumdrivers [level]
384
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\&.
357
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.
387
359
enumprinters [level]
388
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\&.
360
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.
391
362
getdata <printername> <valuename;>
392
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\&.
363
Retrieve the data for a given printer setting. See the
365
command for more information. This command corresponds to the GetPrinterData() MS Platform SDK function.
396
368
Get printer driver data with keyname
399
370
getdriver <printername>
400
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\&.
371
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.
403
373
getdriverdir <arch>
404
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"\&.
374
Execute a GetPrinterDriverDirectory() RPC to retrieve the SMB share name and subdirectory for storing printer driver files for a given architecture. Possible values for
376
are "Windows 4.0" (for Windows 95/98), "Windows NT x86", "Windows NT PowerPC", "Windows Alpha_AXP", and "Windows NT R4000".
407
378
getprinter <printername>
408
Retrieve the current printer information\&. This command corresponds to the GetPrinter() MS Platform SDK function\&.
379
Retrieve the current printer information. This command corresponds to the GetPrinter() MS Platform SDK function.
412
382
Get print processor directory
415
384
openprinter <printername>
416
Execute an OpenPrinterEx() and ClosePrinter() RPC against a given printer\&.
385
Execute an OpenPrinterEx() and ClosePrinter() RPC against a given printer.
419
387
setdriver <printername> <drivername>
420
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\&.
422
See also the \fBenumprinters\fR and\fBenumdrivers\fR commands for obtaining a list of of installed printers and drivers\&.
388
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.
394
commands for obtaining a list of of installed printers and drivers.
446
412
Set printer comment
450
415
Set REG_SZ printer data
453
417
setprintername <printername> <newprintername>
422
.\" end of SS subsection "SPOOLSS"
472
432
Sam Synchronisation
439
.\" end of SS subsection "NETLOGON"
482
440
.SS "GENERAL COMMANDS"
486
Set the current debug level used to log information\&.
443
Set the current debug level used to log information.
490
Print a listing of all known commands or extended help on a particular command\&.
446
Print a listing of all known commands or extended help on a particular command.
494
Exit \fBrpcclient \fR\&.
451
.\" end of SS subsection "GENERAL COMMANDS"
499
\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\&.
455
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.
502
457
From Luke Leighton's original rpcclient man page:
505
\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\&.
508
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\&.
460
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.
462
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
466
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.
513
This man page is correct for version 3\&.0 of the Samba suite\&.
469
This man page is correct for version 3.0 of the Samba suite.
518
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\&.
521
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\&.
472
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.
474
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.
added
removed
docs/manpages/rpcclient.1
