docs/htmldocs/rpcclient.1.html

   1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>rpcclient</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.60.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="rpcclient.1"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>Name</h2><p>rpcclient &#8212; tool for executing client side
   2         MS-RPC functions</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt class="command">rpcclient</tt>  [-A authfile] [-c &lt;command string&gt;] [-d debuglevel] [-h] [-l logfile] [-N] [-s &lt;smb config file&gt;] [-U username[%password]] [-W workgroup] [-N] [-I destinationIP] {server}</p></div></div><div class="refsect1" lang="en"><h2>DESCRIPTION</h2><p>This tool is part of the <a href="Samba.7.html"><span class="citerefentry"><span class="refentrytitle">Samba</span>(7)</span></a> suite.</p><p><b class="command">rpcclient</b> is a utility initially developed
   3         to test MS-RPC functionality in Samba itself.  It has undergone
   4         several stages of development and stability.  Many system administrators
   5         have now written scripts around it to manage Windows NT clients from
   6         their UNIX workstation. </p></div><div class="refsect1" lang="en"><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">server</span></dt><dd><p>NetBIOS name of Server to which to connect.
   7                 The server can be  any SMB/CIFS server.  The name is
   8                 resolved using the <a href="smb.conf.5.html#NAMERESOLVEORDER" target="_top">
   9                 <i class="parameter"><tt>name resolve order</tt></i></a> line from <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a>.</p></dd><dt><span class="term">-c|--command='command string'</span></dt><dd><p>execute semicolon separated commands (listed
  10                 below)) </p></dd><dt><span class="term">-I IP-address</span></dt><dd><p><i class="replaceable"><tt>IP address</tt></i> is the address of the server to connect to.
  11                 It should be specified in standard &quot;a.b.c.d&quot; notation. </p><p>Normally the client would attempt to locate a named
  12                 SMB/CIFS server by looking it up via the NetBIOS name resolution
  13                 mechanism described above in the <i class="parameter"><tt>name resolve order</tt></i>
  14                 parameter above. Using this parameter will force the client
  15                 to assume that the server is on the machine with the specified IP
  16                 address and the NetBIOS name component of the resource being
  17                 connected to will be ignored. </p><p>There is no default for this parameter. If not supplied,
  18                 it will be determined automatically by the client as described
  19                 above. </p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the version number for
  20 <b class="command">smbd</b>.</p></dd><dt><span class="term">-s &lt;configuration file&gt;</span></dt><dd><p>The file specified contains the
  21 configuration details required by the server.  The
  22 information in this file includes server-specific
  23 information such as what printcap file to use, as well
  24 as descriptions of all the services that the server is
  25 to provide. See <a href="smb.conf.5.html" target="_top"><tt class="filename">
  26 smb.conf(5)</tt></a> for more information.
  27 The default configuration file name is determined at
  28 compile time.</p></dd><dt><span class="term">-d|--debug=debuglevel</span></dt><dd><p><i class="replaceable"><tt>debuglevel</tt></i> is an integer
  29 from 0 to 10.  The default value if this parameter is
  30 not specified is zero.</p><p>The higher this value, the more detail will be
  31 logged to the log files about the activities of the
  32 server. At level 0, only critical errors and serious
  33 warnings will be logged. Level 1 is a reasonable level for
  34 day to day running - it generates a small amount of
  35 information about operations carried out.</p><p>Levels above 1 will generate considerable
  36 amounts of log data, and should only be used when
  37 investigating a problem. Levels above 3 are designed for
  38 use only by developers and generate HUGE amounts of log
  39 data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will
  40 override the <a href="smb.conf.5.html#loglevel" target="_top">log
  41 level</a> parameter in the <a href="smb.conf.5.html" target="_top">
  42 <tt class="filename">smb.conf(5)</tt></a> file.</p></dd><dt><span class="term">-l|--logfile=logbasename</span></dt><dd><p>File name for log/debug files. The extension
  43 <tt class="constant">&quot;.client&quot;</tt> will be appended. The log file is
  44 never removed by the client.
  45 </p></dd><dt><span class="term">-N</span></dt><dd><p>If specified, this parameter suppresses the normal
  46 password prompt from the client to the user. This is useful when
  47 accessing a service that does not require a password. </p><p>Unless a password is specified on the command line or
  48 this parameter is specified, the client will request a
  49 password.</p></dd><dt><span class="term">-k</span></dt><dd><p>
  50 Try to authenticate with kerberos. Only useful in
  51 an Active Directory environment.
  52 </p></dd><dt><span class="term">-A|--authfile=filename</span></dt><dd><p>This option allows
  53 you to specify a file from which to read the username and
  54 password used in the connection.  The format of the file is
  55 </p><pre class="programlisting">
  56 username = &lt;value&gt;
  57 password = &lt;value&gt;
  58 domain   = &lt;value&gt;
  59 </pre><p>Make certain that the permissions on the file restrict
  60 access from unwanted users. </p></dd><dt><span class="term">-U|--user=username[%password]</span></dt><dd><p>Sets the SMB username or username and password. </p><p>If %password is not specified, the user will be prompted. The
  61 client will first check the <tt class="envar">USER</tt> environment variable, then the
  62 <tt class="envar">LOGNAME</tt> variable and if either exists, the
  63 string is uppercased. If these environmental variables are not
  64 found, the username <tt class="constant">GUEST</tt> is used. </p><p>A third option is to use a credentials file which
  65 contains the plaintext of the username and password.  This
  66 option is mainly provided for scripts where the admin does not
  67 wish to pass the credentials on the command line or via environment
  68 variables. If this method is used, make certain that the permissions
  69 on the file restrict access from unwanted users.  See the
  70 <i class="parameter"><tt>-A</tt></i> for more details. </p><p>Be cautious about including passwords in scripts. Also, on
  71 many systems the command line of a running process may be seen
  72 via the <b class="command">ps</b> command.  To be safe always allow
  73 <b class="command">rpcclient</b> to prompt for a password and type
  74 it in directly. </p></dd><dt><span class="term">-n &lt;primary NetBIOS name&gt;</span></dt><dd><p>This option allows you to override
  75 the NetBIOS name that Samba uses for itself. This is identical
  76 to setting the <a href="smb.conf.5.html#netbiosname" target="_top"><i class="parameter"><tt>NetBIOS
  77 name</tt></i></a> parameter in the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file.  However, a command
  78 line setting will take precedence over settings in
  79 <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a>.</p></dd><dt><span class="term">-i &lt;scope&gt;</span></dt><dd><p>This specifies a NetBIOS scope that
  80 <b class="command">nmblookup</b> will use to communicate with when
  81 generating NetBIOS names. For details on the use of NetBIOS
  82 scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are
  83 <span class="emphasis"><em>very</em></span> rarely used, only set this parameter
  84 if you are the system administrator in charge of all the
  85 NetBIOS systems you communicate with.</p></dd><dt><span class="term">-W|--workgroup=domain</span></dt><dd><p>Set the SMB domain of the username.   This
  86 overrides the default domain which is the domain defined in
  87 smb.conf.  If the domain specified is the same as the servers
  88 NetBIOS name, it causes the client to log on using the servers local
  89 SAM (as opposed to the Domain SAM). </p></dd><dt><span class="term">-O socket options</span></dt><dd><p>TCP socket options to set on the client
  90 socket. See the socket options parameter in
  91 the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> manual page for the list of valid
  92 options. </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options.
  93 </p></dd></dl></div></div><div class="refsect1" lang="en"><h2>COMMANDS</h2><div class="refsect2" lang="en"><h3>LSARPC</h3><div class="variablelist"><dl><dt><span class="term">lsaquery</span></dt><dd><p>Query info policy</p></dd><dt><span class="term">lookupsids</span></dt><dd><p>Resolve a list
  94                 of SIDs to usernames.
  95                 </p></dd><dt><span class="term">lookupnames</span></dt><dd><p>Resolve a list
  96                 of usernames to SIDs.
  97                 </p></dd><dt><span class="term">enumtrusts</span></dt><dd><p>Enumerate trusted domains</p></dd><dt><span class="term">enumprivs</span></dt><dd><p>Enumerate privileges</p></dd><dt><span class="term">getdispname</span></dt><dd><p>Get the privilege name</p></dd><dt><span class="term">lsaenumsid</span></dt><dd><p>Enumerate the LSA SIDS</p></dd><dt><span class="term">lsaenumprivsaccount</span></dt><dd><p>Enumerate the privileges of an SID</p></dd><dt><span class="term">lsaenumacctrights</span></dt><dd><p>Enumerate the rights of an SID</p></dd><dt><span class="term">lsaenumacctwithright</span></dt><dd><p>Enumerate accounts with a right</p></dd><dt><span class="term">lsaaddacctrights</span></dt><dd><p>Add rights to an account</p></dd><dt><span class="term">lsaremoveacctrights</span></dt><dd><p>Remove rights from an account</p></dd><dt><span class="term">lsalookupprivvalue</span></dt><dd><p>Get a privilege value given its name</p></dd><dt><span class="term">lsaquerysecobj</span></dt><dd><p>Query LSA security object</p></dd></dl></div></div><div class="refsect2" lang="en"><h3>LSARPC-DS</h3><div class="variablelist"><dl><dt><span class="term">dsroledominfo</span></dt><dd><p>Get Primary Domain Information</p></dd></dl></div><p> </p><p><span class="emphasis"><em>DFS</em></span></p><div class="variablelist"><dl><dt><span class="term">dfsexist</span></dt><dd><p>Query DFS support</p></dd><dt><span class="term">dfsadd</span></dt><dd><p>Add a DFS share</p></dd><dt><span class="term">dfsremove</span></dt><dd><p>Remove a DFS share</p></dd><dt><span class="term">dfsgetinfo</span></dt><dd><p>Query DFS share info</p></dd><dt><span class="term">dfsenum</span></dt><dd><p>Enumerate dfs shares</p></dd></dl></div></div><div class="refsect2" lang="en"><h3>REG</h3><div class="variablelist"><dl><dt><span class="term">shutdown</span></dt><dd><p>Remote Shutdown</p></dd><dt><span class="term">abortshutdown</span></dt><dd><p>Abort Shutdown</p></dd></dl></div></div><div class="refsect2" lang="en"><h3>SRVSVC</h3><div class="variablelist"><dl><dt><span class="term">srvinfo</span></dt><dd><p>Server query info</p></dd><dt><span class="term">netshareenum</span></dt><dd><p>Enumerate shares</p></dd><dt><span class="term">netfileenum</span></dt><dd><p>Enumerate open files</p></dd><dt><span class="term">netremotetod</span></dt><dd><p>Fetch remote time of day</p></dd></dl></div></div><div class="refsect2" lang="en"><h3>SAMR</h3><div class="variablelist"><dl><dt><span class="term">queryuser</span></dt><dd><p>Query user info</p></dd><dt><span class="term">querygroup</span></dt><dd><p>Query group info</p></dd><dt><span class="term">queryusergroups</span></dt><dd><p>Query user groups</p></dd><dt><span class="term">querygroupmem</span></dt><dd><p>Query group membership</p></dd><dt><span class="term">queryaliasmem</span></dt><dd><p>Query alias membership</p></dd><dt><span class="term">querydispinfo</span></dt><dd><p>Query display info</p></dd><dt><span class="term">querydominfo</span></dt><dd><p>Query domain info</p></dd><dt><span class="term">enumdomusers</span></dt><dd><p>Enumerate domain users</p></dd><dt><span class="term">enumdomgroups</span></dt><dd><p>Enumerate domain groups</p></dd><dt><span class="term">enumalsgroups</span></dt><dd><p>Enumerate alias groups</p></dd><dt><span class="term">createdomuser</span></dt><dd><p>Create domain user</p></dd><dt><span class="term">samlookupnames</span></dt><dd><p>Look up names</p></dd><dt><span class="term">samlookuprids</span></dt><dd><p>Look up names</p></dd><dt><span class="term">deletedomuser</span></dt><dd><p>Delete domain user</p></dd><dt><span class="term">samquerysecobj</span></dt><dd><p>Query SAMR security object</p></dd><dt><span class="term">getdompwinfo</span></dt><dd><p>Retrieve domain password info</p></dd><dt><span class="term">lookupdomain</span></dt><dd><p>Look up domain</p></dd></dl></div></div><div class="refsect2" lang="en"><h3>SPOOLSS</h3><div class="variablelist"><dl><dt><span class="term">adddriver &lt;arch&gt; &lt;config&gt;</span></dt><dd><p>
  98                 Execute an AddPrinterDriver() RPC to install the printer driver
  99                 information on the server.  Note that the driver files should
 100                 already exist in the directory returned by
 101                 <b class="command">getdriverdir</b>.  Possible values for
 102                 <i class="parameter"><tt>arch</tt></i> are the same as those for
 103                 the <b class="command">getdriverdir</b> command.
 104                 The <i class="parameter"><tt>config</tt></i> parameter is defined as
 105                 follows: </p><pre class="programlisting">
 106 Long Printer Name:\
 107 Driver File Name:\
 108 Data File Name:\
 109 Config File Name:\
 110 Help File Name:\
 111 Language Monitor Name:\
 112 Default Data Type:\
 113 Comma Separated list of Files
 114 </pre><p>Any empty fields should be enter as the string &quot;NULL&quot;. </p><p>Samba does not need to support the concept of Print Monitors
 115                 since these only apply to local printers whose driver can make
 116                 use of a bi-directional link for communication.  This field should
 117                 be &quot;NULL&quot;.   On a remote NT print server, the Print Monitor for a
 118                 driver must already be installed prior to adding the driver or
 119                 else the RPC will fail. </p></dd><dt><span class="term">addprinter &lt;printername&gt;
 120                 &lt;sharename&gt; &lt;drivername&gt; &lt;port&gt;</span></dt><dd><p>
 121                 Add a printer on the remote server.  This printer
 122                 will be automatically shared.  Be aware that the printer driver
 123                 must already be installed on the server (see <b class="command">adddriver</b>)
 124                 and the <i class="parameter"><tt>port</tt></i>must be a valid port name (see
 125                 <b class="command">enumports</b>.</p></dd><dt><span class="term">deldriver</span></dt><dd><p>Delete the
 126                 specified printer driver for all architectures.  This
 127                 does not delete the actual driver files from the server,
 128                 only the entry from the server's list of drivers.
 129                 </p></dd><dt><span class="term">enumdata</span></dt><dd><p>Enumerate all
 130                 printer setting data stored on the server. On Windows NT  clients,
 131                 these values are stored  in the registry, while Samba servers
 132                 store them in the printers TDB.  This command corresponds
 133                 to the MS Platform SDK GetPrinterData() function (* This
 134                 command is currently unimplemented).</p></dd><dt><span class="term">enumdataex</span></dt><dd><p>Enumerate printer data for a key</p></dd><dt><span class="term">enumjobs &lt;printer&gt;</span></dt><dd><p>List the jobs and status of a given printer.
 135                 This command corresponds to the MS Platform SDK EnumJobs()
 136                 function</p></dd><dt><span class="term">enumkey</span></dt><dd><p>Enumerate
 137                 printer keys</p></dd><dt><span class="term">enumports [level]</span></dt><dd><p>
 138                 Executes an EnumPorts() call using the specified
 139                 info level. Currently only info levels 1 and 2 are supported.
 140                 </p></dd><dt><span class="term">enumdrivers [level]</span></dt><dd><p>
 141                 Execute an EnumPrinterDrivers() call.  This lists the various installed
 142                 printer drivers for all architectures.  Refer to the MS Platform SDK
 143                 documentation for more details of the various flags and calling
 144                 options. Currently supported info levels are 1, 2, and 3.</p></dd><dt><span class="term">enumprinters [level]</span></dt><dd><p>Execute an EnumPrinters() call.  This lists the various installed
 145                 and share printers.  Refer to the MS Platform SDK documentation for
 146                 more details of the various flags and calling options. Currently
 147                 supported info levels are 1, 2 and 5.</p></dd><dt><span class="term">getdata &lt;printername&gt; &lt;valuename;&gt;</span></dt><dd><p>Retrieve the data for a given printer setting.  See
 148                 the  <b class="command">enumdata</b> command for more information.
 149                 This command corresponds to the GetPrinterData() MS Platform
 150                 SDK function. </p></dd><dt><span class="term">getdataex</span></dt><dd><p>Get
 151                 printer driver data with
 152                 keyname</p></dd><dt><span class="term">getdriver &lt;printername&gt;</span></dt><dd><p>
 153                 Retrieve the printer driver information (such as driver file,
 154                 config file, dependent files, etc...) for
 155                 the given printer. This command corresponds to the GetPrinterDriver()
 156                 MS Platform  SDK function. Currently info level 1, 2, and 3 are supported.
 157                 </p></dd><dt><span class="term">getdriverdir &lt;arch&gt;</span></dt><dd><p>
 158                 Execute a GetPrinterDriverDirectory()
 159                 RPC to retrieve the SMB share name and subdirectory for
 160                 storing printer driver files for a given architecture.  Possible
 161                 values for <i class="parameter"><tt>arch</tt></i> are &quot;Windows 4.0&quot;
 162                 (for Windows 95/98), &quot;Windows NT x86&quot;, &quot;Windows NT PowerPC&quot;, &quot;Windows
 163                 Alpha_AXP&quot;, and &quot;Windows NT R4000&quot;. </p></dd><dt><span class="term">getprinter &lt;printername&gt;</span></dt><dd><p>Retrieve the current printer information.  This command
 164                 corresponds to the GetPrinter() MS Platform SDK function.
 165                 </p></dd><dt><span class="term">getprintprocdir</span></dt><dd><p>Get
 166                 print processor
 167                 directory</p></dd><dt><span class="term">openprinter &lt;printername&gt;</span></dt><dd><p>Execute an OpenPrinterEx() and ClosePrinter() RPC
 168                 against a given printer. </p></dd><dt><span class="term">setdriver &lt;printername&gt;
 169                 &lt;drivername&gt;</span></dt><dd><p>Execute a SetPrinter() command to update the printer driver
 170                 associated with an installed printer.  The printer driver must
 171                 already be correctly installed on the print server.  </p><p>See also the <b class="command">enumprinters</b> and
 172                 <b class="command">enumdrivers</b> commands for obtaining a list of
 173                 of installed printers and drivers.</p></dd><dt><span class="term">addform</span></dt><dd><p>Add form</p></dd><dt><span class="term">setform</span></dt><dd><p>Set form</p></dd><dt><span class="term">getform</span></dt><dd><p>Get form</p></dd><dt><span class="term">deleteform</span></dt><dd><p>Delete form</p></dd><dt><span class="term">enumforms</span></dt><dd><p>Enumerate form</p></dd><dt><span class="term">setprinter</span></dt><dd><p>Set printer comment</p></dd><dt><span class="term">setprinterdata</span></dt><dd><p>Set REG_SZ printer data</p></dd><dt><span class="term">rffpcnex</span></dt><dd><p>Rffpcnex test</p></dd></dl></div></div><div class="refsect2" lang="en"><h3>NETLOGON</h3><div class="variablelist"><dl><dt><span class="term">logonctrl2</span></dt><dd><p>Logon Control 2</p></dd><dt><span class="term">logonctrl</span></dt><dd><p>Logon Control</p></dd><dt><span class="term">samsync</span></dt><dd><p>Sam Synchronisation</p></dd><dt><span class="term">samdeltas</span></dt><dd><p>Query Sam Deltas</p></dd><dt><span class="term">samlogon</span></dt><dd><p>Sam Logon</p></dd></dl></div></div><div class="refsect2" lang="en"><h3>GENERAL COMMANDS</h3><div class="variablelist"><dl><dt><span class="term">debuglevel</span></dt><dd><p>Set the current
 174                 debug level used to log information.</p></dd><dt><span class="term">help (?)</span></dt><dd><p>Print a listing of all
 175                 known commands or extended help  on a particular command.
 176                 </p></dd><dt><span class="term">quit (exit)</span></dt><dd><p>Exit <b class="command">rpcclient
 177                 </b>.</p></dd></dl></div></div></div><div class="refsect1" lang="en"><h2>BUGS</h2><p><b class="command">rpcclient</b> is designed as a developer testing tool
 178         and may not be robust in certain areas (such as command line parsing).
 179         It has been known to  generate a core dump upon failures when invalid
 180         parameters where passed to the interpreter. </p><p>From Luke Leighton's original rpcclient man page:</p><p><span class="emphasis"><em>WARNING!</em></span> The MSRPC over SMB code has
 181         been developed from examining  Network traces. No documentation is
 182         available from the original creators  (Microsoft) on how MSRPC over
 183         SMB works, or how the individual MSRPC services  work. Microsoft's
 184         implementation of these services has been demonstrated  (and reported)
 185         to be... a bit flaky in places. </p><p>The development of Samba's implementation is also a bit rough,
 186         and as more of the services are understood, it can even result in
 187         versions of <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> and <a href="rpcclient.1.html"><span class="citerefentry"><span class="refentrytitle">rpcclient</span>(1)</span></a> that are incompatible for some commands or  services. Additionally,
 188         the developers are sending reports to Microsoft,  and problems found
 189         or reported to Microsoft are fixed in Service Packs,  which may
 190         result in incompatibilities.</p></div><div class="refsect1" lang="en"><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba
 191         suite.</p></div><div class="refsect1" lang="en"><h2>AUTHOR</h2><p>The original Samba software and related utilities
 192         were created by Andrew Tridgell. Samba is now developed
 193         by the Samba Team as an Open Source project similar
 194         to the way the Linux kernel is developed.</p><p>The original rpcclient man page was written by Matthew
 195         Geddes, Luke Kenneth Casson Leighton, and rewritten by Gerald Carter.
 196         The conversion to DocBook for Samba 2.2 was done by Gerald
 197         Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was
 198         done by Alexander Bokovoy.</p></div></div></body></html>