docs/manpages-3/rpcclient.1.xml

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