servicename is the name of the service
you want to use on the server. A service name takes the form
//server/service where server
is the NetBIOS name of the SMB/CIFS server
offering the desired service and service
is the name of the service offered. Thus to connect to
the service "printer" on the SMB/CIFS server "smbserver",
you would use the servicename //smbserver/printer
Note that the server name required is NOT necessarily
the IP (DNS) host name of the server ! The name required is
a NetBIOS server name, which may or may not be the
same as the IP hostname of the machine running the server.
The server name is looked up according to either
the -R parameter to smbclient or
using the name resolve order parameter in the smb.conf file,
allowing an administrator to change the order and methods
by which server names are looked up.
The password required to access the specified
service on the specified server. If this parameter is
supplied, the -N option (suppress
password prompt) is assumed.
There is no default password. If no password is supplied
on the command line (either by using this parameter or adding
a password to the -U option (see
below)) and the -N option is not
specified, the client will prompt for a password, even if
the desired service does not require one. (If no password is
required, simply press ENTER to provide a null password.)
Note: Some servers (including OS/2 and Windows for
Workgroups) insist on an uppercase password. Lowercase
or mixed case passwords may be rejected by these servers.
Be cautious about including passwords in scripts.
- -s smb.conf
Specifies the location of the all important
- -O socket options
TCP socket options to set on the client
socket. See the socket options parameter in the smb.conf (5) manpage for the list of valid
- -R <name resolve order>
This option is used by the programs in the Samba
suite to determine what naming services and in what order to resolve
host names to IP addresses. The option takes a space-separated
string of different name resolution options.
The options are :"lmhosts", "host", "wins" and "bcast". They
cause names to be resolved as follows :
lmhosts : Lookup an IP
address in the Samba lmhosts file. If the line in lmhosts has
no name type attached to the NetBIOS name (see the lmhosts(5) for details) then
any name type matches for lookup.
host : Do a standard host
name to IP address resolution, using the system /etc/hosts
, NIS, or DNS lookups. This method of name resolution
is operating system dependent, for instance on IRIX or Solaris this
may be controlled by the /etc/nsswitch.conf
file). Note that this method is only used if the NetBIOS name
type being queried is the 0x20 (server) name type, otherwise
it is ignored.
wins : Query a name with
the IP address listed in the wins server
parameter. If no WINS server has
been specified this method will be ignored.
bcast : Do a broadcast on
each of the known local interfaces listed in the
parameter. This is the least reliable of the name resolution
methods as it depends on the target host being on a locally
If this parameter is not set then the name resolve order
defined in the smb.conf file parameter
(name resolve order) will be used.
The default order is lmhosts, host, wins, bcast and without
this parameter or any entry in the name resolve order
parameter of the smb.conf file the name resolution
methods will be attempted in this order.
- -M NetBIOS name
This options allows you to send messages, using
the "WinPopup" protocol, to another computer. Once a connection is
established you then type your message, pressing ^D (control-D) to
If the receiving computer is running WinPopup the user will
receive the message and probably a beep. If they are not running
WinPopup the message will be lost, and no error message will
The message is also automatically truncated if the message
is over 1600 bytes, as this is the limit of the protocol.
One useful trick is to cat the message through
smbclient. For example: cat mymessage.txt | smbclient -M FRED will
send the message in the file mymessage.txt
to the machine FRED.
You may also find the -U and
-I options useful, as they allow you to
control the FROM and TO parts of the message.
See the message command parameter in the smb.conf(5) for a description of how to handle incoming
WinPopup messages in Samba.
Note: Copy WinPopup into the startup group
on your WfWg PCs if you want them to always be able to receive
- -i scope
This specifies a NetBIOS scope that smbclient will
use to communicate with when generating NetBIOS names. For details
on the use of NetBIOS scopes, see rfc1001.txt
NetBIOS scopes are very rarely used, only set
this parameter if you are the system administrator in charge of all
the NetBIOS systems you communicate with.
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.
Unless a password is specified on the command line or
this parameter is specified, the client will request a
- -n NetBIOS name
By default, the client will use the local
machine's hostname (in uppercase) as its NetBIOS name. This parameter
allows you to override the host name and use whatever NetBIOS
name you wish.
- -d debuglevel
debuglevel is an integer from 0 to 10, or
the letter 'A'.
The default value if this parameter is not specified
The higher this value, the more detail will be logged to
the log files about the activities of the
client. At level 0, only critical errors and serious warnings will
be logged. Level 1 is a reasonable level for day to day running -
it generates a small amount of information about operations
Levels above 1 will generate considerable amounts of log
data, and should only be used when investigating a problem.
Levels above 3 are designed for use only by developers and
generate HUGE amounts of log data, most of which is extremely
cryptic. If debuglevel is set to the letter 'A', then all
debug messages will be printed. This setting
is for developers only (and people who really want
to know how the code works internally).
Note that specifying this parameter here will override
the log level parameter in the smb.conf (5)
- -p port
This number is the TCP port number that will be used
when making connections to the server. The standard (well-known)
TCP port number for an SMB/CIFS server is 139, which is the
- -l logfilename
If specified, logfilename specifies a base filename
into which operational data from the running client will be
The default base name is specified at compile time.
The base name is used to generate actual log file names.
For example, if the name specified was "log", the debug file
would be log.client.
The log file generated is never removed by the client.
Print the usage message for the client.
- -I IP-address
IP address 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 name resolve order
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
This parameter causes the client to write messages
to the standard error stream (stderr) rather than to the standard
By default, the client writes messages to standard output
- typically the user's tty.
- -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 exists, the
string is uppercased. Anything in these variables following a '%'
sign will be treated as the password. If these environment
variables are not found, the username GUEST
If the password is not included in these environment
variables (using the %pass syntax), smbclient 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 domain name, username and password. This
option is mainly provided for scripts where the admin doesn't
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 for more details.
Be cautious about including passwords in scripts or in
the PASSWD environment variable. Also, on
many systems the command line of a running process may be seen
via the ps command to be safe always allow
smbclient to prompt for a password and type
it in directly.
- -A filename
This option allows
you to specify a file from which to read the username, domain name, and
password used in the connection. The format of the file is
username = <value>
password = <value>
domain = <value>
If the domain parameter is missing the current workgroup name
is used instead. Make certain that the permissions on the file restrict
access from unwanted users.
This option allows you to look at what services
are available on a server. You use it as smbclient -L
host and a list should appear. The -I
option may be useful if your NetBIOS names don't
match your TCP/IP DNS host names or if you are trying to reach a
host on another network.
- -t terminal code
This option tells smbclient how to interpret
filenames coming from the remote server. Usually Asian language
multibyte UNIX implementations use different character sets than
SMB/CIFS servers (EUC instead of SJIS for example). Setting this parameter will let
smbclient convert between the UNIX filenames and
the SMB filenames correctly. This option has not been seriously tested
and may have some problems.
The terminal codes include CWsjis, CWeuc, CWjis7, CWjis8,
CWjunet, CWhex, CWcap. This is not a complete list, check the Samba
source code for the complete list.
- -b buffersize
This option changes the transmit/send buffer
size when getting or putting a file from/to the server. The default
is 65520 bytes. Setting this value smaller (to 1200 bytes) has been
observed to speed up file transfers to and from a Win9x server.
- -W WORKGROUP
Override the default workgroup (domain) specified
in the workgroup parameter of the smb.conf
file for this connection. This may be needed to connect to some
- -T tar options
smbclient may be used to create tar(1)
compatible backups of all the files on an SMB/CIFS
share. The secondary tar flags that can be given to this option
c - Create a tar file on UNIX.
Must be followed by the name of a tar file, tape device
or "-" for standard output. If using standard output you must
turn the log level to its lowest value -d0 to avoid corrupting
your tar file. This flag is mutually exclusive with the
x - Extract (restore) a local
tar file back to a share. Unless the -D option is given, the tar
files will be restored from the top level of the share. Must be
followed by the name of the tar file, device or "-" for standard
input. Mutually exclusive with the c flag.
Restored files have their creation times (mtime) set to the
date saved in the tar file. Directories currently do not get
their creation dates restored properly.
I - Include files and directories.
Is the default behavior when filenames are specified above. Causes
tar files to be included in an extract or create (and therefore
everything else to be excluded). See example below. Filename globbing
works in one of two ways. See r below.
X - Exclude files and directories.
Causes tar files to be excluded from an extract or create. See
example below. Filename globbing works in one of two ways now.
See r below.
b - Blocksize. Must be followed
by a valid (greater than zero) blocksize. Causes tar file to be
written out in blocksize*TBLOCK (usually 512 byte) blocks.
g - Incremental. Only back up
files that have the archive bit set. Useful only with the
q - Quiet. Keeps tar from printing
diagnostics as it works. This is the same as tarmode quiet.
r - Regular expression include
or exclude. Uses regular expression matching for
excluding or excluding files if compiled with HAVE_REGEX_H.
However this mode can be very slow. If not compiled with
HAVE_REGEX_H, does a limited wildcard match on '*' and '?'.
N - Newer than. Must be followed
by the name of a file whose date is compared against files found
on the share during a create. Only files newer than the file
specified are backed up to the tar file. Useful only with the
a - Set archive bit. Causes the
archive bit to be reset when a file is backed up. Useful with the
g and c flags.
Tar Long File Names
smbclient's tar option now supports long
file names both on backup and restore. However, the full path
name of the file must be less than 1024 bytes. Also, when
a tar archive is created, smbclient's tar option places all
files in the archive with relative names, not absolute names.
All file names can be given as DOS path names (with '\'
as the component separator) or as UNIX path names (with '/' as
the component separator).
Restore from tar file backup.tar into myshare on mypc
(no password on share).
smbclient //mypc/yshare "" -N -Tx backup.tar
Restore everything except users/docs
smbclient //mypc/myshare "" -N -TXx backup.tar
Create a tar file of the files beneath users/docs.
smbclient //mypc/myshare "" -N -Tc
Create the same tar file as above, but now use
a DOS path name.
smbclient //mypc/myshare "" -N -tc backup.tar
Create a tar file of all the files and directories in
smbclient //mypc/myshare "" -N -Tc backup.tar *
- -D initial directory
Change to initial directory before starting. Probably
only of any use with the tar -T option.
- -c command string
command string is a semicolon-separated list of
commands to be executed instead of prompting from stdin. -N is implied by -c.
This is particularly useful in scripts and for printing stdin
to the server, e.g. -c 'print -'.