diff options
Diffstat (limited to 'docs/docbook/manpages/rpcclient.1.sgml')
| -rw-r--r-- | docs/docbook/manpages/rpcclient.1.sgml | 429 |
1 files changed, 197 insertions, 232 deletions
diff --git a/docs/docbook/manpages/rpcclient.1.sgml b/docs/docbook/manpages/rpcclient.1.sgml index 789ed6b5cf..10e0ff438d 100644 --- a/docs/docbook/manpages/rpcclient.1.sgml +++ b/docs/docbook/manpages/rpcclient.1.sgml @@ -1,7 +1,7 @@ <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ <!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities; ]> -<refentry id="rpcclient.1"> +<refentry id="rpcclient"> <refmeta> <refentrytitle>rpcclient</refentrytitle> @@ -36,8 +36,8 @@ <refsect1> <title>DESCRIPTION</title> - <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle> - <manvolnum>7</manvolnum></citerefentry> suite.</para> + <para>This tool is part of the <ulink url="samba.7.html"> + Samba</ulink> suite.</para> <para><command>rpcclient</command> is a utility initially developed to test MS-RPC functionality in Samba itself. It has undergone @@ -56,9 +56,28 @@ <listitem><para>NetBIOS name of Server to which to connect. The server can be any SMB/CIFS server. The name is resolved using the <ulink url="smb.conf.5.html#NAMERESOLVEORDER"> - <parameter>name resolve order</parameter></ulink> line from <citerefentry><refentrytitle>smb.conf</refentrytitle> - <manvolnum>5</manvolnum></citerefentry>.</para></listitem> - </varlistentry> + <parameter>name resolve order</parameter></ulink> line from + <filename>smb.conf(5)</filename>.</para></listitem> + </varlistentry> + + + <varlistentry> + <term>-A|--authfile=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 = <value> + password = <value> + domain = <value> + </programlisting></para> + + <para>Make certain that the permissions on the file restrict + access from unwanted users. </para></listitem> + </varlistentry> + <varlistentry> @@ -66,8 +85,13 @@ <listitem><para>execute semicolon separated commands (listed below)) </para></listitem> </varlistentry> - + + + + &stdarg.debuglevel; + &stdarg.help; + <varlistentry> <term>-I IP-address</term> <listitem><para><replaceable>IP address</replaceable> is the address of the server to connect to. @@ -86,133 +110,117 @@ above. </para></listitem> </varlistentry> - &popt.common.samba; - &popt.common.credentials; - &popt.common.connection; - &stdarg.help; - </variablelist> -</refsect1> + + <varlistentry> + <term>-l|--logfile=logbasename</term> + <listitem><para>File name for log/debug files. The extension + <constant>'.client'</constant> will be appended. The log file is + never removed by the client. + </para></listitem> + </varlistentry> -<refsect1> - <title>COMMANDS</title> + + <varlistentry> + <term>-N|--nopass</term> + <listitem><para>instruct <command>rpcclient</command> not to ask + for a password. By default, <command>rpcclient</command> will + prompt for a password. See also the <parameter>-U</parameter> + option.</para></listitem> + </varlistentry> - <refsect2> - <title>LSARPC</title> + + <varlistentry> + <term>-s|--conf=smb.conf</term> + <listitem><para>Specifies the location of the all-important + <filename>smb.conf</filename> file. </para></listitem> + </varlistentry> - <variablelist> - <varlistentry><term>lsaquery</term><listitem><para>Query info policy</para></listitem></varlistentry> + + + <varlistentry> + <term>-U|--user=username[%password]</term> + <listitem><para>Sets the SMB username or username and password. </para> - <varlistentry><term>lookupsids</term><listitem><para>Resolve a list - of SIDs to usernames. - </para></listitem></varlistentry> + <para>If %password is not specified, the user will be prompted. The + client will first check the <envar>USER</envar> environment variable, then the + <envar>LOGNAME</envar> variable and if either exists, the + string is uppercased. If these environmental variables are not + found, the username <constant>GUEST</constant> is used. </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 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 + <parameter>-A</parameter> for more details. </para> - <varlistentry><term>lookupnames</term><listitem><para>Resolve a list - of usernames to SIDs. - </para></listitem></varlistentry> + <para>Be cautious about including passwords in scripts. 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>enumtrusts</term><listitem><para>Enumerate trusted domains</para></listitem></varlistentry> - - <varlistentry><term>enumprivs</term><listitem><para>Enumerate privileges</para></listitem></varlistentry> - - <varlistentry><term>getdispname</term><listitem><para>Get the privilege name</para></listitem></varlistentry> - - <varlistentry><term>lsaenumsid</term><listitem><para>Enumerate the LSA SIDS</para></listitem></varlistentry> - - <varlistentry><term>lsaenumprivsaccount</term><listitem><para>Enumerate the privileges of an SID</para></listitem></varlistentry> - - <varlistentry><term>lsaenumacctrights</term><listitem><para>Enumerate the rights of an SID</para></listitem></varlistentry> - - <varlistentry><term>lsaenumacctwithright</term><listitem><para>Enumerate accounts with a right</para></listitem></varlistentry> - - <varlistentry><term>lsaaddacctrights</term><listitem><para>Add rights to an account</para></listitem></varlistentry> - - <varlistentry><term>lsaremoveacctrights</term><listitem><para>Remove rights from an account</para></listitem></varlistentry> - - <varlistentry><term>lsalookupprivvalue</term><listitem><para>Get a privilege value given its name</para></listitem></varlistentry> - - <varlistentry><term>lsaquerysecobj</term><listitem><para>Query LSA security object</para></listitem></varlistentry> - - </variablelist> - </refsect2> - - <refsect2> - <title>LSARPC-DS</title> - - <variablelist> - <varlistentry><term>dsroledominfo</term><listitem><para>Get Primary Domain Information</para></listitem></varlistentry> - </variablelist> - - <para> </para> - - <para><emphasis>DFS</emphasis></para> - <variablelist> - <varlistentry><term>dfsexist</term><listitem><para>Query DFS support</para></listitem></varlistentry> - <varlistentry><term>dfsadd</term><listitem><para>Add a DFS share</para></listitem></varlistentry> - <varlistentry><term>dfsremove</term><listitem><para>Remove a DFS share</para></listitem></varlistentry> - <varlistentry><term>dfsgetinfo</term><listitem><para>Query DFS share info</para></listitem></varlistentry> - <varlistentry><term>dfsenum</term><listitem><para>Enumerate dfs shares</para></listitem></varlistentry> - </variablelist> - - </refsect2> - - <refsect2> - <title>REG</title> - <variablelist> - <varlistentry><term>shutdown</term><listitem><para>Remote Shutdown</para></listitem></varlistentry> - <varlistentry><term>abortshutdown</term><listitem><para>Abort Shutdown</para></listitem></varlistentry> + + + + <varlistentry> + <term>-W|--workgroup=domain</term> + <listitem><para>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 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> + + </variablelist> +</refsect1> - </refsect2> - <refsect2> - <title>SRVSVC</title> +<refsect1> + <title>COMMANDS</title> - <variablelist> - <varlistentry><term>srvinfo</term><listitem><para>Server query info</para></listitem></varlistentry> + <para><emphasis>LSARPC</emphasis></para> + <itemizedlist> + <listitem><para><command>lsaquery</command></para></listitem> - <varlistentry><term>netshareenum</term><listitem><para>Enumerate shares</para></listitem></varlistentry> - - <varlistentry><term>netfileenum</term><listitem><para>Enumerate open files</para></listitem></varlistentry> + <listitem><para><command>lookupsids</command> - Resolve a list + of SIDs to usernames. + </para></listitem> - <varlistentry><term>netremotetod</term><listitem><para>Fetch remote time of day</para></listitem></varlistentry> + <listitem><para><command>lookupnames</command> - Resolve a list + of usernames to SIDs. + </para></listitem> - </variablelist> + <listitem><para><command>enumtrusts</command></para></listitem> + </itemizedlist> + <para> </para> + - </refsect2> - <refsect2> - <title>SAMR</title> + <para><emphasis>SAMR</emphasis></para> + <itemizedlist> + <listitem><para><command>queryuser</command></para></listitem> + <listitem><para><command>querygroup</command></para></listitem> + <listitem><para><command>queryusergroups</command></para></listitem> + <listitem><para><command>querygroupmem</command></para></listitem> + <listitem><para><command>queryaliasmem</command></para></listitem> + <listitem><para><command>querydispinfo</command></para></listitem> + <listitem><para><command>querydominfo</command></para></listitem> + <listitem><para><command>enumdomgroups</command></para></listitem> + </itemizedlist> + <para> </para> - <variablelist> - <varlistentry><term>queryuser</term><listitem><para>Query user info</para></listitem></varlistentry> - <varlistentry><term>querygroup</term><listitem><para>Query group info</para></listitem></varlistentry> - <varlistentry><term>queryusergroups</term><listitem><para>Query user groups</para></listitem></varlistentry> - <varlistentry><term>querygroupmem</term><listitem><para>Query group membership</para></listitem></varlistentry> - <varlistentry><term>queryaliasmem</term><listitem><para>Query alias membership</para></listitem></varlistentry> - <varlistentry><term>querydispinfo</term><listitem><para>Query display info</para></listitem></varlistentry> - <varlistentry><term>querydominfo</term><listitem><para>Query domain info</para></listitem></varlistentry> - <varlistentry><term>enumdomusers</term><listitem><para>Enumerate domain users</para></listitem></varlistentry> - <varlistentry><term>enumdomgroups</term><listitem><para>Enumerate domain groups</para></listitem></varlistentry> - <varlistentry><term>enumalsgroups</term><listitem><para>Enumerate alias groups</para></listitem></varlistentry> - <varlistentry><term>createdomuser</term><listitem><para>Create domain user</para></listitem></varlistentry> - <varlistentry><term>samlookupnames</term><listitem><para>Look up names</para></listitem></varlistentry> - <varlistentry><term>samlookuprids</term><listitem><para>Look up names</para></listitem></varlistentry> - <varlistentry><term>deletedomuser</term><listitem><para>Delete domain user</para></listitem></varlistentry> - <varlistentry><term>samquerysecobj</term><listitem><para>Query SAMR security object</para></listitem></varlistentry> - <varlistentry><term>getdompwinfo</term><listitem><para>Retrieve domain password info</para></listitem></varlistentry> - <varlistentry><term>lookupdomain</term><listitem><para>Look up domain</para></listitem></varlistentry> - </variablelist> - </refsect2> - <refsect2> - <title>SPOOLSS</title> + <para><emphasis>SPOOLSS</emphasis></para> - <variablelist> - <varlistentry><term>adddriver <arch> <config></term> - <listitem><para> - Execute an AddPrinterDriver() RPC to install the printer driver + <itemizedlist> + <listitem><para><command>adddriver <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 <command>getdriverdir</command>. Possible values for @@ -221,16 +229,16 @@ 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><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> @@ -239,174 +247,133 @@ Comma Separated list of Files 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></varlistentry> - - <varlistentry><term>addprinter <printername> - <sharename> <drivername> <port></term> - <listitem><para> - Add a printer on the remote server. This printer + else the RPC will fail. </para></listitem> + + + + + <listitem><para><command>addprinter <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 <command>adddriver</command>) and the <parameter>port</parameter>must be a valid port name (see <command>enumports</command>.</para> - </listitem></varlistentry> + </listitem> - <varlistentry><term>deldriver</term><listitem><para>Delete the + <listitem><para><command>deldriver</command> - Delete the specified printer driver for all architectures. This does not delete the actual driver files from the server, only the entry from the server's list of drivers. - </para></listitem></varlistentry> + </para></listitem> - <varlistentry><term>enumdata</term><listitem><para>Enumerate all + <listitem><para><command>enumdata</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 (* This - command is currently unimplemented).</para></listitem></varlistentry> + command is currently unimplemented).</para></listitem> + - <varlistentry><term>enumdataex</term><listitem><para>Enumerate printer data for a key</para></listitem></varlistentry> - <varlistentry><term>enumjobs <printer></term> - <listitem><para>List the jobs and status of a given printer. + <listitem><para><command>enumjobs <printer></command> + - List the jobs and status of a given printer. This command corresponds to the MS Platform SDK EnumJobs() - function </listitem></varlistentry> + function (* This command is currently unimplemented).</para></listitem> + + - <varlistentry><term>enumkey</term><listitem><para>Enumerate printer keys</para></listitem></varlistentry> - <varlistentry><term>enumports [level]</term> - <listitem><para> - Executes an EnumPorts() call using the specified + <listitem><para><command>enumports [level]</command> + - Executes an EnumPorts() call using the specified info level. Currently only info levels 1 and 2 are supported. - </para></listitem></varlistentry> + </para></listitem> - <varlistentry><term>enumdrivers [level]</term> - <listitem><para> - Execute an EnumPrinterDrivers() call. This lists the various installed + <listitem><para><command>enumdrivers [level]</command> + - Execute an EnumPrinterDrivers() call. This lists the various installed printer drivers for all architectures. Refer to the MS Platform SDK documentation for more details of the various flags and calling - options. Currently supported info levels are 1, 2, and 3.</para></listitem></varlistentry> + options. Currently supported info levels are 1, 2, and 3.</para></listitem> - <varlistentry><term>enumprinters [level]</term> - <listitem><para>Execute an EnumPrinters() call. This lists the various installed + <listitem><para><command>enumprinters [level]</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. Currently - supported info levels are 0, 1, and 2.</para></listitem></varlistentry> + supported info levels are 0, 1, and 2.</para></listitem> - <varlistentry><term>getdata <printername> <valuename;></term> - <listitem><para>Retrieve the data for a given printer setting. See + <listitem><para><command>getdata <printername></command> + - Retrieve the data for a given printer setting. See the <command>enumdata</command> command for more information. This command corresponds to the GetPrinterData() MS Platform - SDK function. </para></listitem></varlistentry> + SDK function (* This command is currently unimplemented). </para></listitem> - <varlistentry><term>getdataex</term><listitem><para>Get printer driver data with keyname</para></listitem></varlistentry> - <varlistentry><term>getdriver <printername></term> - <listitem><para> - Retrieve the printer driver information (such as driver file, + <listitem><para><command>getdriver <printername></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. Currently info level 1, 2, and 3 are supported. - </para></listitem></varlistentry> + </para></listitem> - <varlistentry><term>getdriverdir <arch></term> - <listitem><para> - Execute a GetPrinterDriverDirectory() + <listitem><para><command>getdriverdir <arch></command> + - Execute a GetPrinterDriverDirectory() RPC to retrieve 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></varlistentry> + Alpha_AXP", and "Windows NT R4000". </para></listitem> - <varlistentry><term>getprinter <printername></term> - <listitem><para>Retrieve the current printer information. This command + <listitem><para><command>getprinter <printername></command> + - Retrieve the current printer information. This command corresponds to the GetPrinter() MS Platform SDK function. - </para></listitem></varlistentry> + </para></listitem> + - <varlistentry><term>getprintprocdir</term><listitem><para>Get print processor directory</para></listitem></varlistentry> - <varlistentry><term>openprinter <printername></term> - <listitem><para>Execute an OpenPrinterEx() and ClosePrinter() RPC + <listitem><para><command>openprinter <printername></command> + - Execute an OpenPrinterEx() and ClosePrinter() RPC against a given printer. </para></listitem> - <varlistentry><term>setdriver <printername> - <drivername></term> - <listitem><para>Execute a SetPrinter() command to update the printer driver + + <listitem><para><command>setdriver <printername> + <drivername></command> + - Execute a SetPrinter() command to update the printer driver associated with an installed printer. The printer driver must already be correctly installed on the print server. </para> <para>See also the <command>enumprinters</command> and <command>enumdrivers</command> commands for obtaining a list of - of installed printers and drivers.</para></listitem></varlistentry> - - <varlistentry><term>addform</term><listitem><para>Add form</para></listitem></varlistentry> - <varlistentry><term>setform</term><listitem><para>Set form</para></listitem></varlistentry> - <varlistentry><term>getform</term><listitem><para>Get form</para></listitem></varlistentry> - <varlistentry><term>deleteform</term><listitem><para>Delete form</para></listitem></varlistentry> - <varlistentry><term>enumforms</term><listitem><para>Enumerate form</para></listitem></varlistentry> - <varlistentry><term>setprinter</term><listitem><para>Set printer comment</para></listitem></varlistentry> - <varlistentry><term>setprinterdata</term><listitem><para>Set REG_SZ printer data</para></listitem></varlistentry> - <varlistentry><term>rffpcnex</term><listitem><para>Rffpcnex test</para></listitem></varlistentry> - + of installed printers and drivers.</para></listitem> - </variablelist> + </itemizedlist> - </refsect2> - <refsect2> - <title>NETLOGON</title> + <para><emphasis>GENERAL OPTIONS</emphasis></para> - <variablelist> + <itemizedlist> + <listitem><para><command>debuglevel</command> - Set the current + debug level used to log information.</para></listitem> - <varlistentry><term>logonctrl2</term> - <listitem><para>Logon Control 2</para></listitem> - </varlistentry> - - <varlistentry><term>logonctrl</term> - <listitem><para>Logon Control</para></listitem> - </varlistentry> - - <varlistentry><term>samsync</term> - <listitem><para>Sam Synchronisation</para></listitem> - </varlistentry> - - <varlistentry><term>samdeltas</term> - <listitem><para>Query Sam Deltas</para></listitem> - </varlistentry> - - <varlistentry><term>samlogon</term> - <listitem><para>Sam Logon</para></listitem> - </varlistentry> - - </variablelist> - </refsect2> - - <refsect2> - <title>GENERAL COMMANDS</title> - - <variablelist> - <varlistentry><term>debuglevel</term><listitem><para>Set the current - debug level used to log information.</para></listitem></varlistentry> - - <varlistentry><term>help (?)</term><listitem><para>Print a listing of all + <listitem><para><command>help (?)</command> - Print a listing of all known commands or extended help on a particular command. - </para></listitem></varlistentry> + </para></listitem> - <varlistentry><term>quit (exit)</term><listitem><para>Exit <command>rpcclient - </command>.</para></listitem></varlistentry> - </variablelist> - </refsect2> + <listitem><para><command>quit (exit)</command> - Exit <command>rpcclient + </command>.</para></listitem> + </itemizedlist> + </refsect1> @@ -420,7 +387,7 @@ Comma Separated list of Files <para>From Luke Leighton's original rpcclient man page:</para> - <para><emphasis>WARNING!</emphasis> The MSRPC over SMB code has + <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 @@ -428,13 +395,12 @@ Comma Separated list of Files to be... a bit flaky 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 <citerefentry><refentrytitle>smbd</refentrytitle> - <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>rpcclient</refentrytitle> - <manvolnum>1</manvolnum></citerefentry> that are incompatible for some commands or services. Additionally, + and as more of the services are understood, it can even result in + versions of <command>smbd(8)</command> and <command>rpcclient(1)</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> + result in incompatibilities." </para> </refsect1> @@ -456,8 +422,7 @@ Comma Separated list of Files <para>The original rpcclient man page was written by Matthew Geddes, Luke Kenneth Casson Leighton, and rewritten by Gerald Carter. The conversion to DocBook for Samba 2.2 was done by Gerald - Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was - done by Alexander Bokovoy.</para> + Carter.</para> </refsect1> </refentry> |