'\" t
.\"     Title: smbclient
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 08/09/2022
.\"    Manual: User Commands
.\"    Source: Samba 4.16.4
.\"  Language: English
.\"
.TH "SMBCLIENT" "1" "08/09/2022" "Samba 4\&.16\&.4" "User Commands"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
smbclient \- ftp\-like client to access SMB/CIFS resources on servers
.SH "SYNOPSIS"
.HP \w'\ 'u
smbclient [\-M|\-\-message=HOST] [\-I|\-\-ip\-address=IP] [\-E|\-\-stderr] [\-L|\-\-list=HOST] [\-T|\-\-tar=<c|x>IXFvgbNan] [\-D|\-\-directory=DIR] [\-b|\-\-send\-buffer=BYTES] [\-t|\-\-timeout=SECONDS] [\-p|\-\-port=PORT] [\-g|\-\-grepable] [\-q|\-\-quiet] [\-B|\-\-browse] [\-?|\-\-help] [\-\-usage] [\-d|\-\-debuglevel=DEBUGLEVEL] [\-\-debug\-stdout] [\-s|\-\-configfile=CONFIGFILE] [\-\-option=name=value] [\-l|\-\-log\-basename=LOGFILEBASE] [\-\-leak\-report] [\-\-leak\-report\-full] [\-R|\-\-name\-resolve=NAME\-RESOLVE\-ORDER] [\-O|\-\-socket\-options=SOCKETOPTIONS] [\-m|\-\-max\-protocol=MAXPROTOCOL] [\-n|\-\-netbiosname=NETBIOSNAME] [\-\-netbios\-scope=SCOPE] [\-W|\-\-workgroup=WORKGROUP] [\-\-realm=REALM] [\-U|\-\-user=[DOMAIN/]USERNAME%[PASSWORD]] [\-N|\-\-no\-pass] [\-\-password=STRING] [\-\-pw\-nt\-hash] [\-A|\-\-authentication\-file=FILE] [\-P|\-\-machine\-pass] [\-\-simple\-bind\-dn=DN] [\-\-use\-kerberos=desired|required|off] [\-\-use\-krb5\-ccache=CCACHE] [\-\-use\-winbind\-ccache] [\-\-client\-protection=sign|encrypt|off] [\-V|\-\-version] [\-c|\-\-command=STRING]
.SH "DESCRIPTION"
.PP
This tool is part of the
\fBsamba\fR(7)
suite\&.
.PP
smbclient
is a client that can \*(Aqtalk\*(Aq to an SMB/CIFS server\&. It offers an interface similar to that of the ftp program (see
\fBftp\fR(1))\&. Operations include things like getting files from the server to the local machine, putting files from the local machine to the server, retrieving directory information from the server and so on\&.
.SH "OPTIONS"
.PP
servicename
.RS 4
servicename is the name of the service you want to use on the server\&. A service name takes the form
//server/service
where
\fIserver \fR
is the NetBIOS name of the SMB/CIFS server offering the desired service and
\fIservice\fR
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
.sp
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\&.
.sp
The server name is looked up according to either the
\fI\-R|\-\-name\-resolve\fR
parameter to
smbclient
or using the name resolve order parameter in the
\fBsmb.conf\fR(5)
file, allowing an administrator to change the order and methods by which server names are looked up\&.
.RE
.PP
password
.RS 4
The password required to access the specified service on the specified server\&. If this parameter is supplied, the
\fI\-N\fR
option (suppress password prompt) is assumed\&.
.sp
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
\fI\-U\fR
option (see below)) and the
\fI\-N\fR
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\&.)
.sp
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\&.
.sp
Be cautious about including passwords in scripts\&.
.RE
.PP
\-M|\-\-message NetBIOS name
.RS 4
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 end\&.
.sp
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 occur\&.
.sp
The message is also automatically truncated if the message is over 1600 bytes, as this is the limit of the protocol\&.
.sp
One useful trick is to pipe the message through
smbclient\&. For example: smbclient \-M FRED < mymessage\&.txt will send the message in the file
mymessage\&.txt
to the machine FRED\&.
.sp
You may also find the
\fI\-U\fR
and
\fI\-I\fR
options useful, as they allow you to control the FROM and TO parts of the message\&.
.sp
See the
\fImessage command\fR
parameter in the
\fBsmb.conf\fR(5)
for a description of how to handle incoming WinPopup messages in Samba\&.
.sp
\fINote\fR: Copy WinPopup into the startup group on your WfWg PCs if you want them to always be able to receive messages\&.
.RE
.PP
\-p|\-\-port port
.RS 4
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 default\&.
.RE
.PP
\-g|\-\-grepable
.RS 4
This parameter provides combined with
\fI\-L\fR
easy parseable output that allows processing with utilities such as grep and cut\&.
.RE
.PP
\-m|\-\-max\-protocol protocol
.RS 4
This allows the user to select the highest SMB protocol level that smbclient will use to connect to the server\&. By default this is set to highest available SMB3 protocol version\&. To connect using SMB2 or SMB1 protocol, use the strings SMB2 or NT1 respectively\&. Note that to connect to a Windows 2012 server with encrypted transport selecting a max\-protocol of SMB3 is required\&.
.RE
.PP
\-P|\-\-machine\-pass
.RS 4
Make queries to the external server using the machine account of the local server\&.
.RE
.PP
\-I|\-\-ip\-address IP\-address
.RS 4
\fIIP address\fR
is the address of the server to connect to\&. It should be specified in standard "a\&.b\&.c\&.d" notation\&.
.sp
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\&.
.sp
There is no default for this parameter\&. If not supplied, it will be determined automatically by the client as described above\&.
.RE
.PP
\-E|\-\-stderr
.RS 4
This parameter causes the client to write messages to the standard error stream (stderr) rather than to the standard output stream\&.
.sp
By default, the client writes messages to standard output \- typically the user\*(Aqs tty\&.
.RE
.PP
\-L|\-\-list
.RS 4
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
\fI\-I \fR
option may be useful if your NetBIOS names don\*(Aqt match your TCP/IP DNS host names or if you are trying to reach a host on another network\&.
.RE
.PP
\-b|\-\-send\-buffer buffersize
.RS 4
When sending or receiving files, smbclient uses an internal buffer sized by the maximum number of allowed requests to the connected server\&. This command allows this size to be set to any range between 0 (which means use the default server controlled size) bytes and 16776960 (0xFFFF00) bytes\&. Using the server controlled size is the most efficient as smbclient will pipeline as many simultaneous reads or writes needed to keep the server as busy as possible\&. Setting this to any other size will slow down the transfer\&. This can also be set using the
iosize
command inside smbclient\&.
.RE
.PP
\-B|\-\-browse
.RS 4
Browse SMB servers using DNS\&.
.RE
.PP
\-t|\-\-timeout <timeout\-seconds>
.RS 4
This allows the user to tune the default timeout used for each SMB request\&. The default setting is 20 seconds\&. Increase it if requests to the server sometimes time out\&. This can happen when SMB3 encryption is selected and smbclient is overwhelming the server with requests\&. This can also be set using the
timeout
command inside smbclient\&.
.RE
.PP
\-T|\-\-tar tar options
.RS 4
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 are:
.RS
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fIc\fR
\- Create a tar backup archive on the local system\&. 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
\fIx\fR
flag\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fIn\fR
\- In combination with the
\fIc\fR
flag, do not actually create the archive, instead perform a dry run that attempts everything that involved in creation other than writing the file\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fIx\fR
\- 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
\fIc\fR
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\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fII\fR
\- Include files and directories\&. Is the default behavior when filenames are specified above\&. Causes 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
\fIr\fR
below\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fIX\fR
\- Exclude files and directories\&. Causes files to be excluded from an extract or create\&. See example below\&. Filename globbing works in one of two ways\&. See
\fIr\fR
below\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fIF\fR
\- File containing a list of files and directories\&. The
\fIF\fR
causes the name following the tarfile to create to be read as a filename that contains a list of files and directories 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
\fIr\fR
below\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fIb\fR
\- Blocksize\&. Must be followed by a valid (greater than zero) blocksize\&. Causes tar file to be written out in blocksize*TBLOCK (512 byte) blocks\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fIg\fR
\- Incremental\&. Only back up files that have the archive bit set\&. Useful only with the
\fIc\fR
flag\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fIv\fR
\- Verbose\&. Makes tar print out the files being processed\&. By default tar is not verbose\&. This is the same as tarmode verbose\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fIr\fR
\- Use wildcard matching to include or exclude\&. Deprecated\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fIN\fR
\- 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
\fIc\fR
flag\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fIa\fR
\- Set archive bit\&. Causes the archive bit to be reset when a file is backed up\&. Useful with the
\fIg\fR
and
\fIc\fR
flags\&.
.RE
.sp
.RE
\fITar Long File Names\fR
.sp
smbclient\*(Aqs 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\*(Aqs tar option places all files in the archive with relative names, not absolute names\&.
.sp
\fITar Filenames\fR
.sp
All file names can be given as DOS path names (with \*(Aq\e\e\*(Aq as the component separator) or as UNIX path names (with \*(Aq/\*(Aq as the component separator)\&.
.sp
\fIExamples\fR
.sp
Restore from tar file
backup\&.tar
into myshare on mypc (no password on share)\&.
.sp
smbclient //mypc/myshare "" \-N \-Tx backup\&.tar
.sp
Restore everything except
users/docs
.sp
smbclient //mypc/myshare "" \-N \-TXx backup\&.tar users/docs
.sp
Create a tar file of the files beneath
users/docs\&.
.sp
smbclient //mypc/myshare "" \-N \-Tc backup\&.tar users/docs
.sp
Create the same tar file as above, but now use a DOS path name\&.
.sp
smbclient //mypc/myshare "" \-N \-Tc backup\&.tar users\eedocs
.sp
Create a tar file of the files listed in the file
tarlist\&.
.sp
smbclient //mypc/myshare "" \-N \-TcF backup\&.tar tarlist
.sp
Create a tar file of all the files and directories in the share\&.
.sp
smbclient //mypc/myshare "" \-N \-Tc backup\&.tar *
.RE
.PP
\-D|\-\-directory initial directory
.RS 4
Change to initial directory before starting\&. Probably only of any use with the tar \-T option\&.
.RE
.PP
\-c|\-\-command command string
.RS 4
command string is a semicolon\-separated list of commands to be executed instead of prompting from stdin\&.
\fI \-N\fR
is implied by
\fI\-c\fR\&.
.sp
This is particularly useful in scripts and for printing stdin to the server, e\&.g\&.
\-c \*(Aqprint \-\*(Aq\&.
.RE
.PP
\-?|\-\-help
.RS 4
Print a summary of command line options\&.
.RE
.PP
\-\-usage
.RS 4
Display brief usage message\&.
.RE
.PP
\-d|\-\-debuglevel=DEBUGLEVEL
.RS 4
\fIlevel\fR
is an integer from 0 to 10\&. The default value if this parameter is not specified is 1 for client applications\&.
.sp
The higher this value, the more detail will be logged to the log files about the activities of the server\&. 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 carried out\&.
.sp
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\&.
.sp
Note that specifying this parameter here will override the
\m[blue]\fBlog level\fR\m[]
parameter in the
smb\&.conf
file\&.
.RE
.PP
\-\-debug\-stdout
.RS 4
This will redirect debug output to STDOUT\&. By default all clients are logging to STDERR\&.
.RE
.PP
\-\-configfile=<configuration file>
.RS 4
The file specified contains the configuration details required by the client\&. The information in this file can be general for client and server or only provide client specific like options such as
\m[blue]\fBclient smb encrypt\fR\m[]\&. See
smb\&.conf
for more information\&. The default configuration file name is determined at compile time\&.
.RE
.PP
\-\-option=<name>=<value>
.RS 4
Set the
\fBsmb.conf\fR(5)
option "<name>" to value "<value>" from the command line\&. This overrides compiled\-in defaults and options read from the configuration file\&. If a name or a value includes a space, wrap whole \-\-option=name=value into quotes\&.
.RE
.PP
\-l|\-\-log\-basename=logdirectory
.RS 4
Base directory name for log/debug files\&. The extension
\fB"\&.progname"\fR
will be appended (e\&.g\&. log\&.smbclient, log\&.smbd, etc\&.\&.\&.)\&. The log file is never removed by the client\&.
.RE
.PP
\-\-leak\-report
.RS 4
Enable talloc leak reporting on exit\&.
.RE
.PP
\-\-leak\-report\-full
.RS 4
Enable full talloc leak reporting on exit\&.
.RE
.PP
\-V|\-\-version
.RS 4
Prints the program version number\&.
.RE
.PP
\-R|\-\-name\-resolve=NAME\-RESOLVE\-ORDER
.RS 4
This option is used 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 best ist to wrap the whole \-\-name\-resolve=NAME\-RESOLVE\-ORDER into quotes\&.
.sp
The options are: "lmhosts", "host", "wins" and "bcast"\&. They cause names to be resolved as follows:
.RS
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBlmhosts\fR: 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
\fBlmhosts\fR(5)
for details) then any name type matches for lookup\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBhost\fR: 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\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBwins\fR: Query a name with the IP address listed in the
\fIwins server\fR
parameter\&. If no WINS server has been specified this method will be ignored\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBbcast\fR: Do a broadcast on each of the known local interfaces listed in the
\fIinterfaces\fR
parameter\&. This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet\&.
.RE
.sp
.RE
If this parameter is not set then the name resolve order defined in the
smb\&.conf
file parameter (\m[blue]\fBname resolve order\fR\m[]) will be used\&.
.sp
The default order is lmhosts, host, wins, bcast\&. Without this parameter or any entry in the
\m[blue]\fBname resolve order\fR\m[]
parameter of the
smb\&.conf
file, the name resolution methods will be attempted in this order\&.
.RE
.PP
\-O|\-\-socket\-options=SOCKETOPTIONS
.RS 4
TCP socket options to set on the client socket\&. See the socket options parameter in the
smb\&.conf
manual page for the list of valid options\&.
.RE
.PP
\-m|\-\-max\-protocol=MAXPROTOCOL
.RS 4
The value of the parameter (a string) is the highest protocol level that will be supported by the client\&.
.sp
Note that specifying this parameter here will override the
\m[blue]\fBclient max protocol\fR\m[]
parameter in the
smb\&.conf
file\&.
.RE
.PP
\-n|\-\-netbiosname=NETBIOSNAME
.RS 4
This option allows you to override the NetBIOS name that Samba uses for itself\&. This is identical to setting the
\m[blue]\fBnetbios name\fR\m[]
parameter in the
smb\&.conf
file\&. However, a command line setting will take precedence over settings in
smb\&.conf\&.
.RE
.PP
\-\-netbios\-scope=SCOPE
.RS 4
This specifies a NetBIOS scope that
nmblookup
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
\fIvery\fR
rarely used, only set this parameter if you are the system administrator in charge of all the NetBIOS systems you communicate with\&.
.RE
.PP
\-W|\-\-workgroup=WORKGROUP
.RS 4
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)\&.
.sp
Note that specifying this parameter here will override the
\m[blue]\fBworkgroup\fR\m[]
parameter in the
smb\&.conf
file\&.
.RE
.PP
\-r|\-\-realm=REALM
.RS 4
Set the realm for the domain\&.
.sp
Note that specifying this parameter here will override the
\m[blue]\fBrealm\fR\m[]
parameter in the
smb\&.conf
file\&.
.RE
.PP
\-U|\-\-user=[DOMAIN\e]USERNAME[%PASSWORD]
.RS 4
Sets the SMB username or username and password\&.
.sp
If %PASSWORD is not specified, the user will be prompted\&. The client will first check the
\fBUSER\fR
environment variable (which is also permitted to also contain the password seperated by a %), then the
\fBLOGNAME\fR
variable (which is not permitted to contain a password) and if either exists, the value is used\&. If these environmental variables are not found, the username found in a Kerberos Credentials cache may be used\&.
.sp
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\&.
.sp
Be cautious about including passwords in scripts or passing user\-supplied values onto the command line\&. For security it is better to let the Samba client tool ask for the password if needed, or obtain the password once with
kinit\&.
.sp
While Samba will attempt to scrub the password from the process title (as seen in ps), this is after startup and so is subject to a race\&.
.RE
.PP
\-N|\-\-no\-pass
.RS 4
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\&.
.sp
Unless a password is specified on the command line or this parameter is specified, the client will request a password\&.
.sp
If a password is specified on the command line and this option is also defined the password on the command line will be silently ignored and no password will be used\&.
.RE
.PP
\-\-password
.RS 4
Specify the password on the commandline\&.
.sp
Be cautious about including passwords in scripts or passing user\-supplied values onto the command line\&. For security it is better to let the Samba client tool ask for the password if needed, or obtain the password once with
kinit\&.
.sp
If \-\-password is not specified, the tool will check the
\fBPASSWD\fR
environment variable, followed by
\fBPASSWD_FD\fR
which is expected to contain an open file descriptor (FD) number\&.
.sp
Finally it will check
\fBPASSWD_FILE\fR
(containing a file path to be opened)\&. The file should only contain the password\&. Make certain that the permissions on the file restrict access from unwanted users!
.sp
While Samba will attempt to scrub the password from the process title (as seen in ps), this is after startup and so is subject to a race\&.
.RE
.PP
\-\-pw\-nt\-hash
.RS 4
The supplied password is the NT hash\&.
.RE
.PP
\-A|\-\-authentication\-file=filename
.RS 4
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:
.sp
.if n \{\
.RS 4
.\}
.nf
				username = <value>
				password = <value>
				domain   = <value>
			
.fi
.if n \{\
.RE
.\}
.sp
Make certain that the permissions on the file restrict access from unwanted users!
.RE
.PP
\-P|\-\-machine\-pass
.RS 4
Use stored machine account password\&.
.RE
.PP
\-\-simple\-bind\-dn=DN
.RS 4
DN to use for a simple bind\&.
.RE
.PP
\-\-use\-kerberos=desired|required|off
.RS 4
This parameter determines whether Samba client tools will try to authenticate using Kerberos\&. For Kerberos authentication you need to use dns names instead of IP addresses when connnecting to a service\&.
.sp
Note that specifying this parameter here will override the
\m[blue]\fBclient use kerberos\fR\m[]
parameter in the
smb\&.conf
file\&.
.RE
.PP
\-\-use\-krb5\-ccache=CCACHE
.RS 4
Specifies the credential cache location for Kerberos authentication\&.
.sp
This will set \-\-use\-kerberos=required too\&.
.RE
.PP
\-\-use\-winbind\-ccache
.RS 4
Try to use the credential cache by winbind\&.
.RE
.PP
\-\-client\-protection=sign|encrypt|off
.RS 4
Sets the connection protection the client tool should use\&.
.sp
Note that specifying this parameter here will override the
\m[blue]\fBclient protection\fR\m[]
parameter in the
smb\&.conf
file\&.
.sp
In case you need more fine grained control you can use:
\-\-option=clientsmbencrypt=OPTION,
\-\-option=clientipcsigning=OPTION,
\-\-option=clientsigning=OPTION\&.
.RE
.SH "OPERATIONS"
.PP
Once the client is running, the user is presented with a prompt :
.PP
smb:\e>
.PP
The backslash ("\e\e") indicates the current working directory on the server, and will change if the current working directory is changed\&.
.PP
The prompt indicates that the client is ready and waiting to carry out a user command\&. Each command is a single word, optionally followed by parameters specific to that command\&. Command and parameters are space\-delimited unless these notes specifically state otherwise\&. All commands are case\-insensitive\&. Parameters to commands may or may not be case sensitive, depending on the command\&.
.PP
You can specify file names which have spaces in them by quoting the name with double quotes, for example "a long file name"\&.
.PP
Parameters shown in square brackets (e\&.g\&., "[parameter]") are optional\&. If not given, the command will use suitable defaults\&. Parameters shown in angle brackets (e\&.g\&., "<parameter>") are required\&.
.PP
Note that all commands operating on the server are actually performed by issuing a request to the server\&. Thus the behavior may vary from server to server, depending on how the server was implemented\&.
.PP
The commands available are given here in alphabetical order\&.
.PP
? [command]
.RS 4
If
\fIcommand\fR
is specified, the ? command will display a brief informative message about the specified command\&. If no command is specified, a list of available commands will be displayed\&.
.RE
.PP
! [shell command]
.RS 4
If
\fIshell command\fR
is specified, the ! command will execute a shell locally and run the specified shell command\&. If no command is specified, a local shell will be run\&.
.RE
.PP
allinfo file
.RS 4
The client will request that the server return all known information about a file or directory (including streams)\&.
.RE
.PP
altname file
.RS 4
The client will request that the server return the "alternate" name (the 8\&.3 name) for a file or directory\&.
.RE
.PP
archive <number>
.RS 4
Sets the archive level when operating on files\&. 0 means ignore the archive bit, 1 means only operate on files with this bit set, 2 means only operate on files with this bit set and reset it after operation, 3 means operate on all files and reset it after operation\&. The default is 0\&.
.RE
.PP
backup
.RS 4
Toggle the state of the "backup intent" flag sent to the server on directory listings and file opens\&. If the "backup intent" flag is true, the server will try and bypass some file system checks if the user has been granted SE_BACKUP or SE_RESTORE privileges\&. This state is useful when performing a backup or restore operation\&.
.RE
.PP
blocksize <number>
.RS 4
Sets the blocksize parameter for a tar operation\&. The default is 20\&. Causes tar file to be written out in blocksize*TBLOCK (normally 512 byte) units\&.
.RE
.PP
cancel jobid0 [jobid1] \&.\&.\&. [jobidN]
.RS 4
The client will request that the server cancel the printjobs identified by the given numeric print job ids\&.
.RE
.PP
case_sensitive
.RS 4
Toggles the setting of the flag in SMB packets that tells the server to treat filenames as case sensitive\&. Set to OFF by default (tells file server to treat filenames as case insensitive)\&. Only currently affects Samba 3\&.0\&.5 and above file servers with the case sensitive parameter set to auto in the smb\&.conf\&.
.RE
.PP
cd <directory name>
.RS 4
If "directory name" is specified, the current working directory on the server will be changed to the directory specified\&. This operation will fail if for any reason the specified directory is inaccessible\&.
.sp
If no directory name is specified, the current working directory on the server will be reported\&.
.RE
.PP
chmod file mode in octal
.RS 4
This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not\&. The client requests that the server change the UNIX permissions to the given octal mode, in standard UNIX format\&.
.RE
.PP
chown file uid gid
.RS 4
This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not\&. The client requests that the server change the UNIX user and group ownership to the given decimal values\&. Note there is currently no way to remotely look up the UNIX uid and gid values for a given name\&. This may be addressed in future versions of the CIFS UNIX extensions\&.
.RE
.PP
close <fileid>
.RS 4
Closes a file explicitly opened by the open command\&. Used for internal Samba testing purposes\&.
.RE
.PP
del <mask>
.RS 4
The client will request that the server attempt to delete all files matching
\fImask\fR
from the current working directory on the server\&.
.RE
.PP
deltree <mask>
.RS 4
The client will request that the server attempt to delete all files and directories matching
\fImask\fR
from the current working directory on the server\&. Note this will recursively delete files and directories within the directories selected even without the recurse command being set\&. If any of the delete requests fail the command will stop processing at that point, leaving files and directories not yet processed untouched\&. This is by design\&.
.RE
.PP
dir <mask>
.RS 4
A list of the files matching
\fImask\fR
in the current working directory on the server will be retrieved from the server and displayed\&.
.RE
.PP
du <filename>
.RS 4
Does a directory listing and then prints out the current disk usage and free space on a share\&.
.RE
.PP
echo <number> <data>
.RS 4
Does an SMBecho request to ping the server\&. Used for internal Samba testing purposes\&.
.RE
.PP
exit
.RS 4
Terminate the connection with the server and exit from the program\&.
.RE
.PP
get <remote file name> [local file name]
.RS 4
Copy the file called
remote file name
from the server to the machine running the client\&. If specified, name the local copy
local file name\&. Note that all transfers in
smbclient
are binary\&. See also the lowercase command\&.
.RE
.PP
getfacl <filename>
.RS 4
Requires the server support the UNIX extensions\&. Requests and prints the POSIX ACL on a file\&.
.RE
.PP
hardlink <src> <dest>
.RS 4
Creates a hardlink on the server using Windows CIFS semantics\&.
.RE
.PP
help [command]
.RS 4
See the ? command above\&.
.RE
.PP
history
.RS 4
Displays the command history\&.
.RE
.PP
iosize <bytes>
.RS 4
When sending or receiving files, smbclient uses an internal buffer sized by the maximum number of allowed requests to the connected server\&. This command allows this size to be set to any range between 0 (which means use the default server controlled size) bytes and 16776960 (0xFFFF00) bytes\&. Using the server controlled size is the most efficient as smbclient will pipeline as many simultaneous reads or writes needed to keep the server as busy as possible\&. Setting this to any other size will slow down the transfer\&.
.RE
.PP
lcd [directory name]
.RS 4
If
\fIdirectory name\fR
is specified, the current working directory on the local machine will be changed to the directory specified\&. This operation will fail if for any reason the specified directory is inaccessible\&.
.sp
If no directory name is specified, the name of the current working directory on the local machine will be reported\&.
.RE
.PP
link target linkname
.RS 4
This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not\&. The client requests that the server create a hard link between the linkname and target files\&. The linkname file must not exist\&.
.RE
.PP
listconnect
.RS 4
Show the current connections held for DFS purposes\&.
.RE
.PP
lock <filenum> <r|w> <hex\-start> <hex\-len>
.RS 4
This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not\&. Tries to set a POSIX fcntl lock of the given type on the given range\&. Used for internal Samba testing purposes\&.
.RE
.PP
logon <username> <password>
.RS 4
Establishes a new vuid for this session by logging on again\&. Replaces the current vuid\&. Prints out the new vuid\&. Used for internal Samba testing purposes\&.
.RE
.PP
logoff
.RS 4
Logs the user off the server, closing the session\&. Used for internal Samba testing purposes\&.
.RE
.PP
lowercase
.RS 4
Toggle lowercasing of filenames for the get and mget commands\&.
.sp
When lowercasing is toggled ON, local filenames are converted to lowercase when using the get and mget commands\&. This is often useful when copying (say) MSDOS files from a server, because lowercase filenames are the norm on UNIX systems\&.
.RE
.PP
ls <mask>
.RS 4
See the dir command above\&.
.RE
.PP
mask <mask>
.RS 4
This command allows the user to set up a mask which will be used during recursive operation of the mget and mput commands\&.
.sp
The masks specified to the mget and mput commands act as filters for directories rather than files when recursion is toggled ON\&.
.sp
The mask specified with the mask command is necessary to filter files within those directories\&. For example, if the mask specified in an mget command is "source*" and the mask specified with the mask command is "*\&.c" and recursion is toggled ON, the mget command will retrieve all files matching "*\&.c" in all directories below and including all directories matching "source*" in the current working directory\&.
.sp
Note that the value for mask defaults to blank (equivalent to "*") and remains so until the mask command is used to change it\&. It retains the most recently specified value indefinitely\&. To avoid unexpected results it would be wise to change the value of mask back to "*" after using the mget or mput commands\&.
.RE
.PP
md <directory name>
.RS 4
See the mkdir command\&.
.RE
.PP
mget <mask>
.RS 4
Copy all files matching
\fImask\fR
from the server to the machine running the client\&.
.sp
Note that
\fImask\fR
is interpreted differently during recursive operation and non\-recursive operation \- refer to the recurse and mask commands for more information\&. Note that all transfers in
smbclient
are binary\&. See also the lowercase command\&.
.RE
.PP
mkdir <directory name>
.RS 4
Create a new directory on the server (user access privileges permitting) with the specified name\&.
.RE
.PP
more <file name>
.RS 4
Fetch a remote file and view it with the contents of your PAGER environment variable\&.
.RE
.PP
mput <mask>
.RS 4
Copy all files matching
\fImask\fR
in the current working directory on the local machine to the current working directory on the server\&.
.sp
Note that
\fImask\fR
is interpreted differently during recursive operation and non\-recursive operation \- refer to the recurse and mask commands for more information\&. Note that all transfers in
smbclient
are binary\&.
.RE
.PP
notify <dir name>
.RS 4
Query a directory for change notifications\&. This command issues a recursive filechangenotify call for all possible changes\&. As changes come in will print one line per change\&. See
https://msdn\&.microsoft\&.com/en\-us/library/dn392331\&.aspx
for a description of the action numbers that this command prints\&.
.sp
This command never ends, it waits for event indefinitely\&.
.RE
.PP
posix
.RS 4
Query the remote server to see if it supports the CIFS UNIX extensions and prints out the list of capabilities supported\&. If so, turn on POSIX pathname processing and large file read/writes (if available),\&.
.RE
.PP
posix_encrypt <domain> <username> <password>
.RS 4
This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not\&. Attempt to negotiate SMB encryption on this connection\&. If smbclient connected with kerberos credentials (\-k) the arguments to this command are ignored and the kerberos credentials are used to negotiate GSSAPI signing and sealing instead\&. See also the \-e option to smbclient to force encryption on initial connection\&. This command is new with Samba 3\&.2\&.
.RE
.PP
posix_open <filename> <octal mode>
.RS 4
This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not\&. Opens a remote file using the CIFS UNIX extensions and prints a fileid\&. Used for internal Samba testing purposes\&.
.RE
.PP
posix_mkdir <directoryname> <octal mode>
.RS 4
This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not\&. Creates a remote directory using the CIFS UNIX extensions with the given mode\&.
.RE
.PP
posix_rmdir <directoryname>
.RS 4
This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not\&. Deletes a remote directory using the CIFS UNIX extensions\&.
.RE
.PP
posix_unlink <filename>
.RS 4
This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not\&. Deletes a remote file using the CIFS UNIX extensions\&.
.RE
.PP
posix_whoami
.RS 4
Query the remote server for the user token using the CIFS UNIX extensions WHOAMI call\&. Prints out the guest status, user, group, group list and sid list that the remote server is using on behalf of the logged on user\&.
.RE
.PP
print <file name>
.RS 4
Print the specified file from the local machine through a printable service on the server\&.
.RE
.PP
prompt
.RS 4
Toggle prompting for filenames during operation of the mget and mput commands\&.
.sp
When toggled ON, the user will be prompted to confirm the transfer of each file during these commands\&. When toggled OFF, all specified files will be transferred without prompting\&.
.RE
.PP
put <local file name> [remote file name]
.RS 4
Copy the file called
local file name
from the machine running the client to the server\&. If specified, name the remote copy
remote file name\&. Note that all transfers in
smbclient
are binary\&. See also the lowercase command\&.
.RE
.PP
queue
.RS 4
Displays the print queue, showing the job id, name, size and current status\&.
.RE
.PP
quit
.RS 4
See the exit command\&.
.RE
.PP
readlink symlinkname
.RS 4
This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not\&. Print the value of the symlink "symlinkname"\&.
.RE
.PP
rd <directory name>
.RS 4
See the rmdir command\&.
.RE
.PP
recurse
.RS 4
Toggle directory recursion for the commands mget and mput\&.
.sp
When toggled ON, these commands will process all directories in the source directory (i\&.e\&., the directory they are copying from ) and will recurse into any that match the mask specified to the command\&. Only files that match the mask specified using the mask command will be retrieved\&. See also the mask command\&.
.sp
When recursion is toggled OFF, only files from the current working directory on the source machine that match the mask specified to the mget or mput commands will be copied, and any mask specified using the mask command will be ignored\&.
.RE
.PP
rename <old filename> <new filename> [\-f]
.RS 4
Rename files in the current working directory on the server from
\fIold filename\fR
to
\fInew filename\fR\&. The optional \-f switch allows for superseding the destination file, if it exists\&. This is supported by NT1 protocol dialect and SMB2 protocol family\&.
.RE
.PP
rm <mask>
.RS 4
Remove all files matching
\fImask\fR
from the current working directory on the server\&.
.RE
.PP
rmdir <directory name>
.RS 4
Remove the specified directory (user access privileges permitting) from the server\&.
.RE
.PP
scopy <source filename> <destination filename>
.RS 4
Attempt to copy a file on the server using the most efficient server\-side copy calls\&. Falls back to using read then write if server doesn\*(Aqt support server\-side copy\&.
.RE
.PP
setmode <filename> <perm=[+|\e\-]rsha>
.RS 4
A version of the DOS attrib command to set file permissions\&. For example:
.sp
setmode myfile +r
.sp
would make myfile read only\&.
.RE
.PP
showconnect
.RS 4
Show the currently active connection held for DFS purposes\&.
.RE
.PP
stat file
.RS 4
This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not\&. The client requests the UNIX basic info level and prints out the same info that the Linux stat command would about the file\&. This includes the size, blocks used on disk, file type, permissions, inode number, number of links and finally the three timestamps (access, modify and change)\&. If the file is a special file (symlink, character or block device, fifo or socket) then extra information may also be printed\&.
.RE
.PP
symlink target linkname
.RS 4
This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not\&. The client requests that the server create a symbolic hard link between the target and linkname files\&. The linkname file must not exist\&. Note that the server will not create a link to any path that lies outside the currently connected share\&. This is enforced by the Samba server\&.
.RE
.PP
tar <c|x>[IXbgNa]
.RS 4
Performs a tar operation \- see the
\fI\-T\fR
command line option above\&. Behavior may be affected by the tarmode command (see below)\&. Using g (incremental) and N (newer) will affect tarmode settings\&. Note that using the "\-" option with tar x may not work \- use the command line option instead\&.
.RE
.PP
blocksize <blocksize>
.RS 4
Blocksize\&. Must be followed by a valid (greater than zero) blocksize\&. Causes tar file to be written out in
\fIblocksize\fR*TBLOCK (512 byte) blocks\&.
.RE
.PP
tarmode <full|inc|reset|noreset|system|nosystem|hidden|nohidden|verbose|noverbose>
.RS 4
Changes tar\*(Aqs behavior with regard to DOS attributes\&. There are 4 modes which can be turned on or off\&.
.sp
Incremental mode (default off)\&. When off (using
full) tar will back up everything regardless of the
\fIarchive\fR
bit setting\&. When on (using
inc), tar will only back up files with the archive bit set\&.
.sp
Reset mode (default off)\&. When on (using
reset), tar will remove the archive bit on all files it backs up (implies read/write share)\&. Use
noreset
to turn off\&.
.sp
System mode (default on)\&. When off, tar will not backup system files\&. Use
nosystem
to turn off\&.
.sp
Hidden mode (default on)\&. When off, tar will not backup hidden files\&. Use
nohidden
to turn off\&.
.RE
.PP
timeout <per\-operation timeout in seconds>
.RS 4
This allows the user to tune the default timeout used for each SMB request\&. The default setting is 20 seconds\&. Increase it if requests to the server sometimes time out\&. This can happen when SMB3 encryption is selected and smbclient is overwhelming the server with requests\&.
.RE
.PP
unlock <filenum> <hex\-start> <hex\-len>
.RS 4
This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not\&. Tries to unlock a POSIX fcntl lock on the given range\&. Used for internal Samba testing purposes\&.
.RE
.PP
volume
.RS 4
Prints the current volume name of the share\&.
.RE
.PP
vuid <number>
.RS 4
Changes the currently used vuid in the protocol to the given arbitrary number\&. Without an argument prints out the current vuid being used\&. Used for internal Samba testing purposes\&.
.RE
.PP
tcon <sharename>
.RS 4
Establishes a new tree connect (connection to a share)\&. Replaces the current tree connect\&. Prints the new tid (tree id)\&. Used for internal Samba testing purposes\&.
.RE
.PP
tdis
.RS 4
Close the current share connection (tree disconnect)\&. Used for internal Samba testing purposes\&.
.RE
.PP
tid <number>
.RS 4
Changes the current tree id (tid) in the protocol to a new arbitrary number\&. Without an argument, it prints out the tid currently used\&. Used for internal Samba testing purposes\&.
.RE
.PP
utimes <filename> <create time> <access time> <write time> < change time>
.RS 4
Changes the timestamps on a file by name\&. Times should be specified in the format [YY]YY:MM:DD\-HH:MM:SS or \-1 for no change\&.
.RE
.SH "NOTES"
.PP
Some servers are fussy about the case of supplied usernames, passwords, share names (AKA service names) and machine names\&. If you fail to connect try giving all parameters in uppercase\&.
.PP
It is often necessary to use the \-n option when connecting to some types of servers\&. For example OS/2 LanManager insists on a valid NetBIOS name being used, so you need to supply a valid name that would be known to the server\&.
.PP
smbclient supports long file names where the server supports the LANMAN2 protocol or above\&.
.SH "ENVIRONMENT VARIABLES"
.PP
See the
\-\-user
and
\-\-password
options for details on ways to specify a username and password via an environment variable\&.
.SH "INSTALLATION"
.PP
The location of the client program is a matter for individual system administrators\&. The following are thus suggestions only\&.
.PP
It is recommended that the smbclient software be installed in the
/usr/local/samba/bin/
or
/usr/samba/bin/
directory, this directory readable by all, writeable only by root\&. The client program itself should be executable by all\&. The client should
\fINOT\fR
be setuid or setgid!
.PP
The client log files should be put in a directory readable and writeable only by the user\&.
.PP
To test the client, you will need to know the name of a running SMB/CIFS server\&. It is possible to run
\fBsmbd\fR(8)
as an ordinary user \- running that server as a daemon on a user\-accessible port (typically any port number over 1024) would provide a suitable test server\&.
.SH "DIAGNOSTICS"
.PP
Most diagnostics issued by the client are logged in a specified log file\&. The log file name is specified at compile time, but may be overridden on the command line\&.
.PP
The number and nature of diagnostics available depends on the debug level used by the client\&. If you have problems, set the debug level to 3 and peruse the log files\&.
.SH "VERSION"
.PP
This man page is part of version 4\&.16\&.4 of the Samba suite\&.
.SH "AUTHOR"
.PP
The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&.