diff options
Diffstat (limited to 'docs/yodldocs')
| -rw-r--r-- | docs/yodldocs/rpcclient.8.yo | 263 |
1 files changed, 263 insertions, 0 deletions
diff --git a/docs/yodldocs/rpcclient.8.yo b/docs/yodldocs/rpcclient.8.yo new file mode 100644 index 0000000000..52d29cc52f --- /dev/null +++ b/docs/yodldocs/rpcclient.8.yo @@ -0,0 +1,263 @@ +mailto(samba-bugs@samba.org) +manpage(RPCCLIENT)(8)(August 27, 2000)(Samba)(SAMBA) +label(NAME) +manpagename(rpcclient)(developer's tool to testing client side MS-RPC functions) +label(SYNOPSIS) +manpagesynopsis() +dit(bf(rpcclient)) [link(-d debuglevel)(minusd)] [link(-S server)(minusS)] [link(-l logbasename)(minusl)] [link(-n netbios name)(minusn)] [link(-N)(minusN)] +[link(-m maxprotocol)(minusl)] [link(-I destIP)(minusI)] [link(-E)(minusE)] [link(-U username)(minusU)] [link(-W workgroup)(minusW)] [link(-c `command string`)(minusc)] +[link(-t terminalcode)(minust)] [link(-i scope)(minusi)] [link(-O socket options)(minusO)] +[link(-s smb.conf)(minuss)] +label(DESCRIPTION) +manpagedescription() +dit(bf(rpcclient)) +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. +label(OPTIONS) +manpageoptions() + +startdit() + +label(minusd) +dit(bf(-d debuglevel)) +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). + +label(minusS) +dit(bf(-S server)) +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 "name resolve +order = " line or by using the bf(-R) option. + +label(minusl) +dit(bf(-l logbasename)) +File name for log/debug files. .client will be +appended. The log file is never removed by the client. + +label(minusn) +dit(bf(-n netbios name)) +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. + +label(minusN) +dit(bf(-N)) +tells rpcclient not to ask for a password. rpcclient will prompt +the user by default. + +label(minusI) +dit(bf(-I destIP)) +The IP address of the server specified with the bf(-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. + +label(minusE) +dit(bf(-E)) +causes regedit to write messages to stderr instead of stdout. + +label(minusU) +dit(bf(-U username[%pass])) +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 LOGNAME 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 GUEST is used. + +If the password is not included in these environment variables +(using the %pass syntax), rpcclient will look for a PASSWD environment +variable from which to read the password. + +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 bf(-A) for more details. + +Be cautious about including passwords in scripts or in the +tt(PASSWD) environment variable. Also, on many systems the command +line of a running process may be seen via the tt(ps) command to be +safe always allow smbclient to prompt for a password and type it in +directly. + +label(minusA) +dit(bf(-A <filename>)) 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 + +tt(username = <value>) nl() +tt(password = <value>) nl() + +Make certain that the permissions on the file restrict access from +unwanted users. + +label(minusW) +dit(bf(-W domain)) +Set the SMB domain of the username. This overrides the default +domain which is the domain of the server specified with the +bt(-S) 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). + +label(minusP) +dit(bf(-P)) +operate in promptless mode. Without this mode (the default) +rpcclient displays a prompt of the form '[domain\username@host]$' + +label(minusc) +dit(bf(-c 'command string')) +execute semicolon separated commands (listed below)) + +label(minust) +dit(bf(-t terminalcode)) +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. + +label(minusO) +dit(bf(-O socket options)) +These socket options are the same as in smb.conf (under the bt(socket options = ) +section). + +label(minuss) +dit(bf(-s smb.conf)) +Specifies the location of the all important smb.conf file. + +label(minusi) +dit(bf(-i scope)) +Defines the NetBIOS scope. For more information on NetBIOS scopes, see rfc1001 +and rfc1002. NetBIOS scopes are rarely used. + +enddit() + +label(COMMANDS) +manpagesection(COMMANDS) + +label(SPOOLSSCMD) +dit(bf(SPOOLSS Commands)) +dit(link(spoolenum)(SPOOLSSENUMPRINTERS)) +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. + +dit(link(spoolenumports <level>)(SPOOLSSENUMPORTS)) +Executes an EnumPorts call using the specified info level. +Currently only info level 1 and 2 are supported. + +dit(link(spoolenumdata)(SPOOLSSENUMPRINTERDATA)) +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 EnumPorts +function. + +dit(link(spooljobs <printer>)(SPOOLSSENUMJOBS)) +List the jobs and status of a given printer. This command +corresponds to the MS Platform SDK EnumJobs function. + +dit(link(spoolopen <printer>)(SPOOLSSOPENPRINTER)) +Execute an OpenPrinterEx() and ClosePrinter() +RPC against a given printer. + +dit(link(spoolgetdata)(SPOOLSSGETPRINTERDATA)) +Retrive the data for a given printer setting. See the +bf(spoolenumdata) command for more information. This command +corresponds to the GetPrinterData() MS Platform SDK function. + +dit(link(spoolgetprinter <printer>)(SPOOLSSGETPRINTER)) +Retrieve the current printer information. This command +sorresponds to the GetPrinter() MS Platform SDK function. + +dit(link(spoolgetprinterdriver <printer>)(SPOOLSGETPRINTERDRIVER)) +Retrive 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. + +dit(link(spoolgetprinterdriverdir <arch>)(SPOOLSSGETPRINTERDRIVERDIR)) +Execute a GetPrinterDriverDirectory() RPC to retreive the +SMB share name and subdirectory for storing printer driver +files for a given architecture. Possible values for <arch> are +"Windows 4.0" (for Windows 95/98), "Windows NT x86", "Windows NT +PowerPC", "Windows Alpha_AXP", and "Windows NT R4000". + +dit(link(spooladdprinter <printername> <sharename> +<drivername> <port>)(SPOOLSSADDPRINTER)) +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 bf(addprinterdriver)) and the <port> must +be a valid port name. + +dit(link(spooladdprinterdriver <arch> <config>)(SPOOLSSADDPRINTERDRIVER)) +Execute an AddPrinterDriver() RPC to install the printer +driver information on the server. Note that the driver files +should already exist in the directort returned by +bf(spoolgetprinterdriverdir). Possible values for <arch> +are the same as those for the bf(spooolgetprintedriverdir) command. +The <config> parameter is defined as follows: + +dit()<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> + +dit()Any empty fields should be enter as the string "NULL". + +dit()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. + +label(GENERALCMD) +dit(bf(General Commands)) +dit(link(set)(SET)) +Set miscellaneous rpcclient command line options during a running +session. + +dit(link(use)(USE)) +Connect to a rmeote SMB server. bf(rpcclient) has the ability +to maintain connections to multiple server simulaneously. + +dit(link(help)(HELP)) +Print a listing of all known commands or extended help +on a particular command. + +dit(link(quit)(QUIT)) +Exit rpcclient. + + +label(BUGS) +manpagesection(BUGS) +rpcclient 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. + +From Luke Leighton's original rpcclient man page: +"WARNING! 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. + +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 +bf(smbd(8)) and rpcclient 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." + +label(SEEALSO) +manpageseealso() +bf(samba (7)) +manpageauthor() +Samba is written by The Samba Team as Open Source. This man page was written +by Matthew Geddes, Luke Kenneth Casson, and Gerald Carter. |