path: root/docs/docbook/manpages/rpcclient.1.sgml

<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
<refentry id="rpcclient">

<refmeta>
	<refentrytitle>rpcclient</refentrytitle>
	<manvolnum>1</manvolnum>
</refmeta>


<refnamediv>
	<refname>rpcclient</refname>
	<refpurpose>developer's tool to testing client side 
	MS-RPC functions</refpurpose>
</refnamediv>

<refsynopsisdiv>
	<cmdsynopsis>
		<command>nmblookup</command>
		<arg choice="opt">-d debuglevel</arg>
		<arg choice="opt">-S server</arg>
		<arg choice="opt">-U username</arg>
		<arg choice="opt">-W workgroup</arg>
		<arg choice="opt">-n &lt;netbios name&gt;</arg>
		<arg choice="opt">-A authfile</arg>
		<arg choice="opt">-N</arg>
		<arg choice="opt">-l logfile</arg>
		<arg choice="opt">-I destinationIP</arg>
		<arg choice="opt">-E &lt;terminal code&gt;</arg>
		<arg choice="opt">-c &lt;command string&gt;</arg>
		<arg choice="opt">-i scope</arg>
		<arg choice="opt">-O &lt;socket options&gt;</arg>
		<arg choice="opt">-s &lt;smb config file&gt;</arg>
	</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
	<title>DESCRIPTION</title>

	<para>This tool is part of the <ulink url="samba.7.html">
	Samba</ulink> suite.</para>

	<para><command>rpcclient</command> is a utility for developers for 
	executing various MS-RPC functions.  It's primary use is for testing 
	Samba's own MS-RPC server implementation, however many administrators
	have written scripts around it to manage Windows NT clients from 
	their UNIX workstation. </para>
</refsect1>


<refsect1>
	<title>OPTIONS</title>

	<variablelist>
		<varlistentry>
		<term>-d debuglevel</term>
		<listitem><para>set the debuglevel. Debug level 0 is the lowest 
		and 100 being the highest. This should be set to 100 if you are
		planning on submitting a bug report to the Samba team 
		(see BUGS.txt). </para></listitem>
		</varlistentry>
		
		
		<varlistentry>
		<term>-S server</term>
		<listitem><para>NetBIOS name of Server to which you wish to 
		connect. The server can be  any SMB/CIFS server. The name is 
		resolved using either the <parameter>name resolve order</parameter> 
		line or by using the -R option. </para></listitem>
		</varlistentry>
		
		
		<varlistentry>
		<term>-l logbasename</term>
		<listitem><para>File name for log/debug files. .client will be 
		appended. The log file is never removed  by the client.
		</para></listitem>
		</varlistentry>


		<varlistentry>
		<term>-n netbios name</term><listitem><para>NetBIOS name of the 
		local machine. This option is only needed if your Samba client 
		cannot find it automatically. Samba should use the uppercase 
		of the machine's hostname. </para></listitem>
		</varlistentry>
		
		<varlistentry>
		<term>-N</term>
		<listitem><para>tells rpcclient not to ask for a password. 
		<command>rpcclient</command> will prompt the user by default. 
		</para></listitem>
		</varlistentry>
		
		
		<varlistentry>
		<term>-I destinationIP</term>
		<listitem><para>The IP address of the server specified with 
		the -S option. Only needed when the server's NetBIOS name cannot 
		be resolved using WINS or broadcast and isn't found in the LMHOSTS
		file. </para></listitem>
		</varlistentry>


		<varlistentry>
		<term>-E</term>
		<listitem><para>causes <command>rpcclient</command> to write 
		messages to stderr instead of stdout. </para></listitem>
		</varlistentry>
		
		
		<varlistentry>
		<term>-U username[%pass]</term>
		<listitem><para>Sets the SMB username or username and password. 
		If %pass is not specified, The user will be prompted. The client 
		will first check the USER environment variable, then the 
		<parameter>$LOGNAME</parameter> variable and if either exist, the 
		string is uppercased. Anything in these variables following a '%' 
		sign will be treated as the password. If these environmental 
		variables are not found, the username <constant>GUEST</constant> 
		is used. </para>

		<para>If the password is not included in these environment 
		variables (using the %pass syntax), rpcclient will look for 
		a <parameter>$PASSWD</parameter> environment variable from which 
		to read the password. </para>
		
		<para>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 doesn't 
		desire 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 
		<parameter>-A</parameter> for more details. </para>
		
		<para>Be cautious about including passwords in scripts or in 
		the <parameter>$PASSWD</parameter> environment variable. Also, on 
		many systems the command line of a running process may be seen 
		via the <command>ps</command> command to be safe always allow 
		<command>rpcclient</command> to prompt for a password and type 
		it in directly. </para></listitem>
		</varlistentry>
		
		
		<varlistentry>
		<term>-A filename</term><listitem><para>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 
		</para>
		
		<para><programlisting>
username = &lt;value&gt; 
password = &lt;value&gt;
		</programlisting></para>
	

		<para>Make certain that the permissions on the file restrict 
		access from unwanted users. </para></listitem>
		</varlistentry>
		
		
		<varlistentry>
		<term>-W domain</term>
		<listitem><para>Set the SMB domain of the username.   This 
		overrides the default  domain which is the domain of the 
		server specified with the  <parameter>-S</parameter> option.  
		If the domain specified is the same as the server's NetBIOS name, 
		it causes the client to log on using the  server's local SAM (as 
		opposed to the Domain SAM). </para></listitem>
		</varlistentry>
		
		
		<varlistentry>
		<term>-P</term>
		<listitem><para>operate in promptless mode.  Without this 
		mode (the default) <command>rpcclient</command> displays a 
		prompt of the form '[domain\username@host]$' </para></listitem>
		</varlistentry>
		
		
		
		<varlistentry>
		<term>-c 'command string'</term>
		<listitem><para>execute semicolon separated commands (listed 
		below)) </para></listitem>
		</varlistentry>
		
		
		<varlistentry>
		<term>-t terminalcode</term>
		<listitem><para>This tells the Samba client how to interpret 
		the incoming filenames, in regards to character sets. The list 
		here is not complete. For a complete list see your local Samba
		source. Some valid options are sjis, euc, jis7, jis8, junet 
		and hex. </para></listitem>
		</varlistentry>
		
		
		<varlistentry>
		<term>-O socket options</term>
		<listitem><para>These socket options are the same as in 
		<filename>smb.conf</filename> (under the <parameter>socket options
		</parameter> section). </para></listitem>
		</varlistentry>
		
		
		<varlistentry>
		<term>-s smb.conf</term>
		<listitem><para>Specifies the location of the all important 
		<filename>smb.conf</filename> file. </para></listitem>
		</varlistentry>
		
		
		
		<varlistentry>
		<term>-i scope</term>
		<listitem><para>Defines the NetBIOS scope. For more 
		information on NetBIOS scopes, see rfc1001 and rfc1002. NetBIOS 
		scopes are rarely used. </para></listitem>
		</varlistentry>
	</variablelist>
</refsect1>


<refsect1>
	<title>COMMANDS</title>

	<para><emphasis>SPOOLSS Commands</emphasis></para>

	<itemizedlist>
		<listitem><para><command>spoolenum</command> - 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. </para></listitem>
		
		<listitem><para><command>spoolenumports level
		</command> - Executes an EnumPorts() call using the specified 
		info level. Currently only info level 1 and 2 are supported. 
		</para></listitem>

		<listitem><para><command>spoolenumdata</command> - 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. </para></listitem>

		<listitem><para><command>spooljobs printer</command> - List the jobs 
		and status of a given printer.  
		This command corresponds to the MS Platform SDK EnumJobs() 
		function. </para></listitem>
		
		<listitem><para><command>spoolopen printer
		</command> - Execute an OpenPrinterEx() and ClosePrinter() RPC 
		against a given printer. </para></listitem> 
		
		<listitem><para><command>spoolgetdata printer
		</command> - Retrieve the data for a given printer setting.  See 
		the  <command>spoolenumdata</command> command for more information.  
		This command corresponds to the GetPrinterData() MS Platform 
		SDK function. </para></listitem>
		
		<listitem><para><command>spoolgetprinter printer
		</command> - Retrieve the current printer information.  This command 
		corresponds to the GetPrinter() MS Platform SDK function. 
		</para></listitem>
		
		<listitem><para><command>spoolgetprinterdriver
		printer</command> - 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. </para></listitem>
		
		<listitem><para><command>spoolgetprinterdriverdir 
		arch</command> - Execute a GetPrinterDriverDirectory()
		RPC to retreive the SMB share name and subdirectory for 
		storing printer driver files for a given architecture.  Possible 
		values for <parameter>arch</parameter> are "Windows 4.0" 
		(for Windows 95/98), "Windows NT x86", "Windows NT PowerPC", "Windows
		Alpha_AXP", and "Windows NT R4000". </para></listitem>
		
		<listitem><para><command>spooladdprinterdriver 
		arch config</command> - 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  spoolgetprinterdriverdir.  Possible 
		values for <parameter>arch</parameter> are the same as those for 
		the <command>spooolgetprintedriverdir</command> command.
		The <parameter>config</parameter> parameter is defined as 
		follows: </para>
		
		<para><programlisting>
Long Printer Name:\
Driver File Name:\
Data File Name:\
Config File Name:\
Help File Name:\
Language Monitor Name:\
Default Data Type:\
Comma Separated list of Files
		</programlisting></para>

		<para>Any empty fields should be enter as the string "NULL". </para>
		
		<para>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. </para></listitem>
		
		
		<listitem><para><command>spooladdprinter printername 
		sharename drivername port
		</command> - 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 addprinterdriver) 
		and the <parameter>port</parameter>must be a valid port name. </para>
		</listitem>

	</itemizedlist>


	<para><emphasis>SPOOLSS Commands</emphasis></para>

	<itemizedlist>
		<listitem><para><command>set</command> - Set miscellaneous 
		<command>rpcclient</command> command line options during a 
		running session. </para></listitem>
		
		<listitem><para><command>use</command> - Connect to a rmeote SMB 
		server.  <command>rpcclient</command> has the ability to 
		maintain connections to multiple server simulaneously. </para></listitem>

		<listitem><para><command>help</command> - Print a listing of all 
		known commands or extended help  on a particular command. 
		</para></listitem>
		
		<listitem><para><command>quit</command> - Exit <command>rpcclient
		</command>
		</para></listitem>
	</itemizedlist>


</refsect1>

<refsect1>
	<title>BUGS</title>
	
	<para><command>rpcclient</command> 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. </para>

	<para>From Luke Leighton's original rpcclient man page:</para>
	
	<para><emphasis>"WARNING!</emphasis> 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's 
	implementation of these services has been demonstrated  (and reported) 
	to be... a bit flakey in places. </para>

	<para>The development of Samba's implementation is also a bit rough, 
	and as more  of the services are understood, it can even result in 
	versions of  <command>smbd(8)</command> and <command>rpcclient</command> 
	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." </para>
</refsect1>


<refsect1>
	<title>VERSION</title>

	<para>This man page is correct for version 2.2 of 
	the Samba suite.</para>
</refsect1>

<refsect1>
	<title>AUTHOR</title>
	
	<para>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.</para>
	
	<para>The original rpcclient man page was written by Matthew Geddes, 
	Luke Kenneth Casson, and Gerald Carter.  The conversion to 
	DocBook for Samba 2.2 was done by Gerald Carter</para>
</refsect1>

</refentry>