'\" t
.\"     Title: rpcclient
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 02/21/2015
.\"    Manual: User Commands
.\"    Source: Samba 4.0
.\"  Language: English
.\"
.TH "RPCCLIENT" "1" "02/21/2015" "Samba 4\&.0" "User Commands"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
rpcclient \- tool for executing client side MS\-RPC functions
.SH "SYNOPSIS"
.HP \w'\ 'u
rpcclient [\-A\ authfile] [\-c\ <command\ string>] [\-d\ debuglevel] [\-l\ logdir] [\-N] [\-s\ <smb\ config\ file>] [\-U\ username[%password]] [\-W\ workgroup] [\-I\ destinationIP] {server}
.SH "DESCRIPTION"
.PP
This tool is part of the
\fBsamba\fR(7)
suite\&.
.PP
rpcclient
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"
.PP
server
.RS 4
NetBIOS name of Server to which to connect\&. The server can be any SMB/CIFS server\&. The name is resolved using the
\m[blue]\fBname resolve order\fR\m[]
line from
\fBsmb.conf\fR(5)\&.
.RE
.PP
\-c|\-\-command=<command string>
.RS 4
Execute semicolon separated commands (listed below)
.RE
.PP
\-I|\-\-dest\-ip IP\-address
.RS 4
\fIIP address\fR
is the address of the server to connect to\&. It should be specified in standard "a\&.b\&.c\&.d" notation\&.
.sp
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\&.
.sp
There is no default for this parameter\&. If not supplied, it will be determined automatically by the client as described above\&.
.RE
.PP
\-p|\-\-port port
.RS 4
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\&.
.RE
.PP
\-d|\-\-debuglevel=level
.RS 4
\fIlevel\fR
is an integer from 0 to 10\&. The default value if this parameter is not specified is 0\&.
.sp
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\&.
.sp
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\&.
.sp
Note that specifying this parameter here will override the
\m[blue]\fBlog level\fR\m[]
parameter in the
smb\&.conf
file\&.
.RE
.PP
\-V|\-\-version
.RS 4
Prints the program version number\&.
.RE
.PP
\-s|\-\-configfile=<configuration file>
.RS 4
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
smb\&.conf
for more information\&. The default configuration file name is determined at compile time\&.
.RE
.PP
\-l|\-\-log\-basename=logdirectory
.RS 4
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\&.
.RE
.PP
\-\-option=<name>=<value>
.RS 4
Set the
\fBsmb.conf\fR(5)
option "<name>" to value "<value>" from the command line\&. This overrides compiled\-in defaults and options read from the configuration file\&.
.RE
.PP
\-N|\-\-no\-pass
.RS 4
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\&.
.sp
Unless a password is specified on the command line or this parameter is specified, the client will request a password\&.
.sp
If 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\&.
.RE
.PP
\-k|\-\-kerberos
.RS 4
Try to authenticate with kerberos\&. Only useful in an Active Directory environment\&.
.RE
.PP
\-C|\-\-use\-ccache
.RS 4
Try to use the credentials cached by winbind\&.
.RE
.PP
\-A|\-\-authentication\-file=filename
.RS 4
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
.sp
.if n \{\
.RS 4
.\}
.nf
username = <value>
password = <value>
domain   = <value>
.fi
.if n \{\
.RE
.\}
.sp
Make certain that the permissions on the file restrict access from unwanted users\&.
.RE
.PP
\-U|\-\-user=username[%password]
.RS 4
Sets the SMB username or username and password\&.
.sp
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\&.
.sp
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\&.
.sp
Be cautious about including passwords in scripts\&. Also, on many systems the command line of a running process may be seen via the
ps
command\&. To be safe always allow
rpcclient
to prompt for a password and type it in directly\&.
.RE
.PP
\-S|\-\-signing on|off|required
.RS 4
Set the client signing state\&.
.RE
.PP
\-P|\-\-machine\-pass
.RS 4
Use stored machine account password\&.
.RE
.PP
\-e|\-\-encrypt
.RS 4
This command line parameter requires the remote server support the UNIX extensions or that the SMB3 protocol has been selected\&. Requests that the connection be encrypted\&. Negotiates SMB encryption using either SMB3 or POSIX extensions via GSSAPI\&. Uses the given credentials for the encryption negotiation (either kerberos or NTLMv1/v2 if given domain/username/password triple\&. Fails the connection if encryption cannot be negotiated\&.
.RE
.PP
\-\-pw\-nt\-hash
.RS 4
The supplied password is the NT hash\&.
.RE
.PP
\-n|\-\-netbiosname <primary NetBIOS name>
.RS 4
This option allows you to override the NetBIOS name that Samba uses for itself\&. This is identical to setting the
\m[blue]\fBnetbios name\fR\m[]
parameter in the
smb\&.conf
file\&. However, a command line setting will take precedence over settings in
smb\&.conf\&.
.RE
.PP
\-i|\-\-scope <scope>
.RS 4
This specifies a NetBIOS scope that
nmblookup
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
\fIvery\fR
rarely used, only set this parameter if you are the system administrator in charge of all the NetBIOS systems you communicate with\&.
.RE
.PP
\-W|\-\-workgroup=domain
.RS 4
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)\&.
.RE
.PP
\-O|\-\-socket\-options socket options
.RS 4
TCP socket options to set on the client socket\&. See the socket options parameter in the
smb\&.conf
manual page for the list of valid options\&.
.RE
.PP
\-?|\-\-help
.RS 4
Print a summary of command line options\&.
.RE
.PP
\-\-usage
.RS 4
Display brief usage message\&.
.RE
.SH "COMMANDS"
.SS "LSARPC"
.PP
lsaquery
.RS 4
Query info policy
.RE
.PP
lookupsids
.RS 4
Resolve a list of SIDs to usernames\&.
.RE
.PP
lookupnames
.RS 4
Resolve a list of usernames to SIDs\&.
.RE
.PP
enumtrust
.RS 4
Enumerate trusted domains
.RE
.PP
enumprivs
.RS 4
Enumerate privileges
.RE
.PP
getdispname
.RS 4
Get the privilege name
.RE
.PP
lsaenumsid
.RS 4
Enumerate the LSA SIDS
.RE
.PP
lsaenumprivsaccount
.RS 4
Enumerate the privileges of an SID
.RE
.PP
lsaenumacctrights
.RS 4
Enumerate the rights of an SID
.RE
.PP
lsaenumacctwithright
.RS 4
Enumerate accounts with a right
.RE
.PP
lsaaddacctrights
.RS 4
Add rights to an account
.RE
.PP
lsaremoveacctrights
.RS 4
Remove rights from an account
.RE
.PP
lsalookupprivvalue
.RS 4
Get a privilege value given its name
.RE
.PP
lsaquerysecobj
.RS 4
Query LSA security object
.RE
.SS "LSARPC\-DS"
.PP
dsroledominfo
.RS 4
Get Primary Domain Information
.RE
.PP
.PP
\fIDFS\fR
.PP
dfsexist
.RS 4
Query DFS support
.RE
.PP
dfsadd
.RS 4
Add a DFS share
.RE
.PP
dfsremove
.RS 4
Remove a DFS share
.RE
.PP
dfsgetinfo
.RS 4
Query DFS share info
.RE
.PP
dfsenum
.RS 4
Enumerate dfs shares
.RE
.SS "REG"
.PP
shutdown
.RS 4
Remote Shutdown
.RE
.PP
abortshutdown
.RS 4
Abort Shutdown
.RE
.SS "SRVSVC"
.PP
srvinfo
.RS 4
Server query info
.RE
.PP
netshareenum
.RS 4
Enumerate shares
.RE
.PP
netfileenum
.RS 4
Enumerate open files
.RE
.PP
netremotetod
.RS 4
Fetch remote time of day
.RE
.SS "SAMR"
.PP
queryuser
.RS 4
Query user info
.RE
.PP
querygroup
.RS 4
Query group info
.RE
.PP
queryusergroups
.RS 4
Query user groups
.RE
.PP
querygroupmem
.RS 4
Query group membership
.RE
.PP
queryaliasmem
.RS 4
Query alias membership
.RE
.PP
querydispinfo
.RS 4
Query display info
.RE
.PP
querydominfo
.RS 4
Query domain info
.RE
.PP
enumdomusers
.RS 4
Enumerate domain users
.RE
.PP
enumdomgroups
.RS 4
Enumerate domain groups
.RE
.PP
enumalsgroups
.RS 4
Enumerate alias groups
.RE
.PP
createdomuser
.RS 4
Create domain user
.RE
.PP
samlookupnames
.RS 4
Look up names
.RE
.PP
samlookuprids
.RS 4
Look up names
.RE
.PP
deletedomuser
.RS 4
Delete domain user
.RE
.PP
samquerysecobj
.RS 4
Query SAMR security object
.RE
.PP
getdompwinfo
.RS 4
Retrieve domain password info
.RE
.PP
lookupdomain
.RS 4
Look up domain
.RE
.SS "SPOOLSS"
.PP
adddriver <arch> <config> [<version>]
.RS 4
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
getdriverdir\&. Possible values for
\fIarch\fR
are the same as those for the
getdriverdir
command\&. The
\fIconfig\fR
parameter is defined as follows:
.sp
.if n \{\
.RS 4
.\}
.nf
Long Driver Name:\e
Driver File Name:\e
Data File Name:\e
Config File Name:\e
Help File Name:\e
Language Monitor Name:\e
Default Data Type:\e
Comma Separated list of Files
.fi
.if n \{\
.RE
.\}
.sp
Any empty fields should be enter as the string "NULL"\&.
.sp
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\&.
.sp
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\&.
.RE
.PP
addprinter <printername> <sharename> <drivername> <port>
.RS 4
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
adddriver) and the
\fIport\fRmust be a valid port name (see
enumports\&.
.RE
.PP
deldriver <driver>
.RS 4
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\*(Aqs list of drivers\&.
.RE
.PP
deldriverex <driver> [architecture] [version] [flags]
.RS 4
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\&.
\fIflags\fR
correspond to numeric DPD_* values, i\&.e\&. a value of 3 requests (DPD_DELETE_UNUSED_FILES | DPD_DELETE_SPECIFIC_VERSION)\&.
.RE
.PP
enumdata
.RS 4
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)\&.
.RE
.PP
enumdataex
.RS 4
Enumerate printer data for a key
.RE
.PP
enumjobs <printer>
.RS 4
List the jobs and status of a given printer\&. This command corresponds to the MS Platform SDK EnumJobs() function
.RE
.PP
enumkey
.RS 4
Enumerate printer keys
.RE
.PP
enumports [level]
.RS 4
Executes an EnumPorts() call using the specified info level\&. Currently only info levels 1 and 2 are supported\&.
.RE
.PP
enumdrivers [level]
.RS 4
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\&.
.RE
.PP
enumprinters [level]
.RS 4
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\&.
.RE
.PP
getdata <printername> <valuename;>
.RS 4
Retrieve the data for a given printer setting\&. See the
enumdata
command for more information\&. This command corresponds to the GetPrinterData() MS Platform SDK function\&.
.RE
.PP
getdataex
.RS 4
Get printer driver data with keyname
.RE
.PP
getdriver <printername>
.RS 4
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\&.
.RE
.PP
getdriverdir <arch>
.RS 4
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"\&.
.RE
.PP
getprinter <printername>
.RS 4
Retrieve the current printer information\&. This command corresponds to the GetPrinter() MS Platform SDK function\&.
.RE
.PP
getprintprocdir
.RS 4
Get print processor directory
.RE
.PP
openprinter <printername>
.RS 4
Execute an OpenPrinterEx() and ClosePrinter() RPC against a given printer\&.
.RE
.PP
setdriver <printername> <drivername>
.RS 4
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\&.
.sp
See also the
enumprinters
and
enumdrivers
commands for obtaining a list of of installed printers and drivers\&.
.RE
.PP
addform
.RS 4
Add form
.RE
.PP
setform
.RS 4
Set form
.RE
.PP
getform
.RS 4
Get form
.RE
.PP
deleteform
.RS 4
Delete form
.RE
.PP
enumforms
.RS 4
Enumerate form
.RE
.PP
setprinter
.RS 4
Set printer comment
.RE
.PP
setprinterdata
.RS 4
Set REG_SZ printer data
.RE
.PP
setprintername <printername> <newprintername>
.RS 4
Set printer name
.RE
.PP
rffpcnex
.RS 4
Rffpcnex test
.RE
.SS "NETLOGON"
.PP
logonctrl2
.RS 4
Logon Control 2
.RE
.PP
logonctrl
.RS 4
Logon Control
.RE
.PP
samsync
.RS 4
Sam Synchronisation
.RE
.PP
samdeltas
.RS 4
Query Sam Deltas
.RE
.PP
samlogon
.RS 4
Sam Logon
.RE
.SS "FSRVP"
.PP
fss_is_path_sup <share>
.RS 4
Check whether a share supports shadow\-copy requests
.RE
.PP
fss_get_sup_version
.RS 4
Get supported FSRVP version from server
.RE
.PP
fss_create_expose <context> <[ro|rw]> <share1> [share2] \&.\&.\&. [shareN]
.RS 4
Request shadow\-copy creation and exposure as a new share
.RE
.PP
fss_delete <base_share> <shadow_copy_set_id> <shadow_copy_id>
.RS 4
Request shadow\-copy share deletion
.RE
.PP
fss_has_shadow_copy <base_share>
.RS 4
Check for an associated share shadow\-copy
.RE
.PP
fss_get_mapping <base_share> <shadow_copy_set_id> <shadow_copy_id>
.RS 4
Get shadow\-copy share mapping information
.RE
.PP
fss_recovery_complete <shadow_copy_set_id>
.RS 4
Flag read\-write shadow\-copy as recovery complete, allowing further shadow\-copy requests
.RE
.SS "GENERAL COMMANDS"
.PP
debuglevel
.RS 4
Set the current debug level used to log information\&.
.RE
.PP
help (?)
.RS 4
Print a listing of all known commands or extended help on a particular command\&.
.RE
.PP
quit (exit)
.RS 4
Exit
rpcclient\&.
.RE
.SH "BUGS"
.PP
rpcclient
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\*(Aqs original rpcclient man page:
.PP
\fIWARNING!\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\*(Aqs implementation of these services has been demonstrated (and reported) to be\&.\&.\&. a bit flaky in places\&.
.PP
The development of Samba\*(Aqs 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 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\&.