Welcome to Linux Knowledge Base and Tutorial
"The place where you learn linux"
The ONE Campaign to make poverty history

 Create an AccountHome | Submit News | Your Account  

Tutorial Menu
Linux Tutorial Home
Table of Contents

· Introduction to Operating Systems
· Linux Basics
· Working with the System
· Shells and Utilities
· Editing Files
· Basic Administration
· The Operating System
· The X Windowing System
· The Computer Itself
· Networking
· System Monitoring
· Solving Problems
· Security
· Installing and Upgrading
· Linux and Windows

Glossary
MoreInfo
Man Pages
Linux Topics
Test Your Knowledge

Site Menu
Site Map
FAQ
Copyright Info
Terms of Use
Privacy Info
Disclaimer
WorkBoard
Thanks
Donations
Advertising
Masthead / Impressum
Your Account

Communication
Feedback
Forums
Private Messages
Surveys

Features
HOWTOs
News Archive
Submit News
Topics
User Articles
Web Links

Google
Google


The Web
linux-tutorial.info

Who's Online
There are currently, 277 guest(s) and 5 member(s) that are online.

You are an Anonymous user. You can register for free by clicking here

  

smbclient




SYNOPSIS

       smbclient servicename [ password ]  [ -b <buffer  size>  ]
       [ -d debuglevel ]  [ -D Directory ]  [ -U username ]  [ -W
       workgroup ]  [ -M <netbios name> ]  [ -m maxprotocol ]   [
       -A authfile ]  [ -N ]  [ -l logfile ]  [ -L <netbios name>
       ]  [ -I destinationIP ]  [ -E  <terminal  code>  ]   [  -c
       <command  string> ]  [ -i scope ]  [ -O <socket options> ]
       [ -p port ]  [ -R <name resolve order> ]  [ -s <smb config
       file> ]  [ -T<c|x>IXFqgbNan ]


DESCRIPTION

       This tool is part of the  Samba suite.

       smbclient  is  a  client  that  can  'talk' to an SMB/CIFS
       server. It offers an interface similar to that of the  ftp
       program (see ftp(1)).  Operations include things like get­
       ting 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.


OPTIONS

       servicename
              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 ser­
              vicename //smbserver/printer

              Note that the server name required is NOT necessar­
              ily 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.

       password
              The  password required to access the specified ser­
              vice 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

       -s smb.conf
              Specifies  the  location  of  the   all   important
              smb.conf file.

       -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 options.

       -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 res­
                olution, 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  interfaces  parameter.
                This is the least reliable of the name resolution
                methods as it depends on the target host being on
                a locally connected subnet.

       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 with­
              be lost, and no error message will occur.

              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 smb­
              client. For example:  cat mymessage.txt | smbclient
              -M FRED  will send the message in the  file  mymes­
              sage.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 messages.

       -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 and  rfc1002.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.

       -N     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 password.

       -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 let­
              ter 'A'.

              The default value if this parameter is  not  speci­
              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 over­
              ride the log level parameter in  the  smb.conf  (5)
              file.

       -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 default.

       -l logfilename
              If specified, logfilename specifies a base filename
              into which operational data from the running client
              will be logged.

              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.

       -h     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 sup­
              plied, it will be determined automatically  by  the
              client as described above.

       -E     This  parameter causes the client to write messages
              to the standard error stream (stderr)  rather  than

              If  the  password is not included in these environ­
              ment 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.

       -L     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  file­
              names  coming from the remote server. Usually Asian
              language multibyte UNIX implementations use differ­
              ent  character  sets  than  SMB/CIFS  servers  (EUC
              instead of  SJIS for example). Setting this parame­
              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 servers.

       -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 are :

              · 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 flag.

              · 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 c flag.

                file. Useful only with the c flag.

              · 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.

       Tar Filenames

       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).

       Examples

       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 users/docs

       Create a tar file of the files beneath  users/docs.

       smbclient //mypc/myshare "" -N -Tc backup.tar users/docs

       Create the same tar file as above, but now use a DOS  path
       name.

       smbclient //mypc/myshare "" -N -tc backup.tar users\edocs
              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 -'.


OPERATIONS

       Once the client is running, the user is presented  with  a
       prompt :

       smb:\>

       The  backslash  ("\") indicates the current working direc­
       tory on the server, and will change if the current working
       directory is changed.

       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.

       You  can  specify  file names which have spaces in them by
       quoting the name with double quotes, for example  "a  long
       file name".

       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.

       Note that all commands operating on the server  are  actu­
       ally  performed  by  issuing a request to the server. Thus
       the behavior may vary from server to server, depending  on
       how the server was implemented.

       The  commands  available  are  given  here in alphabetical
       order.

       ? [command]
              If command 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.

       ! [shell command]
              If  shell command is specified, the !  command will
              execute a shell locally and run the specified shell
              command.  If no command is specified, a local shell
              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.

       chown file uid gid
              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.

       cd [directory name]
              If "directory name" is specified, the current work­
              ing directory on the server will be changed to  the
              directory  specified.  This  operation will fail if
              for any reason the specified directory is  inacces­
              sible.

              If  no  directory  name  is  specified, the current
              working directory on the server will be reported.

       del <mask>
              The client will request that the server attempt  to
              delete  all  files  matching  mask from the current
              working directory on the server.

       dir <mask>
              A list of the files matching mask  in  the  current
              working  directory  on the server will be retrieved
              from the server and displayed.

       exit   Terminate the connection with the server  and  exit
              from the program.

       get <remote file name> [local file name]
              Copy  the  file  called  remote  file name from the
              server to the machine running the client. If speci­
              fied,  name  the  local  copy local file name. Note
              that all transfers in  smbclient  are  binary.  See
              also the lowercase command.

       help [command]
              See the ? command above.

       lcd [directory name]
              If directory name is specified, the current working
              directory on the local machine will be  changed  to
              the  directory  specified. This operation will fail

       lowercase
              Toggle  lowercasing  of  filenames  for the get and
              mget commands.

              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 file­
              names are the norm on UNIX systems.

       ls <mask>
              See the dir command above.

       mask <mask>
              This command allows the user to set up a mask which
              will be used during recursive operation of the mget
              and mput commands.

              The masks specified to the mget and  mput  commands
              act  as  filters  for directories rather than files
              when recursion is toggled ON.

              The mask specified with the mask command is  neces­
              sary  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 directo­
              ries  matching  "source*"  in  the  current working
              directory.

              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.

       md <directory name>
              See the mkdir command.

       mget <mask>
              Copy all files matching mask from the server to the
              machine running the client.

              Note  that  mask  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.
              are binary.

       print <file name>
              Print the specified file  from  the  local  machine
              through a printable service on the server.

              See also the printmode command.

       printmode <graphics or text>
              Set the print mode to suit either binary data (such
              as graphical information) or text. Subsequent print
              commands will use the currently set print mode.

       prompt Toggle  prompting for filenames during operation of
              the mget and mput commands.

              When toggled ON, the user will be prompted to  con­
              firm  the  transfer  of each file during these com­
              mands. When toggled OFF, all specified  files  will
              be transferred without prompting.

       put <local file name> [remote file name]
              Copy  the  file  called  local  file  name from the
              machine running the client to the server. If speci­
              fied,  name  the remote copy remote file name. Note
              that all transfers in  smbclient  are  binary.  See
              also the lowercase command.

       queue  Displays the print queue, showing the job id, name,
              size and current status.

       quit   See the exit command.

       rd <directory name>
              See the rmdir command.

       recurse
              Toggle directory recursion for  the  commands  mget
              and mput.

              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  com­
              mand.  Only  files  that  match  the mask specified
              using the mask command will be retrieved. See  also
              the mask command.

              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
              setmode myfile +r

              would make myfile read only.

       symlink source destination
              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  cre­
              ate  a  symbolic  hard  link between the source and
              destination files. The source 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.

       tar <c|x>[IXbgNa]
              Performs  a tar operation - see the -T command line
              option above. Behavior may be affected by the  tar­
              mode 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.

       blocksize <blocksize>
              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.

       tarmode <full|inc|reset|noreset>
              Changes tar's behavior with regard to archive bits.
              In full mode, tar will back up  everything  regard­
              less  of  the  archive  bit  setting  (this  is the
              default mode). In incremental mode, tar  will  only
              back  up  files  with the archive bit set. In reset
              mode, tar will reset the archive bit on  all  files
              it backs up (implies read/write share).


NOTES

       Some  servers  are  fussy about the case of supplied user­
       names, passwords, share  names  (AKA  service  names)  and
       machine  names.   If  you  fail  to connect try giving all
       parameters in uppercase.

       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.

       smbclient  supports  long file names where the server sup­
       ports the LANMAN2 protocol or above.


ENVIRONMENT VARIABLES

       The variable USER may contain the username of  the  person


INSTALLATION

       The location of the client program is a matter  for  indi­
       vidual  system administrators. The following are thus sug­
       gestions only.

       It is recommended that the smbclient software be installed
       in  the  /usr/local/samba/bin/  or  /usr/samba/bin/ direc­
       tory, this directory readable by all,  writeable  only  by
       root.  The  client  program itself should be executable by
       all. The client should NOT be setuid or setgid!

       The client log files should be put in a directory readable
       and writeable only by the user.

       To  test  the  client, you will need to know the name of a
       running SMB/CIFS server. It is possible to run smbd(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.


DIAGNOSTICS

       Most  diagnostics  issued  by  the  client are logged in a
       specified log file. The log file name is specified at com­
       pile time, but may be overridden on the command line.

       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.


VERSION

       This  man  page  is  correct  for version 2.2 of the Samba
       suite.


AUTHOR

       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.

       The  original  Samba  man pages were written by Karl Auer.
       The  man  page  sources  were  converted  to  YODL  format
       (another  excellent  piece of Open Source software, avail­
       able          at           ftp://ftp.icce.rug.nl/pub/unix/
       <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the
       Samba 2.0 release by Jeremy  Allison.  The  conversion  to
       DocBook for Samba 2.2 was done by Gerald Carter

                         19 November 2002            SMBCLIENT(1)
  
Show your Support for the Linux Tutorial

Purchase one of the products from our new online shop. For each product you purchase, the Linux Tutorial gets a portion of the proceeds to help keep us going.


Login
Nickname

Password

Security Code
Security Code
Type Security Code


Don't have an account yet? You can create one. As a registered user you have some advantages like theme manager, comments configuration and post comments with your name.

Help if you can!


Amazon Wish List

Did You Know?
You can help in many different ways.


Friends



Tell a Friend About Us

Bookmark and Share



Web site powered by PHP-Nuke

Is this information useful? At the very least you can help by spreading the word to your favorite newsgroups, mailing lists and forums.
All logos and trademarks in this site are property of their respective owner. The comments are property of their posters. Articles are the property of their respective owners. Unless otherwise stated in the body of the article, article content (C) 1994-2013 by James Mohr. All rights reserved. The stylized page/paper, as well as the terms "The Linux Tutorial", "The Linux Server Tutorial", "The Linux Knowledge Base and Tutorial" and "The place where you learn Linux" are service marks of James Mohr. All rights reserved.
The Linux Knowledge Base and Tutorial may contain links to sites on the Internet, which are owned and operated by third parties. The Linux Tutorial is not responsible for the content of any such third-party site. By viewing/utilizing this web site, you have agreed to our disclaimer, terms of use and privacy policy. Use of automated download software ("harvesters") such as wget, httrack, etc. causes the site to quickly exceed its bandwidth limitation and are therefore expressly prohibited. For more details on this, take a look here

PHP-Nuke Copyright © 2004 by Francisco Burzi. This is free software, and you may redistribute it under the GPL. PHP-Nuke comes with absolutely no warranty, for details, see the license.
Page Generation: 0.10 Seconds