source: branches/samba-3.2.x/docs/manpages/rpcclient.1@ 204

.\"     Title: rpcclient
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
.\"      Date: 09/18/2008
.\"    Manual: User Commands
.\"    Source: Samba 3.2
.\"
.TH "RPCCLIENT" "1" "09/18/2008" "Samba 3\.2" "User Commands"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
rpcclient - tool for executing client side MS-RPC functions
.SH "SYNOPSIS"
.HP 1
rpcclient [\-A\ authfile] [\-c\ <command\ string>] [\-d\ debuglevel] [\-h] [\-l\ logdir] [\-N] [\-s\ <smb\ config\ file>] [\-U\ username[%password]] [\-W\ workgroup] [\-N] [\-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
\fIname resolve order\fR
line from
\fBsmb.conf\fR(5)\.
.RE
.PP
\-c|\-\-command=\'command string\'
.RS 4
execute semicolon separated commands (listed below))
.RE
.PP
\-I 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
\-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
\fIlog level\fR
parameter in the
\fIsmb\.conf\fR
file\.
.RE
.PP
\-V
.RS 4
Prints the program version number\.
.RE
.PP
\-s <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
\fIsmb\.conf\fR
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
\-N
.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
.RS 4
Try to authenticate with kerberos\. Only useful in an Active Directory environment\.
.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
.sp
.RS 4
.nf
username = <value>
password = <value>
domain   = <value>
.fi
.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
\-n <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
\fInetbios name\fR
parameter in the
\fIsmb\.conf\fR
file\. However, a command line setting will take precedence over settings in
\fIsmb\.conf\fR\.
.RE
.PP
\-i <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
.RS 4
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\.
.RE
.PP
\-h|\-\-help
.RS 4
Print a summary of command line options\.
.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
enumtrusts
.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
.sp