1<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbclient</title><link rel="stylesheet" href="../samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbclient.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>smbclient — ftp-like client to access SMB/CIFS resources 2 on servers</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">smbclient</code> [-b <buffer size>] [-d debuglevel] [-e] [-L <netbios name>] [-U username] [-I destinationIP] [-M <netbios name>] [-m maxprotocol] [-A authfile] [-N] [-C] [-g] [-i scope] [-O <socket options>] [-p port] [-R <name resolve order>] [-s <smb config file>] [-k] [-P] [-c <command>]</p></div><div class="cmdsynopsis"><p><code class="literal">smbclient</code> {servicename} [password] [-b <buffer size>] [-d debuglevel] [-e] [-D Directory] [-U username] [-W workgroup] [-M <netbios name>] [-m maxprotocol] [-A authfile] [-N] [-C] [-g] [-l log-basename] [-I destinationIP] [-E] [-c <command string>] [-i scope] [-O <socket options>] [-p port] [-R <name resolve order>] [-s <smb config file>] [-T<c|x>IXFqgbNan] [-k]</p></div></div><div class="refsect1" lang="en"><a name="id2483767"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a class="citerefentry" href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p><code class="literal">smbclient</code> is a client that can 3 'talk' to an SMB/CIFS server. It offers an interface 4 similar to that of the ftp program (see <a class="citerefentry" href="ftp.1.html"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a>). 5 Operations include things like getting files from the server 6 to the local machine, putting files from the local machine to 7 the server, retrieving directory information from the server 8 and so on. </p></div><div class="refsect1" lang="en"><a name="id2481476"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">servicename</span></dt><dd><p>servicename is the name of the service 9 you want to use on the server. A service name takes the form 10 <code class="filename">//server/service</code> where <em class="parameter"><code>server 11 </code></em> is the NetBIOS name of the SMB/CIFS server 12 offering the desired service and <em class="parameter"><code>service</code></em> 13 is the name of the service offered. Thus to connect to 14 the service "printer" on the SMB/CIFS server "smbserver", 15 you would use the servicename <code class="filename">//smbserver/printer 16 </code></p><p>Note that the server name required is NOT necessarily 17 the IP (DNS) host name of the server ! The name required is 18 a NetBIOS server name, which may or may not be the 19 same as the IP hostname of the machine running the server. 20 </p><p>The server name is looked up according to either 21 the <em class="parameter"><code>-R</code></em> parameter to <code class="literal">smbclient</code> or 22 using the name resolve order parameter in 23 the <a class="citerefentry" href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file, 24 allowing an administrator to change the order and methods 25 by which server names are looked up. </p></dd><dt><span class="term">password</span></dt><dd><p>The password required to access the specified 26 service on the specified server. If this parameter is 27 supplied, the <em class="parameter"><code>-N</code></em> option (suppress 28 password prompt) is assumed. </p><p>There is no default password. If no password is supplied 29 on the command line (either by using this parameter or adding 30 a password to the <em class="parameter"><code>-U</code></em> option (see 31 below)) and the <em class="parameter"><code>-N</code></em> option is not 32 specified, the client will prompt for a password, even if 33 the desired service does not require one. (If no password is 34 required, simply press ENTER to provide a null password.) 35 </p><p>Note: Some servers (including OS/2 and Windows for 36 Workgroups) insist on an uppercase password. Lowercase 37 or mixed case passwords may be rejected by these servers. 38 </p><p>Be cautious about including passwords in scripts. 39 </p></dd><dt><span class="term">-R|--name-resolve <name resolve order></span></dt><dd><p>This option is used by the programs in the Samba 40 suite to determine what naming services and in what order to resolve 41 host names to IP addresses. The option takes a space-separated 42 string of different name resolution options.</p><p>The options are :"lmhosts", "host", "wins" and "bcast". They 43 cause names to be resolved as follows:</p><div class="itemizedlist"><ul type="disc"><li><p><code class="constant">lmhosts</code>: Lookup an IP 44 address in the Samba lmhosts file. If the line in lmhosts has 45 no name type attached to the NetBIOS name (see 46 the <a class="citerefentry" href="lmhosts.5.html"><span class="citerefentry"><span class="refentrytitle">lmhosts</span>(5)</span></a> for details) then 47 any name type matches for lookup.</p></li><li><p><code class="constant">host</code>: Do a standard host 48 name to IP address resolution, using the system <code class="filename">/etc/hosts 49 </code>, NIS, or DNS lookups. This method of name resolution 50 is operating system dependent, for instance on IRIX or Solaris this 51 may be controlled by the <code class="filename">/etc/nsswitch.conf</code> 52 file). Note that this method is only used if the NetBIOS name 53 type being queried is the 0x20 (server) name type, otherwise 54 it is ignored.</p></li><li><p><code class="constant">wins</code>: Query a name with 55 the IP address listed in the <em class="parameter"><code>wins server</code></em> 56 parameter. If no WINS server has 57 been specified this method will be ignored.</p></li><li><p><code class="constant">bcast</code>: Do a broadcast on 58 each of the known local interfaces listed in the 59 <em class="parameter"><code>interfaces</code></em> 60 parameter. This is the least reliable of the name resolution 61 methods as it depends on the target host being on a locally 62 connected subnet.</p></li></ul></div><p>If this parameter is not set then the name resolve order 63 defined in the <a class="citerefentry" href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file parameter 64 (name resolve order) will be used. </p><p>The default order is lmhosts, host, wins, bcast and without 65 this parameter or any entry in the <em class="parameter"><code>name resolve order 66 </code></em> parameter of the <a class="citerefentry" href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file the name resolution 67 methods will be attempted in this order. </p></dd><dt><span class="term">-M|--message NetBIOS name</span></dt><dd><p>This options allows you to send messages, using 68 the "WinPopup" protocol, to another computer. Once a connection is 69 established you then type your message, pressing ^D (control-D) to 70 end. </p><p>If the receiving computer is running WinPopup the user will 71 receive the message and probably a beep. If they are not running 72 WinPopup the message will be lost, and no error message will 73 occur. </p><p>The message is also automatically truncated if the message 74 is over 1600 bytes, as this is the limit of the protocol. 75 </p><p> 76 One useful trick is to pipe the message through <code class="literal">smbclient</code>. 77 For example: smbclient -M FRED < mymessage.txt will send the 78 message in the file <code class="filename">mymessage.txt</code> to the 79 machine FRED. 80 </p><p>You may also find the <em class="parameter"><code>-U</code></em> and 81 <em class="parameter"><code>-I</code></em> options useful, as they allow you to 82 control the FROM and TO parts of the message. </p><p>See the <em class="parameter"><code>message command</code></em> parameter in the <a class="citerefentry" href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> for a description of how to handle incoming 83 WinPopup messages in Samba. </p><p><span class="emphasis"><em>Note</em></span>: Copy WinPopup into the startup group 84 on your WfWg PCs if you want them to always be able to receive 85 messages. </p></dd><dt><span class="term">-p|--port port</span></dt><dd><p>This number is the TCP port number that will be used 86 when making connections to the server. The standard (well-known) 87 TCP port number for an SMB/CIFS server is 139, which is the 88 default. </p></dd><dt><span class="term">-g|--grepable</span></dt><dd><p>This parameter provides combined with 89 <em class="parameter"><code>-L</code></em> easy parseable output that allows processing 90 with utilities such as grep and cut. 91 </p></dd><dt><span class="term">-m|--max-protocol protocol</span></dt><dd><p>This parameter sets the maximum protocol version announced by the client. 92 </p></dd><dt><span class="term">-P</span></dt><dd><p> 93 Make queries to the external server using the machine account of the local server. 94 </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options. 95</p></dd><dt><span class="term">-I|--ip-address IP-address</span></dt><dd><p><em class="replaceable"><code>IP address</code></em> is the address of the server to connect to. 96 It should be specified in standard "a.b.c.d" notation. </p><p>Normally the client would attempt to locate a named 97 SMB/CIFS server by looking it up via the NetBIOS name resolution 98 mechanism described above in the <em class="parameter"><code>name resolve order</code></em> 99 parameter above. Using this parameter will force the client 100 to assume that the server is on the machine with the specified IP 101 address and the NetBIOS name component of the resource being 102 connected to will be ignored. </p><p>There is no default for this parameter. If not supplied, 103 it will be determined automatically by the client as described 104 above. </p></dd><dt><span class="term">-E|--stderr</span></dt><dd><p>This parameter causes the client to write messages 105 to the standard error stream (stderr) rather than to the standard 106 output stream. </p><p>By default, the client writes messages to standard output 107 - typically the user's tty. </p></dd><dt><span class="term">-L|--list</span></dt><dd><p>This option allows you to look at what services 108 are available on a server. You use it as <code class="literal">smbclient -L 109 host</code> and a list should appear. The <em class="parameter"><code>-I 110 </code></em> option may be useful if your NetBIOS names don't 111 match your TCP/IP DNS host names or if you are trying to reach a 112 host on another network. </p></dd><dt><span class="term">-b|--send-buffer buffersize</span></dt><dd><p>This option changes the transmit/send buffer 113 size when getting or putting a file from/to the server. The default 114 is 65520 bytes. Setting this value smaller (to 1200 bytes) has been 115 observed to speed up file transfers to and from a Win9x server. 116 </p></dd><dt><span class="term">-e</span></dt><dd><p>This command line parameter requires the remote 117 server support the UNIX extensions. Request that the connection be 118 encrypted. This is new for Samba 3.2 and will only work with Samba 119 3.2 or above servers. Negotiates SMB encryption using GSSAPI. Uses 120 the given credentials for the encryption negotiaion (either kerberos 121 or NTLMv1/v2 if given domain/username/password triple. Fails the 122 connection if encryption cannot be negotiated. 123 </p></dd><dt><span class="term">-d|--debuglevel=level</span></dt><dd><p><em class="replaceable"><code>level</code></em> is an integer 124from 0 to 10. The default value if this parameter is 125not specified is 1.</p><p>The higher this value, the more detail will be 126logged to the log files about the activities of the 127server. At level 0, only critical errors and serious 128warnings will be logged. Level 1 is a reasonable level for 129day-to-day running - it generates a small amount of 130information about operations carried out.</p><p>Levels above 1 will generate considerable 131amounts of log data, and should only be used when 132investigating a problem. Levels above 3 are designed for 133use only by developers and generate HUGE amounts of log 134data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will 135override the <a class="link" href="smb.conf.5.html#" target="_top"></a> parameter 136in the <code class="filename">smb.conf</code> file.</p></dd><dt><span class="term">-V|--version</span></dt><dd><p>Prints the program version number. 137</p></dd><dt><span class="term">-s|--configfile <configuration file></span></dt><dd><p>The file specified contains the 138configuration details required by the server. The 139information in this file includes server-specific 140information such as what printcap file to use, as well 141as descriptions of all the services that the server is 142to provide. See <code class="filename">smb.conf</code> for more information. 143The default configuration file name is determined at 144compile time.</p></dd><dt><span class="term">-l|--log-basename=logdirectory</span></dt><dd><p>Base directory name for log/debug files. The extension 145<code class="constant">".progname"</code> will be appended (e.g. log.smbclient, 146log.smbd, etc...). The log file is never removed by the client. 147</p></dd><dt><span class="term">-N|--no-pass</span></dt><dd><p>If specified, this parameter suppresses the normal 148password prompt from the client to the user. This is useful when 149accessing a service that does not require a password. </p><p>Unless a password is specified on the command line or 150this parameter is specified, the client will request a 151password.</p><p>If a password is specified on the command line and this 152option is also defined the password on the command line will 153be silently ingnored and no password will be used.</p></dd><dt><span class="term">-k|--kerberos</span></dt><dd><p> 154Try to authenticate with kerberos. Only useful in 155an Active Directory environment. 156</p></dd><dt><span class="term">-C|--use-ccache</span></dt><dd><p> 157Try to use the credentials cached by winbind. 158</p></dd><dt><span class="term">-A|--authentication-file=filename</span></dt><dd><p>This option allows 159you to specify a file from which to read the username and 160password used in the connection. The format of the file is 161</p><pre class="programlisting"> 162username = <value> 163password = <value> 164domain = <value> 165</pre><p>Make certain that the permissions on the file restrict 166access from unwanted users. </p></dd><dt><span class="term">-U|--user=username[%password]</span></dt><dd><p>Sets the SMB username or username and password. </p><p>If %password is not specified, the user will be prompted. The 167client will first check the <code class="envar">USER</code> environment variable, then the 168<code class="envar">LOGNAME</code> variable and if either exists, the 169string is uppercased. If these environmental variables are not 170found, the username <code class="constant">GUEST</code> is used. </p><p>A third option is to use a credentials file which 171contains the plaintext of the username and password. This 172option is mainly provided for scripts where the admin does not 173wish to pass the credentials on the command line or via environment 174variables. If this method is used, make certain that the permissions 175on the file restrict access from unwanted users. See the 176<em class="parameter"><code>-A</code></em> for more details. </p><p>Be cautious about including passwords in scripts. Also, on 177many systems the command line of a running process may be seen 178via the <code class="literal">ps</code> command. To be safe always allow 179<code class="literal">rpcclient</code> to prompt for a password and type 180it in directly. </p></dd><dt><span class="term">-n|--netbiosname <primary NetBIOS name></span></dt><dd><p>This option allows you to override 181the NetBIOS name that Samba uses for itself. This is identical 182to setting the <a class="link" href="smb.conf.5.html#" target="_top"></a> parameter in the <code class="filename">smb.conf</code> file. 183However, a command 184line setting will take precedence over settings in 185<code class="filename">smb.conf</code>.</p></dd><dt><span class="term">-i|--scope <scope></span></dt><dd><p>This specifies a NetBIOS scope that 186<code class="literal">nmblookup</code> will use to communicate with when 187generating NetBIOS names. For details on the use of NetBIOS 188scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are 189<span class="emphasis"><em>very</em></span> rarely used, only set this parameter 190if you are the system administrator in charge of all the 191NetBIOS systems you communicate with.</p></dd><dt><span class="term">-W|--workgroup=domain</span></dt><dd><p>Set the SMB domain of the username. This 192overrides the default domain which is the domain defined in 193smb.conf. If the domain specified is the same as the servers 194NetBIOS name, it causes the client to log on using the servers local 195SAM (as opposed to the Domain SAM). </p></dd><dt><span class="term">-O|--socket-options socket options</span></dt><dd><p>TCP socket options to set on the client 196socket. See the socket options parameter in 197the <code class="filename">smb.conf</code> manual page for the list of valid 198options. </p></dd><dt><span class="term">-T|--tar tar options</span></dt><dd><p>smbclient may be used to create <code class="literal">tar(1) 199 </code> compatible backups of all the files on an SMB/CIFS 200 share. The secondary tar flags that can be given to this option 201 are : </p><div class="itemizedlist"><ul type="disc"><li><p><em class="parameter"><code>c</code></em> - Create a tar file on UNIX. 202 Must be followed by the name of a tar file, tape device 203 or "-" for standard output. If using standard output you must 204 turn the log level to its lowest value -d0 to avoid corrupting 205 your tar file. This flag is mutually exclusive with the 206 <em class="parameter"><code>x</code></em> flag. </p></li><li><p><em class="parameter"><code>x</code></em> - Extract (restore) a local 207 tar file back to a share. Unless the -D option is given, the tar 208 files will be restored from the top level of the share. Must be 209 followed by the name of the tar file, device or "-" for standard 210 input. Mutually exclusive with the <em class="parameter"><code>c</code></em> flag. 211 Restored files have their creation times (mtime) set to the 212 date saved in the tar file. Directories currently do not get 213 their creation dates restored properly. </p></li><li><p><em class="parameter"><code>I</code></em> - Include files and directories. 214 Is the default behavior when filenames are specified above. Causes 215 files to be included in an extract or create (and therefore 216 everything else to be excluded). See example below. Filename globbing 217 works in one of two ways. See <em class="parameter"><code>r</code></em> below. </p></li><li><p><em class="parameter"><code>X</code></em> - Exclude files and directories. 218 Causes files to be excluded from an extract or create. See 219 example below. Filename globbing works in one of two ways now. 220 See <em class="parameter"><code>r</code></em> below. </p></li><li><p><em class="parameter"><code>F</code></em> - File containing a list of files and directories. 221 The <em class="parameter"><code>F</code></em> causes the name following the tarfile to 222 create to be read as a filename that contains a list of files and directories to 223 be included in an extract or create (and therefore everything else to be excluded). 224 See example below. Filename globbing works in one of two ways. 225 See <em class="parameter"><code>r</code></em> below. 226 </p></li><li><p><em class="parameter"><code>b</code></em> - Blocksize. Must be followed 227 by a valid (greater than zero) blocksize. Causes tar file to be 228 written out in blocksize*TBLOCK (usually 512 byte) blocks. 229 </p></li><li><p><em class="parameter"><code>g</code></em> - Incremental. Only back up 230 files that have the archive bit set. Useful only with the 231 <em class="parameter"><code>c</code></em> flag. </p></li><li><p><em class="parameter"><code>q</code></em> - Quiet. Keeps tar from printing 232 diagnostics as it works. This is the same as tarmode quiet. 233 </p></li><li><p><em class="parameter"><code>r</code></em> - Regular expression include 234 or exclude. Uses regular expression matching for 235 excluding or excluding files if compiled with HAVE_REGEX_H. 236 However this mode can be very slow. If not compiled with 237 HAVE_REGEX_H, does a limited wildcard match on '*' and '?'. 238 </p></li><li><p><em class="parameter"><code>N</code></em> - Newer than. Must be followed 239 by the name of a file whose date is compared against files found 240 on the share during a create. Only files newer than the file 241 specified are backed up to the tar file. Useful only with the 242 <em class="parameter"><code>c</code></em> flag. </p></li><li><p><em class="parameter"><code>a</code></em> - Set archive bit. Causes the 243 archive bit to be reset when a file is backed up. Useful with the 244 <em class="parameter"><code>g</code></em> and <em class="parameter"><code>c</code></em> flags. 245 </p></li></ul></div><p><span class="emphasis"><em>Tar Long File Names</em></span></p><p><code class="literal">smbclient</code>'s tar option now supports long 246 file names both on backup and restore. However, the full path 247 name of the file must be less than 1024 bytes. Also, when 248 a tar archive is created, <code class="literal">smbclient</code>'s tar option places all 249 files in the archive with relative names, not absolute names. 250 </p><p><span class="emphasis"><em>Tar Filenames</em></span></p><p>All file names can be given as DOS path names (with '\\' 251 as the component separator) or as UNIX path names (with '/' as 252 the component separator). </p><p><span class="emphasis"><em>Examples</em></span></p><p>Restore from tar file <code class="filename">backup.tar</code> into myshare on mypc 253 (no password on share). </p><p><code class="literal">smbclient //mypc/yshare "" -N -Tx backup.tar 254 </code></p><p>Restore everything except <code class="filename">users/docs</code> 255 </p><p><code class="literal">smbclient //mypc/myshare "" -N -TXx backup.tar 256 users/docs</code></p><p>Create a tar file of the files beneath <code class="filename"> 257 users/docs</code>. </p><p><code class="literal">smbclient //mypc/myshare "" -N -Tc 258 backup.tar users/docs </code></p><p>Create the same tar file as above, but now use 259 a DOS path name. </p><p><code class="literal">smbclient //mypc/myshare "" -N -tc backup.tar 260 users\edocs </code></p><p>Create a tar file of the files listed in the file <code class="filename">tarlist</code>.</p><p><code class="literal">smbclient //mypc/myshare "" -N -TcF 261 backup.tar tarlist</code></p><p>Create a tar file of all the files and directories in 262 the share. </p><p><code class="literal">smbclient //mypc/myshare "" -N -Tc backup.tar * 263 </code></p></dd><dt><span class="term">-D|--directory initial directory</span></dt><dd><p>Change to initial directory before starting. Probably 264 only of any use with the tar -T option. </p></dd><dt><span class="term">-c|--comand command string</span></dt><dd><p>command string is a semicolon-separated list of 265 commands to be executed instead of prompting from stdin. <em class="parameter"><code> 266 -N</code></em> is implied by <em class="parameter"><code>-c</code></em>.</p><p>This is particularly useful in scripts and for printing stdin 267 to the server, e.g. <code class="literal">-c 'print -'</code>. </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2533296"></a><h2>OPERATIONS</h2><p>Once the client is running, the user is presented with 268 a prompt : </p><p><code class="prompt">smb:\> </code></p><p>The backslash ("\\") indicates the current working directory 269 on the server, and will change if the current working directory 270 is changed. </p><p>The prompt indicates that the client is ready and waiting to 271 carry out a user command. Each command is a single word, optionally 272 followed by parameters specific to that command. Command and parameters 273 are space-delimited unless these notes specifically 274 state otherwise. All commands are case-insensitive. Parameters to 275 commands may or may not be case sensitive, depending on the command. 276 </p><p>You can specify file names which have spaces in them by quoting 277 the name with double quotes, for example "a long file name". </p><p>Parameters shown in square brackets (e.g., "[parameter]") are 278 optional. If not given, the command will use suitable defaults. Parameters 279 shown in angle brackets (e.g., "<parameter>") are required. 280 </p><p>Note that all commands operating on the server are actually 281 performed by issuing a request to the server. Thus the behavior may 282 vary from server to server, depending on how the server was implemented. 283 </p><p>The commands available are given here in alphabetical order. </p><div class="variablelist"><dl><dt><span class="term">? [command]</span></dt><dd><p>If <em class="replaceable"><code>command</code></em> is specified, the ? command will display 284 a brief informative message about the specified command. If no 285 command is specified, a list of available commands will 286 be displayed. </p></dd><dt><span class="term">! [shell command]</span></dt><dd><p>If <em class="replaceable"><code>shell command</code></em> is specified, the ! 287 command will execute a shell locally and run the specified shell 288 command. If no command is specified, a local shell will be run. 289 </p></dd><dt><span class="term">allinfo file</span></dt><dd><p>The client will request that the server return 290 all known information about a file or directory (including streams). 291 </p></dd><dt><span class="term">altname file</span></dt><dd><p>The client will request that the server return 292 the "alternate" name (the 8.3 name) for a file or directory. 293 </p></dd><dt><span class="term">archive <number></span></dt><dd><p>Sets the archive level when operating on files. 294 0 means ignore the archive bit, 1 means only operate on files with this bit set, 295 2 means only operate on files with this bit set and reset it after operation, 296 3 means operate on all files and reset it after operation. The default is 0. 297 </p></dd><dt><span class="term">blocksize <number></span></dt><dd><p>Sets the blocksize parameter for a tar operation. The default is 20. 298 Causes tar file to be written out in blocksize*TBLOCK (normally 512 byte) units. 299 </p></dd><dt><span class="term">cancel jobid0 [jobid1] ... [jobidN]</span></dt><dd><p>The client will request that the server cancel 300 the printjobs identified by the given numeric print job ids. 301 </p></dd><dt><span class="term">case_sensitive</span></dt><dd><p>Toggles the setting of the flag in SMB packets that 302 tells the server to treat filenames as case sensitive. Set to OFF by 303 default (tells file server to treat filenames as case insensitive). Only 304 currently affects Samba 3.0.5 and above file servers with the case sensitive 305 parameter set to auto in the smb.conf. 306 </p></dd><dt><span class="term">cd <directory name></span></dt><dd><p>If "directory name" is specified, the current 307 working directory on the server will be changed to the directory 308 specified. This operation will fail if for any reason the specified 309 directory is inaccessible. </p><p>If no directory name is specified, the current working 310 directory on the server will be reported. </p></dd><dt><span class="term">chmod file mode in octal</span></dt><dd><p>This command depends on the server supporting the CIFS 311 UNIX extensions and will fail if the server does not. The client requests that the server 312 change the UNIX permissions to the given octal mode, in standard UNIX format. 313 </p></dd><dt><span class="term">chown file uid gid</span></dt><dd><p>This command depends on the server supporting the CIFS 314 UNIX extensions and will fail if the server does not. The client requests that the server 315 change the UNIX user and group ownership to the given decimal values. Note there is 316 currently no way to remotely look up the UNIX uid and gid values for a given name. 317 This may be addressed in future versions of the CIFS UNIX extensions. 318 </p></dd><dt><span class="term">close <fileid></span></dt><dd><p>Closes a file explicitly opened by the open command. Used for 319 internal Samba testing purposes. 320 </p></dd><dt><span class="term">del <mask></span></dt><dd><p>The client will request that the server attempt 321 to delete all files matching <em class="replaceable"><code>mask</code></em> from the current working 322 directory on the server. </p></dd><dt><span class="term">dir <mask></span></dt><dd><p>A list of the files matching <em class="replaceable"><code>mask</code></em> in the current 323 working directory on the server will be retrieved from the server 324 and displayed. </p></dd><dt><span class="term">du <filename></span></dt><dd><p>Does a directory listing and then prints out the current disk useage and free space on a share. 325 </p></dd><dt><span class="term">echo <number> <data></span></dt><dd><p>Does an SMBecho request to ping the server. Used for internal Samba testing purposes. 326 </p></dd><dt><span class="term">exit</span></dt><dd><p>Terminate the connection with the server and exit 327 from the program. </p></dd><dt><span class="term">get <remote file name> [local file name]</span></dt><dd><p>Copy the file called <code class="filename">remote file name</code> from 328 the server to the machine running the client. If specified, name 329 the local copy <code class="filename">local file name</code>. Note that all transfers in 330 <code class="literal">smbclient</code> are binary. See also the 331 lowercase command. </p></dd><dt><span class="term">getfacl <filename></span></dt><dd><p>Requires the server support the UNIX extensions. Requests and prints 332 the POSIX ACL on a file. 333 </p></dd><dt><span class="term">hardlink <src> <dest></span></dt><dd><p>Creates a hardlink on the server using Windows CIFS semantics. 334 </p></dd><dt><span class="term">help [command]</span></dt><dd><p>See the ? command above. </p></dd><dt><span class="term">history</span></dt><dd><p>Displays the command history.</p></dd><dt><span class="term">iosize <bytes></span></dt><dd><p>When sending or receiving files, smbclient uses an 335 internal memory buffer by default of size 64512 bytes. This command 336 allows this size to be set to any range between 16384 (0x4000) bytes 337 and 16776960 (0xFFFF00) bytes. Larger sizes may mean more efficient 338 data transfer as smbclient will try and use the most efficient 339 read and write calls for the connected server. 340 </p></dd><dt><span class="term">lcd [directory name]</span></dt><dd><p>If <em class="replaceable"><code>directory name</code></em> is specified, the current 341 working directory on the local machine will be changed to 342 the directory specified. This operation will fail if for any 343 reason the specified directory is inaccessible. </p><p>If no directory name is specified, the name of the 344 current working directory on the local machine will be reported. 345 </p></dd><dt><span class="term">link target linkname</span></dt><dd><p>This command depends on the server supporting the CIFS 346 UNIX extensions and will fail if the server does not. The client requests that the server 347 create a hard link between the linkname and target files. The linkname file 348 must not exist. 349 </p></dd><dt><span class="term">listconnect</span></dt><dd><p>Show the current connections held for DFS purposes. 350 </p></dd><dt><span class="term">lock <filenum> <r|w> <hex-start> <hex-len></span></dt><dd><p>This command depends on the server supporting the CIFS 351 UNIX extensions and will fail if the server does not. Tries to set a POSIX 352 fcntl lock of the given type on the given range. Used for internal Samba testing purposes. 353 </p></dd><dt><span class="term">logon <username> <password></span></dt><dd><p>Establishes a new vuid for this session by logging on again. 354 Replaces the current vuid. Prints out the new vuid. Used for internal Samba testing purposes. 355 </p></dd><dt><span class="term">lowercase</span></dt><dd><p>Toggle lowercasing of filenames for the get and 356 mget commands. 357 </p><p>When lowercasing is toggled ON, local filenames are converted 358 to lowercase when using the get and mget commands. This is 359 often useful when copying (say) MSDOS files from a server, because 360 lowercase filenames are the norm on UNIX systems. </p></dd><dt><span class="term">ls <mask></span></dt><dd><p>See the dir command above. </p></dd><dt><span class="term">mask <mask></span></dt><dd><p>This command allows the user to set up a mask 361 which will be used during recursive operation of the mget and 362 mput commands. </p><p>The masks specified to the mget and mput commands act as 363 filters for directories rather than files when recursion is 364 toggled ON. </p><p>The mask specified with the mask command is necessary 365 to filter files within those directories. For example, if the 366 mask specified in an mget command is "source*" and the mask 367 specified with the mask command is "*.c" and recursion is 368 toggled ON, the mget command will retrieve all files matching 369 "*.c" in all directories below and including all directories 370 matching "source*" in the current working directory. </p><p>Note that the value for mask defaults to blank (equivalent 371 to "*") and remains so until the mask command is used to change it. 372 It retains the most recently specified value indefinitely. To 373 avoid unexpected results it would be wise to change the value of 374 mask back to "*" after using the mget or mput commands. </p></dd><dt><span class="term">md <directory name></span></dt><dd><p>See the mkdir command. </p></dd><dt><span class="term">mget <mask></span></dt><dd><p>Copy all files matching <em class="replaceable"><code>mask</code></em> from the server to 375 the machine running the client. </p><p>Note that <em class="replaceable"><code>mask</code></em> is interpreted differently during recursive 376 operation and non-recursive operation - refer to the recurse and 377 mask commands for more information. Note that all transfers in 378 <code class="literal">smbclient</code> are binary. See also the lowercase command. </p></dd><dt><span class="term">mkdir <directory name></span></dt><dd><p>Create a new directory on the server (user access 379 privileges permitting) with the specified name. </p></dd><dt><span class="term">more <file name></span></dt><dd><p>Fetch a remote file and view it with the contents 380 of your PAGER environment variable. 381 </p></dd><dt><span class="term">mput <mask></span></dt><dd><p>Copy all files matching <em class="replaceable"><code>mask</code></em> in the current working 382 directory on the local machine to the current working directory on 383 the server. </p><p>Note that <em class="replaceable"><code>mask</code></em> is interpreted differently during recursive 384 operation and non-recursive operation - refer to the recurse and mask 385 commands for more information. Note that all transfers in <code class="literal">smbclient</code> 386 are binary. </p></dd><dt><span class="term">posix</span></dt><dd><p>Query the remote server to see if it supports the CIFS UNIX 387 extensions and prints out the list of capabilities supported. If so, turn 388 on POSIX pathname processing and large file read/writes (if available),. 389 </p></dd><dt><span class="term">posix_encrypt <domain> <username> <password></span></dt><dd><p>This command depends on the server supporting the CIFS 390 UNIX extensions and will fail if the server does not. Attempt to negotiate 391 SMB encryption on this connection. If smbclient connected with kerberos 392 credentials (-k) the arguments to this command are ignored and the kerberos 393 credentials are used to negotiate GSSAPI signing and sealing instead. See 394 also the -e option to smbclient to force encryption on initial connection. 395 This command is new with Samba 3.2. 396 </p></dd><dt><span class="term">posix_open <filename> <octal mode></span></dt><dd><p>This command depends on the server supporting the CIFS 397 UNIX extensions and will fail if the server does not. Opens a remote file 398 using the CIFS UNIX extensions and prints a fileid. Used for internal Samba 399 testing purposes. 400 </p></dd><dt><span class="term">posix_mkdir <directoryname> <octal mode></span></dt><dd><p>This command depends on the server supporting the CIFS 401 UNIX extensions and will fail if the server does not. Creates a remote directory 402 using the CIFS UNIX extensions with the given mode. 403 </p></dd><dt><span class="term">posix_rmdir <directoryname></span></dt><dd><p>This command depends on the server supporting the CIFS 404 UNIX extensions and will fail if the server does not. Deletes a remote directory 405 using the CIFS UNIX extensions. 406 </p></dd><dt><span class="term">posix_unlink <filename></span></dt><dd><p>This command depends on the server supporting the CIFS 407 UNIX extensions and will fail if the server does not. Deletes a remote file 408 using the CIFS UNIX extensions. 409 </p></dd><dt><span class="term">print <file name></span></dt><dd><p>Print the specified file from the local machine 410 through a printable service on the server. </p></dd><dt><span class="term">prompt</span></dt><dd><p>Toggle prompting for filenames during operation 411 of the mget and mput commands. </p><p>When toggled ON, the user will be prompted to confirm 412 the transfer of each file during these commands. When toggled 413 OFF, all specified files will be transferred without prompting. 414 </p></dd><dt><span class="term">put <local file name> [remote file name]</span></dt><dd><p>Copy the file called <code class="filename">local file name</code> from the 415 machine running the client to the server. If specified, 416 name the remote copy <code class="filename">remote file name</code>. Note that all transfers 417 in <code class="literal">smbclient</code> are binary. See also the lowercase command. 418 </p></dd><dt><span class="term">queue</span></dt><dd><p>Displays the print queue, showing the job id, 419 name, size and current status. </p></dd><dt><span class="term">quit</span></dt><dd><p>See the exit command. </p></dd><dt><span class="term">readlink symlinkname</span></dt><dd><p>This command depends on the server supporting the CIFS 420 UNIX extensions and will fail if the server does not. Print 421 the value of the symlink "symlinkname". 422 </p></dd><dt><span class="term">rd <directory name></span></dt><dd><p>See the rmdir command. </p></dd><dt><span class="term">recurse</span></dt><dd><p>Toggle directory recursion for the commands mget 423 and mput. </p><p>When toggled ON, these commands will process all directories 424 in the source directory (i.e., the directory they are copying 425 from ) and will recurse into any that match the mask specified 426 to the command. Only files that match the mask specified using 427 the mask command will be retrieved. See also the mask command. 428 </p><p>When recursion is toggled OFF, only files from the current 429 working directory on the source machine that match the mask specified 430 to the mget or mput commands will be copied, and any mask specified 431 using the mask command will be ignored. </p></dd><dt><span class="term">rename <old filename> <new filename></span></dt><dd><p>Rename files in the current working directory on the 432 server from <em class="replaceable"><code>old filename</code></em> to 433 <em class="replaceable"><code>new filename</code></em>. </p></dd><dt><span class="term">rm <mask></span></dt><dd><p>Remove all files matching <em class="replaceable"><code>mask</code></em> from the current 434 working directory on the server. </p></dd><dt><span class="term">rmdir <directory name></span></dt><dd><p>Remove the specified directory (user access 435 privileges permitting) from the server. </p></dd><dt><span class="term">setmode <filename> <perm=[+|\-]rsha></span></dt><dd><p>A version of the DOS attrib command to set 436 file permissions. For example: </p><p><code class="literal">setmode myfile +r </code></p><p>would make myfile read only. </p></dd><dt><span class="term">showconnect</span></dt><dd><p>Show the currently active connection held for DFS purposes. 437 </p></dd><dt><span class="term">stat file</span></dt><dd><p>This command depends on the server supporting the CIFS 438 UNIX extensions and will fail if the server does not. The client requests the 439 UNIX basic info level and prints out the same info that the Linux stat command 440 would about the file. This includes the size, blocks used on disk, file type, 441 permissions, inode number, number of links and finally the three timestamps 442 (access, modify and change). If the file is a special file (symlink, character or 443 block device, fifo or socket) then extra information may also be printed. 444 </p></dd><dt><span class="term">symlink target linkname</span></dt><dd><p>This command depends on the server supporting the CIFS 445 UNIX extensions and will fail if the server does not. The client requests that the server 446 create a symbolic hard link between the target and linkname files. The linkname file 447 must not exist. Note that the server will not create a link to any path that lies 448 outside the currently connected share. This is enforced by the Samba server. 449 </p></dd><dt><span class="term">tar <c|x>[IXbgNa]</span></dt><dd><p>Performs a tar operation - see the <em class="parameter"><code>-T 450 </code></em> command line option above. Behavior may be affected 451 by the tarmode command (see below). Using g (incremental) and N 452 (newer) will affect tarmode settings. Note that using the "-" option 453 with tar x may not work - use the command line option instead. 454 </p></dd><dt><span class="term">blocksize <blocksize></span></dt><dd><p>Blocksize. Must be followed by a valid (greater 455 than zero) blocksize. Causes tar file to be written out in 456 <em class="replaceable"><code>blocksize</code></em>*TBLOCK (usually 512 byte) blocks. </p></dd><dt><span class="term">tarmode <full|inc|reset|noreset></span></dt><dd><p>Changes tar's behavior with regard to archive 457 bits. In full mode, tar will back up everything regardless of the 458 archive bit setting (this is the default mode). In incremental mode, 459 tar will only back up files with the archive bit set. In reset mode, 460 tar will reset the archive bit on all files it backs up (implies 461 read/write share). </p></dd><dt><span class="term">unlock <filenum> <hex-start> <hex-len></span></dt><dd><p>This command depends on the server supporting the CIFS 462 UNIX extensions and will fail if the server does not. Tries to unlock a POSIX 463 fcntl lock on the given range. Used for internal Samba testing purposes. 464 </p></dd><dt><span class="term">volume</span></dt><dd><p>Prints the current volume name of the share. 465 </p></dd><dt><span class="term">vuid <number></span></dt><dd><p>Changes the currently used vuid in the protocol to 466 the given arbitrary number. Without an argument prints out the current 467 vuid being used. Used for internal Samba testing purposes. 468 </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2534407"></a><h2>NOTES</h2><p>Some servers are fussy about the case of supplied usernames, 469 passwords, share names (AKA service names) and machine names. 470 If you fail to connect try giving all parameters in uppercase. 471 </p><p>It is often necessary to use the -n option when connecting 472 to some types of servers. For example OS/2 LanManager insists 473 on a valid NetBIOS name being used, so you need to supply a valid 474 name that would be known to the server.</p><p>smbclient supports long file names where the server 475 supports the LANMAN2 protocol or above. </p></div><div class="refsect1" lang="en"><a name="id2534432"></a><h2>ENVIRONMENT VARIABLES</h2><p>The variable <code class="envar">USER</code> may contain the 476 username of the person using the client. This information is 477 used only if the protocol level is high enough to support 478 session-level passwords.</p><p>The variable <code class="envar">PASSWD</code> may contain 479 the password of the person using the client. This information is 480 used only if the protocol level is high enough to support 481 session-level passwords. </p><p>The variable <code class="envar">LIBSMB_PROG</code> may contain 482 the path, executed with system(), which the client should connect 483 to instead of connecting to a server. This functionality is primarily 484 intended as a development aid, and works best when using a LMHOSTS 485 file</p></div><div class="refsect1" lang="en"><a name="id2534468"></a><h2>INSTALLATION</h2><p>The location of the client program is a matter for 486 individual system administrators. The following are thus 487 suggestions only. </p><p>It is recommended that the smbclient software be installed 488 in the <code class="filename">/usr/local/samba/bin/</code> or <code class="filename"> 489 /usr/samba/bin/</code> directory, this directory readable 490 by all, writeable only by root. The client program itself should 491 be executable by all. The client should <span class="emphasis"><em>NOT</em></span> be 492 setuid or setgid! </p><p>The client log files should be put in a directory readable 493 and writeable only by the user. </p><p>To test the client, you will need to know the name of a 494 running SMB/CIFS server. It is possible to run <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> as an ordinary user - running that server as a daemon 495 on a user-accessible port (typically any port number over 1024) 496 would provide a suitable test server. </p></div><div class="refsect1" lang="en"><a name="id2534520"></a><h2>DIAGNOSTICS</h2><p>Most diagnostics issued by the client are logged in a 497 specified log file. The log file name is specified at compile time, 498 but may be overridden on the command line. </p><p>The number and nature of diagnostics available depends 499 on the debug level used by the client. If you have problems, 500 set the debug level to 3 and peruse the log files. </p></div><div class="refsect1" lang="en"><a name="id2534539"></a><h2>VERSION</h2><p>This man page is correct for version 3.2 of the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id2534550"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities 501 were created by Andrew Tridgell. Samba is now developed 502 by the Samba Team as an Open Source project similar 503 to the way the Linux kernel is developed.</p><p>The original Samba man pages were written by Karl Auer. 504 The man page sources were converted to YODL format (another 505 excellent piece of Open Source software, available at <a class="ulink" href="ftp://ftp.icce.rug.nl/pub/unix/" target="_top"> 506 ftp://ftp.icce.rug.nl/pub/unix/</a>) and updated for the Samba 2.0 507 release by Jeremy Allison. The conversion to DocBook for 508 Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 509 was done by Alexander Bokovoy.</p></div></div></body></html> 510