diff options
Diffstat (limited to 'docs/manpages/rpcclient.1')
| -rw-r--r-- | docs/manpages/rpcclient.1 | 537 |
1 files changed, 184 insertions, 353 deletions
diff --git a/docs/manpages/rpcclient.1 b/docs/manpages/rpcclient.1 index e20b9a8029..dcba30100b 100644 --- a/docs/manpages/rpcclient.1 +++ b/docs/manpages/rpcclient.1 @@ -3,8 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "RPCCLIENT" "1" "19 april 2003" "" "" - +.TH "RPCCLIENT" "1" "04 March 2003" "" "" .SH NAME rpcclient \- tool for executing client side MS-RPC functions .SH SYNOPSIS @@ -13,7 +12,7 @@ rpcclient \- tool for executing client side MS-RPC functions .SH "DESCRIPTION" .PP -This tool is part of the \fBSamba\fR(7) suite. +This tool is part of the Samba suite. .PP \fBrpcclient\fR is a utility initially developed to test MS-RPC functionality in Samba itself. It has undergone @@ -25,41 +24,28 @@ their UNIX workstation. \fBserver\fR NetBIOS name of Server to which to connect. The server can be any SMB/CIFS server. The name is -resolved using the \fIname resolve order\fR line from \fBsmb.conf\fR(5). -.TP -\fB-c|--command='command string'\fR -execute semicolon separated commands (listed -below)) +resolved using the \fIname resolve order\fR line from +\fIsmb.conf(5)\fR. .TP -\fB-I IP-address\fR -\fIIP address\fR is the address of the server to connect to. -It should be specified in standard "a.b.c.d" notation. +\fB-A|--authfile=filename\fR +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 -Normally the client would attempt to locate a named -SMB/CIFS server by looking it up via the NetBIOS name resolution -mechanism described above in the \fIname resolve order\fR -parameter above. Using this parameter will force the client -to assume that the server is on the machine with the specified IP -address and the NetBIOS name component of the resource being -connected to will be ignored. -There is no default for this parameter. If not supplied, -it will be determined automatically by the client as described -above. -.TP -\fB-V\fR -Prints the version number for -\fBsmbd\fR. +.nf + username = <value> + password = <value> + domain = <value> + +.fi + +Make certain that the permissions on the file restrict +access from unwanted users. .TP -\fB-s <configuration file>\fR -The file specified contains the -configuration details required by the server. The -information in this file includes server-specific -information such as what printcap file to use, as well -as descriptions of all the services that the server is -to provide. See \fIsmb.conf(5)\fR for more information. -The default configuration file name is determined at -compile time. +\fB-c|--command='command string'\fR +execute semicolon separated commands (listed +below)) .TP \fB-d|--debug=debuglevel\fR \fIdebuglevel\fR is an integer @@ -83,238 +69,120 @@ Note that specifying this parameter here will override the log level file. .TP -\fB-l|--logfile=logbasename\fR -File name for log/debug files. The extension -".client" will be appended. The log file is -never removed by the client. +\fB-h|--help\fR +Print a summary of command line options. .TP -\fB-N\fR -If specified, this parameter suppresses the normal -password prompt from the client to the user. This is useful when -accessing a service that does not require a password. +\fB-I IP-address\fR +\fIIP address\fR is the address of the server to connect to. +It should be specified in standard "a.b.c.d" notation. + +Normally the client would attempt to locate a named +SMB/CIFS server by looking it up via the NetBIOS name resolution +mechanism described above in the \fIname resolve order\fR +parameter above. Using this parameter will force the client +to assume that the server is on the machine with the specified IP +address and the NetBIOS name component of the resource being +connected to will be ignored. -Unless a password is specified on the command line or -this parameter is specified, the client will request a -password. +There is no default for this parameter. If not supplied, +it will be determined automatically by the client as described +above. .TP -\fB-k\fR -Try to authenticate with kerberos. Only useful in -an Active Directory environment. +\fB-l|--logfile=logbasename\fR +File name for log/debug files. The extension +\&'.client' will be appended. The log file is +never removed by the client. .TP -\fB-A|--authfile=filename\fR -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 - - -.nf -username = <value> -password = <value> -domain = <value> -.fi - -Make certain that the permissions on the file restrict -access from unwanted users. +\fB-N|--nopass\fR +instruct \fBrpcclient\fR not to ask +for a password. By default, \fBrpcclient\fR will +prompt for a password. See also the \fI-U\fR +option. +.TP +\fB-s|--conf=smb.conf\fR +Specifies the location of the all-important +\fIsmb.conf\fR file. .TP \fB-U|--user=username[%password]\fR Sets the SMB username or username and password. -If %password is not specified, the user will be prompted. The -client will first check the \fBUSER\fR environment variable, then the -\fBLOGNAME\fR variable and if either exists, the -string is uppercased. If these environmental variables are not +If %password is not specified, the user will be prompted. The +client will first check the \fBUSER\fR environment variable, then the +\fBLOGNAME\fR variable and if either exists, the +string is uppercased. If these environmental variables are not found, the username GUEST is used. -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 +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 \fI-A\fR for more details. -Be cautious about including passwords in scripts. Also, on -many systems the command line of a running process may be seen -via the \fBps\fR command. To be safe always allow -\fBrpcclient\fR to prompt for a password and type +Be cautious about including passwords in scripts. Also, on +many systems the command line of a running process may be seen +via the \fBps\fR command. To be safe always allow +\fBrpcclient\fR to prompt for a password and type it in directly. .TP -\fB-n <primary NetBIOS name>\fR -This option allows you to override -the NetBIOS name that Samba uses for itself. This is identical -to setting the \fINetBIOS -name\fR parameter in the \fBsmb.conf\fR(5) file. However, a command -line setting will take precedence over settings in -\fBsmb.conf\fR(5). -.TP -\fB-i <scope>\fR -This specifies a NetBIOS scope that -\fBnmblookup\fR will use to communicate with when -generating NetBIOS names. For details on the use of NetBIOS -scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are -\fBvery\fR rarely used, only set this parameter -if you are the system administrator in charge of all the -NetBIOS systems you communicate with. -.TP \fB-W|--workgroup=domain\fR -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 servers -NetBIOS name, it causes the client to log on using the servers local -SAM (as opposed to the Domain SAM). -.TP -\fB-O socket options\fR -TCP socket options to set on the client -socket. See the socket options parameter in -the \fBsmb.conf\fR(5) manual page for the list of valid -options. -.TP -\fB-h|--help\fR -Print a summary of command line options. +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). .SH "COMMANDS" -.SS "LSARPC" -.TP +.PP +\fBLSARPC\fR +.TP 0.2i +\(bu \fBlsaquery\fR -Query info policy -.TP -\fBlookupsids\fR -Resolve a list +.TP 0.2i +\(bu +\fBlookupsids\fR - Resolve a list of SIDs to usernames. -.TP -\fBlookupnames\fR -Resolve a list +.TP 0.2i +\(bu +\fBlookupnames\fR - Resolve a list of usernames to SIDs. -.TP +.TP 0.2i +\(bu \fBenumtrusts\fR -Enumerate trusted domains -.TP -\fBenumprivs\fR -Enumerate privileges -.TP -\fBgetdispname\fR -Get the privilege name -.TP -\fBlsaenumsid\fR -Enumerate the LSA SIDS -.TP -\fBlsaenumprivsaccount\fR -Enumerate the privileges of an SID -.TP -\fBlsaenumacctrights\fR -Enumerate the rights of an SID -.TP -\fBlsaenumacctwithright\fR -Enumerate accounts with a right -.TP -\fBlsaaddacctrights\fR -Add rights to an account -.TP -\fBlsaremoveacctrights\fR -Remove rights from an account -.TP -\fBlsalookupprivvalue\fR -Get a privilege value given its name -.TP -\fBlsaquerysecobj\fR -Query LSA security object -.SS "LSARPC-DS" -.TP -\fBdsroledominfo\fR -Get Primary Domain Information .PP .PP -\fBDFS\fR -.TP -\fBdfsexist\fR -Query DFS support -.TP -\fBdfsadd\fR -Add a DFS share -.TP -\fBdfsremove\fR -Remove a DFS share -.TP -\fBdfsgetinfo\fR -Query DFS share info -.TP -\fBdfsenum\fR -Enumerate dfs shares -.SS "REG" -.TP -\fBshutdown\fR -Remote Shutdown -.TP -\fBabortshutdown\fR -Abort Shutdown -.SS "SRVSVC" -.TP -\fBsrvinfo\fR -Server query info -.TP -\fBnetshareenum\fR -Enumerate shares -.TP -\fBnetfileenum\fR -Enumerate open files -.TP -\fBnetremotetod\fR -Fetch remote time of day -.SS "SAMR" -.TP +\fBSAMR\fR +.TP 0.2i +\(bu \fBqueryuser\fR -Query user info -.TP +.TP 0.2i +\(bu \fBquerygroup\fR -Query group info -.TP +.TP 0.2i +\(bu \fBqueryusergroups\fR -Query user groups -.TP +.TP 0.2i +\(bu \fBquerygroupmem\fR -Query group membership -.TP +.TP 0.2i +\(bu \fBqueryaliasmem\fR -Query alias membership -.TP +.TP 0.2i +\(bu \fBquerydispinfo\fR -Query display info -.TP +.TP 0.2i +\(bu \fBquerydominfo\fR -Query domain info -.TP -\fBenumdomusers\fR -Enumerate domain users -.TP +.TP 0.2i +\(bu \fBenumdomgroups\fR -Enumerate domain groups -.TP -\fBenumalsgroups\fR -Enumerate alias groups -.TP -\fBcreatedomuser\fR -Create domain user -.TP -\fBsamlookupnames\fR -Look up names -.TP -\fBsamlookuprids\fR -Look up names -.TP -\fBdeletedomuser\fR -Delete domain user -.TP -\fBsamquerysecobj\fR -Query SAMR security object -.TP -\fBgetdompwinfo\fR -Retrieve domain password info -.TP -\fBlookupdomain\fR -Look up domain -.SS "SPOOLSS" -.TP -\fBadddriver <arch> <config>\fR -Execute an AddPrinterDriver() RPC to install the printer driver +.PP +.PP +\fBSPOOLSS\fR +.TP 0.2i +\(bu +\fBadddriver <arch> <config>\fR +- 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 \fBgetdriverdir\fR. Possible values for @@ -325,14 +193,15 @@ follows: .nf -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 + 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 + .fi Any empty fields should be enter as the string "NULL". @@ -343,149 +212,111 @@ 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. -.TP -\fBaddprinter <printername> <sharename> <drivername> <port>\fR -Add a printer on the remote server. This printer +.TP 0.2i +\(bu +\fBaddprinter <printername> +<sharename> <drivername> <port>\fR +- 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 \fBadddriver\fR) and the \fIport\fRmust be a valid port name (see \fBenumports\fR. -.TP -\fBdeldriver\fR -Delete the +.TP 0.2i +\(bu +\fBdeldriver\fR - 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. -.TP -\fBenumdata\fR -Enumerate all +.TP 0.2i +\(bu +\fBenumdata\fR - 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). -.TP -\fBenumdataex\fR -Enumerate printer data for a key -.TP -\fBenumjobs <printer>\fR -List the jobs and status of a given printer. +.TP 0.2i +\(bu +\fBenumjobs <printer>\fR +- List the jobs and status of a given printer. This command corresponds to the MS Platform SDK EnumJobs() -function -.TP -\fBenumkey\fR -Enumerate printer keys -.TP -\fBenumports [level]\fR -Executes an EnumPorts() call using the specified +function (* This command is currently unimplemented). +.TP 0.2i +\(bu +\fBenumports [level]\fR +- Executes an EnumPorts() call using the specified info level. Currently only info levels 1 and 2 are supported. -.TP -\fBenumdrivers [level]\fR -Execute an EnumPrinterDrivers() call. This lists the various installed +.TP 0.2i +\(bu +\fBenumdrivers [level]\fR +- 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. -.TP -\fBenumprinters [level]\fR -Execute an EnumPrinters() call. This lists the various installed +.TP 0.2i +\(bu +\fBenumprinters [level]\fR +- 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. -.TP -\fBgetdata <printername> <valuename;>\fR -Retrieve the data for a given printer setting. See +.TP 0.2i +\(bu +\fBgetdata <printername>\fR +- Retrieve the data for a given printer setting. See the \fBenumdata\fR command for more information. This command corresponds to the GetPrinterData() MS Platform -SDK function. -.TP -\fBgetdataex\fR -Get printer driver data with keyname -.TP -\fBgetdriver <printername>\fR -Retrieve the printer driver information (such as driver file, +SDK function (* This command is currently unimplemented). +.TP 0.2i +\(bu +\fBgetdriver <printername>\fR +- 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. -.TP -\fBgetdriverdir <arch>\fR -Execute a GetPrinterDriverDirectory() +.TP 0.2i +\(bu +\fBgetdriverdir <arch>\fR +- Execute a GetPrinterDriverDirectory() RPC to retrieve the SMB share name and subdirectory for storing printer driver files for a given architecture. Possible values for \fIarch\fR are "Windows 4.0" (for Windows 95/98), "Windows NT x86", "Windows NT PowerPC", "Windows Alpha_AXP", and "Windows NT R4000". -.TP -\fBgetprinter <printername>\fR -Retrieve the current printer information. This command +.TP 0.2i +\(bu +\fBgetprinter <printername>\fR +- Retrieve the current printer information. This command corresponds to the GetPrinter() MS Platform SDK function. -.TP -\fBgetprintprocdir\fR -Get print processor directory -.TP -\fBopenprinter <printername>\fR -Execute an OpenPrinterEx() and ClosePrinter() RPC +.TP 0.2i +\(bu +\fBopenprinter <printername>\fR +- Execute an OpenPrinterEx() and ClosePrinter() RPC against a given printer. -.TP -\fBsetdriver <printername> <drivername>\fR -Execute a SetPrinter() command to update the printer driver +.TP 0.2i +\(bu +\fBsetdriver <printername> +<drivername>\fR +- 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. See also the \fBenumprinters\fR and \fBenumdrivers\fR commands for obtaining a list of of installed printers and drivers. -.TP -\fBaddform\fR -Add form -.TP -\fBsetform\fR -Set form -.TP -\fBgetform\fR -Get form -.TP -\fBdeleteform\fR -Delete form -.TP -\fBenumforms\fR -Enumerate form -.TP -\fBsetprinter\fR -Set printer comment -.TP -\fBsetprinterdata\fR -Set REG_SZ printer data -.TP -\fBrffpcnex\fR -Rffpcnex test -.SS "NETLOGON" -.TP -\fBlogonctrl2\fR -Logon Control 2 -.TP -\fBlogonctrl\fR -Logon Control -.TP -\fBsamsync\fR -Sam Synchronisation -.TP -\fBsamdeltas\fR -Query Sam Deltas -.TP -\fBsamlogon\fR -Sam Logon -.SS "GENERAL COMMANDS" -.TP -\fBdebuglevel\fR -Set the current +.PP +\fBGENERAL OPTIONS\fR +.TP 0.2i +\(bu +\fBdebuglevel\fR - Set the current debug level used to log information. -.TP -\fBhelp (?)\fR -Print a listing of all +.TP 0.2i +\(bu +\fBhelp (?)\fR - Print a listing of all known commands or extended help on a particular command. -.TP -\fBquit (exit)\fR -Exit \fBrpcclient +.TP 0.2i +\(bu +\fBquit (exit)\fR - Exit \fBrpcclient \fR. .SH "BUGS" .PP @@ -496,7 +327,7 @@ parameters where passed to the interpreter. .PP From Luke Leighton's original rpcclient man page: .PP -\fBWARNING!\fR The MSRPC over SMB code has +\fB"WARNING!\fR 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 @@ -504,11 +335,12 @@ implementation of these services has been demonstrated (and reported) to be... a bit flaky in places. .PP 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 \fBsmbd\fR(8) and \fBrpcclient\fR(1) that are incompatible for some commands or services. Additionally, +and as more of the services are understood, it can even result in +versions of \fBsmbd(8)\fR and \fBrpcclient(1)\fR +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. +result in incompatibilities." .SH "VERSION" .PP This man page is correct for version 3.0 of the Samba @@ -523,5 +355,4 @@ to the way the Linux kernel is developed. 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. +Carter. |