docs/manpages/rpcclient.1.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
   3
   4 <!ENTITY % globalentities SYSTEM '../entities/global.entities'> %globalentities;
   5 ]>
   6 <refentry id="rpcclient.1">
   7
   8 <refmeta>
   9         <refentrytitle>rpcclient</refentrytitle>
  10         <manvolnum>1</manvolnum>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>rpcclient</refname>
  16         <refpurpose>tool for executing client side
  17         MS-RPC functions</refpurpose>
  18 </refnamediv>
  19
  20 <refsynopsisdiv>
  21         <cmdsynopsis>
  22                 <command>rpcclient</command>
  23                 <arg choice="opt">-A authfile</arg>
  24                 <arg choice="opt">-c &lt;command string&gt;</arg>
  25                 <arg choice="opt">-d debuglevel</arg>
  26                 <arg choice="opt">-h</arg>
  27                 <arg choice="opt">-l logdir</arg>
  28                 <arg choice="opt">-N</arg>
  29                 <arg choice="opt">-s &lt;smb config file&gt;</arg>
  30                 <arg choice="opt">-U username[%password]</arg>
  31                 <arg choice="opt">-W workgroup</arg>
  32                 <arg choice="opt">-N</arg>
  33                 <arg choice="opt">-I destinationIP</arg>
  34                 <arg choice="req">server</arg>
  35         </cmdsynopsis>
  36 </refsynopsisdiv>
  37
  38 <refsect1>
  39         <title>DESCRIPTION</title>
  40
  41         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  42         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  43
  44         <para><command>rpcclient</command> is a utility initially developed
  45         to test MS-RPC functionality in Samba itself.  It has undergone
  46         several stages of development and stability.  Many system administrators
  47         have now written scripts around it to manage Windows NT clients from
  48         their UNIX workstation. </para>
  49 </refsect1>
  50
  51
  52 <refsect1>
  53         <title>OPTIONS</title>
  54
  55         <variablelist>
  56                 <varlistentry>
  57                 <term>server</term>
  58                 <listitem><para>NetBIOS name of Server to which to connect.
  59                 The server can be  any SMB/CIFS server.  The name is
  60                 resolved using the <smbconfoption><name>name resolve order</name></smbconfoption> line from <citerefentry><refentrytitle>smb.conf</refentrytitle>
  61         <manvolnum>5</manvolnum></citerefentry>.</para></listitem>
  62         </varlistentry>
  63
  64
  65                 <varlistentry>
  66                 <term>-c|--command='command string'</term>
  67                 <listitem><para>execute semicolon separated commands (listed
  68                 below)) </para></listitem>
  69                 </varlistentry>
  70
  71
  72                 <varlistentry>
  73                 <term>-I IP-address</term>
  74                 <listitem><para><replaceable>IP address</replaceable> is the address of the server to connect to.
  75                 It should be specified in standard "a.b.c.d" notation. </para>
  76
  77                 <para>Normally the client would attempt to locate a named
  78                 SMB/CIFS server by looking it up via the NetBIOS name resolution
  79                 mechanism described above in the <parameter>name resolve order</parameter>
  80                 parameter above. Using this parameter will force the client
  81                 to assume that the server is on the machine with the specified IP
  82                 address and the NetBIOS name component of the resource being
  83                 connected to will be ignored. </para>
  84
  85                 <para>There is no default for this parameter. If not supplied,
  86                 it will be determined automatically by the client as described
  87                 above. </para></listitem>
  88                 </varlistentry>
  89
  90                 &popt.common.samba;
  91                 &popt.common.credentials;
  92                 &popt.common.connection;
  93                 &stdarg.help;
  94         </variablelist>
  95 </refsect1>
  96
  97
  98 <refsect1>
  99         <title>COMMANDS</title>
 100
 101         <refsect2>
 102         <title>LSARPC</title>
 103
 104         <variablelist>
 105                 <varlistentry><term>lsaquery</term><listitem><para>Query info policy</para></listitem></varlistentry>
 106
 107                 <varlistentry><term>lookupsids</term><listitem><para>Resolve a list
 108                 of SIDs to usernames.
 109                 </para></listitem></varlistentry>
 110
 111                 <varlistentry><term>lookupnames</term><listitem><para>Resolve a list
 112                 of usernames to SIDs.
 113                 </para></listitem></varlistentry>
 114
 115                 <varlistentry><term>enumtrusts</term><listitem><para>Enumerate trusted domains</para></listitem></varlistentry>
 116
 117                 <varlistentry><term>enumprivs</term><listitem><para>Enumerate privileges</para></listitem></varlistentry>
 118
 119                 <varlistentry><term>getdispname</term><listitem><para>Get the privilege name</para></listitem></varlistentry>
 120
 121                 <varlistentry><term>lsaenumsid</term><listitem><para>Enumerate the LSA SIDS</para></listitem></varlistentry>
 122
 123                 <varlistentry><term>lsaenumprivsaccount</term><listitem><para>Enumerate the privileges of an SID</para></listitem></varlistentry>
 124
 125                 <varlistentry><term>lsaenumacctrights</term><listitem><para>Enumerate the rights of an SID</para></listitem></varlistentry>
 126
 127                 <varlistentry><term>lsaenumacctwithright</term><listitem><para>Enumerate accounts with a right</para></listitem></varlistentry>
 128
 129                 <varlistentry><term>lsaaddacctrights</term><listitem><para>Add rights to an account</para></listitem></varlistentry>
 130
 131                 <varlistentry><term>lsaremoveacctrights</term><listitem><para>Remove rights from an account</para></listitem></varlistentry>
 132
 133                 <varlistentry><term>lsalookupprivvalue</term><listitem><para>Get a privilege value given its name</para></listitem></varlistentry>
 134
 135                 <varlistentry><term>lsaquerysecobj</term><listitem><para>Query LSA security object</para></listitem></varlistentry>
 136
 137         </variablelist>
 138         </refsect2>
 139
 140         <refsect2>
 141         <title>LSARPC-DS</title>
 142
 143         <variablelist>
 144                 <varlistentry><term>dsroledominfo</term><listitem><para>Get Primary Domain Information</para></listitem></varlistentry>
 145         </variablelist>
 146
 147         <para> </para>
 148
 149         <para><emphasis>DFS</emphasis></para>
 150         <variablelist>
 151                 <varlistentry><term>dfsexist</term><listitem><para>Query DFS support</para></listitem></varlistentry>
 152                 <varlistentry><term>dfsadd</term><listitem><para>Add a DFS share</para></listitem></varlistentry>
 153                 <varlistentry><term>dfsremove</term><listitem><para>Remove a DFS share</para></listitem></varlistentry>
 154                 <varlistentry><term>dfsgetinfo</term><listitem><para>Query DFS share info</para></listitem></varlistentry>
 155                 <varlistentry><term>dfsenum</term><listitem><para>Enumerate dfs shares</para></listitem></varlistentry>
 156         </variablelist>
 157
 158         </refsect2>
 159
 160         <refsect2>
 161         <title>REG</title>
 162         <variablelist>
 163                 <varlistentry><term>shutdown</term><listitem><para>Remote Shutdown</para></listitem></varlistentry>
 164                 <varlistentry><term>abortshutdown</term><listitem><para>Abort Shutdown</para></listitem></varlistentry>
 165         </variablelist>
 166
 167         </refsect2>
 168
 169         <refsect2>
 170         <title>SRVSVC</title>
 171
 172         <variablelist>
 173                 <varlistentry><term>srvinfo</term><listitem><para>Server query info</para></listitem></varlistentry>
 174
 175                 <varlistentry><term>netshareenum</term><listitem><para>Enumerate shares</para></listitem></varlistentry>
 176
 177                 <varlistentry><term>netfileenum</term><listitem><para>Enumerate open files</para></listitem></varlistentry>
 178
 179                 <varlistentry><term>netremotetod</term><listitem><para>Fetch remote time of day</para></listitem></varlistentry>
 180
 181         </variablelist>
 182
 183         </refsect2>
 184
 185         <refsect2>
 186         <title>SAMR</title>
 187
 188         <variablelist>
 189                 <varlistentry><term>queryuser</term><listitem><para>Query user info</para></listitem></varlistentry>
 190                 <varlistentry><term>querygroup</term><listitem><para>Query group info</para></listitem></varlistentry>
 191                 <varlistentry><term>queryusergroups</term><listitem><para>Query user groups</para></listitem></varlistentry>
 192                 <varlistentry><term>querygroupmem</term><listitem><para>Query group membership</para></listitem></varlistentry>
 193                 <varlistentry><term>queryaliasmem</term><listitem><para>Query alias membership</para></listitem></varlistentry>
 194                 <varlistentry><term>querydispinfo</term><listitem><para>Query display info</para></listitem></varlistentry>
 195                 <varlistentry><term>querydominfo</term><listitem><para>Query domain info</para></listitem></varlistentry>
 196                 <varlistentry><term>enumdomusers</term><listitem><para>Enumerate domain users</para></listitem></varlistentry>
 197                 <varlistentry><term>enumdomgroups</term><listitem><para>Enumerate domain groups</para></listitem></varlistentry>
 198                 <varlistentry><term>enumalsgroups</term><listitem><para>Enumerate alias groups</para></listitem></varlistentry>
 199                 <varlistentry><term>createdomuser</term><listitem><para>Create domain user</para></listitem></varlistentry>
 200                 <varlistentry><term>samlookupnames</term><listitem><para>Look up names</para></listitem></varlistentry>
 201                 <varlistentry><term>samlookuprids</term><listitem><para>Look up names</para></listitem></varlistentry>
 202                 <varlistentry><term>deletedomuser</term><listitem><para>Delete domain user</para></listitem></varlistentry>
 203                 <varlistentry><term>samquerysecobj</term><listitem><para>Query SAMR security object</para></listitem></varlistentry>
 204                 <varlistentry><term>getdompwinfo</term><listitem><para>Retrieve domain password info</para></listitem></varlistentry>
 205                 <varlistentry><term>lookupdomain</term><listitem><para>Look up domain</para></listitem></varlistentry>
 206         </variablelist>
 207
 208         </refsect2>
 209
 210         <refsect2>
 211         <title>SPOOLSS</title>
 212
 213         <variablelist>
 214                 <varlistentry><term>adddriver &lt;arch&gt; &lt;config&gt; [&lt;version&gt;]</term>
 215                 <listitem><para>
 216                 Execute an AddPrinterDriver() RPC to install the printer driver
 217                 information on the server.  Note that the driver files should
 218                 already exist in the directory returned by
 219                 <command>getdriverdir</command>.  Possible values for
 220                 <parameter>arch</parameter> are the same as those for
 221                 the <command>getdriverdir</command> command.
 222                 The <parameter>config</parameter> parameter is defined as
 223                 follows: </para>
 224
 225 <para><programlisting>
 226 Long Printer Name:\
 227 Driver File Name:\
 228 Data File Name:\
 229 Config File Name:\
 230 Help File Name:\
 231 Language Monitor Name:\
 232 Default Data Type:\
 233 Comma Separated list of Files
 234 </programlisting></para>
 235
 236                 <para>Any empty fields should be enter as the string "NULL". </para>
 237
 238                 <para>Samba does not need to support the concept of Print Monitors
 239                 since these only apply to local printers whose driver can make
 240                 use of a bi-directional link for communication.  This field should
 241                 be "NULL".   On a remote NT print server, the Print Monitor for a
 242                 driver must already be installed prior to adding the driver or
 243                 else the RPC will fail. </para>
 244
 245                 <para>The <parameter>version</parameter> parameter lets you
 246                 specify the printer driver version number.  If omitted, the
 247                 default driver version for the specified architecture will
 248                 be used.  This option can be used to upload Windows 2000
 249                 (version 3) printer drivers.</para></listitem></varlistentry>
 250
 251                 <varlistentry><term>addprinter &lt;printername&gt;
 252                 &lt;sharename&gt; &lt;drivername&gt; &lt;port&gt;</term>
 253                 <listitem><para>
 254                 Add a printer on the remote server.  This printer
 255                 will be automatically shared.  Be aware that the printer driver
 256                 must already be installed on the server (see <command>adddriver</command>)
 257                 and the <parameter>port</parameter>must be a valid port name (see
 258                 <command>enumports</command>.</para>
 259                 </listitem></varlistentry>
 260
 261
 262                 <varlistentry><term>deldriver</term><listitem><para>Delete the
 263                 specified printer driver for all architectures.  This
 264                 does not delete the actual driver files from the server,
 265                 only the entry from the server's list of drivers.
 266                 </para></listitem></varlistentry>
 267
 268                 <varlistentry><term>deldriverex &lt;driver&gt; [architecture] [version]
 269                 </term><listitem><para>Delete the specified printer driver including driver files.
 270                 You can limit this action to a specific architecture and a specific version.
 271                 If no architecure is given, all driver files of that driver will be deleted.
 272                 </para></listitem></varlistentry>
 273
 274                 <varlistentry><term>enumdata</term><listitem><para>Enumerate all
 275                 printer setting data stored on the server. On Windows NT  clients,
 276                 these values are stored  in the registry, while Samba servers
 277                 store them in the printers TDB.  This command corresponds
 278                 to the MS Platform SDK GetPrinterData() function (* This
 279                 command is currently unimplemented).</para></listitem></varlistentry>
 280
 281                 <varlistentry><term>enumdataex</term><listitem><para>Enumerate printer data for a key</para></listitem></varlistentry>
 282
 283                 <varlistentry><term>enumjobs &lt;printer&gt;</term>
 284                 <listitem><para>List the jobs and status of a given printer.
 285                 This command corresponds to the MS Platform SDK EnumJobs()
 286                 function</para></listitem></varlistentry>
 287
 288                 <varlistentry><term>enumkey</term><listitem><para>Enumerate
 289                 printer keys</para></listitem></varlistentry>
 290
 291                 <varlistentry><term>enumports [level]</term>
 292                 <listitem><para>
 293                 Executes an EnumPorts() call using the specified
 294                 info level. Currently only info levels 1 and 2 are supported.
 295                 </para></listitem></varlistentry>
 296
 297
 298
 299                 <varlistentry><term>enumdrivers [level]</term>
 300                 <listitem><para>
 301                 Execute an EnumPrinterDrivers() call.  This lists the various installed
 302                 printer drivers for all architectures.  Refer to the MS Platform SDK
 303                 documentation for more details of the various flags and calling
 304                 options. Currently supported info levels are 1, 2, and 3.</para></listitem></varlistentry>
 305
 306
 307
 308                 <varlistentry><term>enumprinters [level]</term>
 309                 <listitem><para>Execute an EnumPrinters() call.  This lists the various installed
 310                 and share printers.  Refer to the MS Platform SDK documentation for
 311                 more details of the various flags and calling options. Currently
 312                 supported info levels are 1, 2 and 5.</para></listitem></varlistentry>
 313
 314
 315
 316
 317                 <varlistentry><term>getdata &lt;printername&gt; &lt;valuename;&gt;</term>
 318                 <listitem><para>Retrieve the data for a given printer setting.  See
 319                 the  <command>enumdata</command> command for more information.
 320                 This command corresponds to the GetPrinterData() MS Platform
 321                 SDK function. </para></listitem></varlistentry>
 322
 323                 <varlistentry><term>getdataex</term><listitem><para>Get
 324                 printer driver data with
 325                 keyname</para></listitem></varlistentry>
 326
 327
 328                 <varlistentry><term>getdriver &lt;printername&gt;</term>
 329                 <listitem><para>
 330                 Retrieve the printer driver information (such as driver file,
 331                 config file, dependent files, etc...) for
 332                 the given printer. This command corresponds to the GetPrinterDriver()
 333                 MS Platform  SDK function. Currently info level 1, 2, and 3 are supported.
 334                 </para></listitem></varlistentry>
 335
 336
 337                 <varlistentry><term>getdriverdir &lt;arch&gt;</term>
 338                 <listitem><para>
 339                 Execute a GetPrinterDriverDirectory()
 340                 RPC to retrieve the SMB share name and subdirectory for
 341                 storing printer driver files for a given architecture.  Possible
 342                 values for <parameter>arch</parameter> are "Windows 4.0"
 343                 (for Windows 95/98), "Windows NT x86", "Windows NT PowerPC", "Windows
 344                 Alpha_AXP", and "Windows NT R4000". </para></listitem></varlistentry>
 345
 346
 347
 348                 <varlistentry><term>getprinter &lt;printername&gt;</term>
 349                 <listitem><para>Retrieve the current printer information.  This command
 350                 corresponds to the GetPrinter() MS Platform SDK function.
 351                 </para></listitem></varlistentry>
 352
 353                 <varlistentry><term>getprintprocdir</term><listitem><para>Get
 354                 print processor
 355                 directory</para></listitem></varlistentry>
 356
 357                 <varlistentry><term>openprinter &lt;printername&gt;</term>
 358                 <listitem><para>Execute an OpenPrinterEx() and ClosePrinter() RPC
 359                 against a given printer. </para></listitem></varlistentry>
 360
 361                 <varlistentry><term>setdriver &lt;printername&gt;
 362                 &lt;drivername&gt;</term>
 363                 <listitem><para>Execute a SetPrinter() command to update the printer driver
 364                 associated with an installed printer.  The printer driver must
 365                 already be correctly installed on the print server.  </para>
 366
 367                 <para>See also the <command>enumprinters</command> and
 368                 <command>enumdrivers</command> commands for obtaining a list of
 369                 of installed printers and drivers.</para></listitem></varlistentry>
 370
 371                 <varlistentry><term>addform</term><listitem><para>Add form</para></listitem></varlistentry>
 372                 <varlistentry><term>setform</term><listitem><para>Set form</para></listitem></varlistentry>
 373                 <varlistentry><term>getform</term><listitem><para>Get form</para></listitem></varlistentry>
 374                 <varlistentry><term>deleteform</term><listitem><para>Delete form</para></listitem></varlistentry>
 375                 <varlistentry><term>enumforms</term><listitem><para>Enumerate form</para></listitem></varlistentry>
 376                 <varlistentry><term>setprinter</term><listitem><para>Set printer comment</para></listitem></varlistentry>
 377                 <varlistentry><term>setprinterdata</term><listitem><para>Set REG_SZ printer data</para></listitem></varlistentry>
 378
 379                 <varlistentry><term>setprintername &lt;printername&gt;
 380                 &lt;newprintername&gt;</term>
 381                 <listitem><para>Set printer name</para></listitem></varlistentry>
 382
 383                 <varlistentry><term>rffpcnex</term><listitem><para>Rffpcnex test</para></listitem></varlistentry>
 384
 385
 386         </variablelist>
 387
 388         </refsect2>
 389
 390         <refsect2>
 391         <title>NETLOGON</title>
 392
 393         <variablelist>
 394
 395         <varlistentry><term>logonctrl2</term>
 396         <listitem><para>Logon Control 2</para></listitem>
 397         </varlistentry>
 398
 399         <varlistentry><term>logonctrl</term>
 400         <listitem><para>Logon Control</para></listitem>
 401         </varlistentry>
 402
 403         <varlistentry><term>samsync</term>
 404         <listitem><para>Sam Synchronisation</para></listitem>
 405         </varlistentry>
 406
 407         <varlistentry><term>samdeltas</term>
 408         <listitem><para>Query Sam Deltas</para></listitem>
 409         </varlistentry>
 410
 411         <varlistentry><term>samlogon</term>
 412         <listitem><para>Sam Logon</para></listitem>
 413         </varlistentry>
 414
 415         </variablelist>
 416         </refsect2>
 417
 418         <refsect2>
 419         <title>GENERAL COMMANDS</title>
 420
 421         <variablelist>
 422                 <varlistentry><term>debuglevel</term><listitem><para>Set the current
 423                 debug level used to log information.</para></listitem></varlistentry>
 424
 425                 <varlistentry><term>help (?)</term><listitem><para>Print a listing of all
 426                 known commands or extended help  on a particular command.
 427                 </para></listitem></varlistentry>
 428
 429                 <varlistentry><term>quit (exit)</term><listitem><para>Exit <command>rpcclient
 430                 </command>.</para></listitem></varlistentry>
 431         </variablelist>
 432         </refsect2>
 433
 434 </refsect1>
 435
 436 <refsect1>
 437         <title>BUGS</title>
 438
 439         <para><command>rpcclient</command> is designed as a developer testing tool
 440         and may not be robust in certain areas (such as command line parsing).
 441         It has been known to  generate a core dump upon failures when invalid
 442         parameters where passed to the interpreter. </para>
 443
 444         <para>From Luke Leighton's original rpcclient man page:</para>
 445
 446         <para><emphasis>WARNING!</emphasis> The MSRPC over SMB code has
 447         been developed from examining  Network traces. No documentation is
 448         available from the original creators  (Microsoft) on how MSRPC over
 449         SMB works, or how the individual MSRPC services  work. Microsoft's
 450         implementation of these services has been demonstrated  (and reported)
 451         to be... a bit flaky in places. </para>
 452
 453         <para>The development of Samba's implementation is also a bit rough,
 454         and as more of the services are understood, it can even result in
 455         versions of <citerefentry><refentrytitle>smbd</refentrytitle>
 456         <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>rpcclient</refentrytitle>
 457         <manvolnum>1</manvolnum></citerefentry> that are incompatible for some commands or  services. Additionally,
 458         the developers are sending reports to Microsoft,  and problems found
 459         or reported to Microsoft are fixed in Service Packs,  which may
 460         result in incompatibilities.</para>
 461 </refsect1>
 462
 463
 464 <refsect1>
 465         <title>VERSION</title>
 466
 467         <para>This man page is correct for version 3.0 of the Samba
 468         suite.</para>
 469 </refsect1>
 470
 471 <refsect1>
 472         <title>AUTHOR</title>
 473
 474         <para>The original Samba software and related utilities
 475         were created by Andrew Tridgell. Samba is now developed
 476         by the Samba Team as an Open Source project similar
 477         to the way the Linux kernel is developed.</para>
 478
 479         <para>The original rpcclient man page was written by Matthew
 480         Geddes, Luke Kenneth Casson Leighton, and rewritten by Gerald Carter.
 481         The conversion to DocBook for Samba 2.2 was done by Gerald
 482         Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was
 483         done by Alexander Bokovoy.</para>
 484 </refsect1>
 485
 486 </refentry>