git.gag.com Git - debian/amanda/blob - man/amsamba.8

   1 '\" t
   2 .\"     Title: amsamba
   3 .\"    Author: Jean-Louis Martineau <martineau@zmanda.com>
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
   5 .\"      Date: 10/18/2010
   6 .\"    Manual: System Administration Commands
   7 .\"    Source: Amanda 3.2.0
   8 .\"  Language: English
   9 .\"
  10 .TH "AMSAMBA" "8" "10/18/2010" "Amanda 3\&.2\&.0" "System Administration Commands"
  11 .\" -----------------------------------------------------------------
  12 .\" * set default formatting
  13 .\" -----------------------------------------------------------------
  14 .\" disable hyphenation
  15 .nh
  16 .\" disable justification (adjust text to left margin only)
  17 .ad l
  18 .\" -----------------------------------------------------------------
  19 .\" * MAIN CONTENT STARTS HERE *
  20 .\" -----------------------------------------------------------------
  21 .SH "NAME"
  22 amsamba \- Amanda Application to interface with smbclient
  23 .SH "DESCRIPTION"
  24 .PP
  25 Amsamba is an Amanda Application API script\&. It should not be run by users directly\&. It uses smbclient to backup and restore data\&.
  26 .PP
  27 The device name in the disklist must have the form \'//CIFSHOST/SHARE/SUBDIR\' where CIFSHOST is the CIFS host containing the data to be backed up, SHARE is the share to connect, and subdir is the subdirectory to backup\&. \'/subdir\' can be ommited, in which case the complete share is archived\&.
  28 .PP
  29 Unlike most applications, amsamba backs up and restores data located on a different system from that where amsamba itself runs\&. The host containing the data is the CIFS host\&. In practice, amsamba is usually run on the same system as the Amanda server, with a DLE like
  30 .sp
  31 .nf
  32 localhost "//CIFSHOST/SHARENAME" amsamba\-dumptype
  33 .fi
  34 .PP
  35 Include or exclude can be used, but not both\&. The path for \'exclude list\' or \'include list\' must be absolute path on the CIFS host\&. The estimate calculates the complete size of the share, without regard for include or exclude directives\&. It will be larger than the actual dump if you use include or exclude\&. Using \'estimate server\' in the dumptype could give better estimate\&.
  36 .SH "PROPERTIES"
  37 .PP
  38 This section lists the properties that control amsamba\'s functionality\&. See
  39 \fBamanda-applications\fR(7)
  40 for information on application properties and how they are configured\&.
  41 .PP
  42 SMBCLIENT\-PATH
  43 .RS 4
  44
  45 The path to the smbclient binary\&.  The default is set when Amanda is built by the
  46 \-\-with\-smbclient configure option\&.
  47 .RE
  48 .PP
  49 GNUTAR\-PATH
  50 .RS 4
  51
  52 The path to the gnutar binary\&.  The default is set when Amanda is built by the
  53 \-\-with\-gnutar configure option\&. gnutar is used to create the index\&.
  54 .RE
  55 .PP
  56 AMANDAPASS
  57 .RS 4
  58
  59 Location of the amandapass file, defaulting to "$CONFIG_DIR/amandapass"\&.
  60 Relative pathnames are relative to the configuration directory,
  61 "$CONFIG_DIR/<config>"\&.
  62 Note that this file is located on the client, not on the server\&.
  63 The format of the file is as follow:
  64 .nf
  65   Sharename User%Password Domain
  66 .fi
  67
  68 Sharename is \'//HOST/SHARE\' without the SUBDIR\&.
  69 Sharename can be quoted,
  70 it can be \'*\' to match all share,
  71 it can be \'//pc\-host/*\' to match all share on pc\-host\&.
  72 User is the username use to connect to the share\&.
  73 Password is the password use to connect to the share\&.
  74 \'%Password\' is optional if the user can connect to the share without password\&.
  75 \'User%Password\' is optional, the user \'guest\' without password is use to connect to the share\&.
  76 Domain is optional\&. Example:
  77 .nf
  78   //another\-pc/share otheruser%otherpw domain
  79   //another\-pc/share otheruser%otherpw
  80   //another\-pc/share myuser mydomain
  81   //another\-pc/share myuser
  82   //another\-pc/share
  83 .fi
  84 .RE
  85 .PP
  86 ALLOW\-ANONYMOUS
  87 .RS 4
  88
  89 This username without password is used to connect to the share if no matching entry is found in the amandapass file\&.
  90 .RE
  91 .PP
  92 DIRECTORY
  93 .RS 4
  94
  95 For restore command only, the data is recoved in that directory\&. Must be a unix path for "tar" RECOVER\-MODE or a smb path for "smb" recover\-MODE\&.
  96 .RE
  97 .PP
  98 RECOVER\-MODE
  99 .RS 4
 100
 101 "tar" or "smb", default to "tar"\&. If "tar", the data is recovered on the local machine, If "smb", the data is recovered on the smb client machine\&.
 102 .RE
 103 .SH "INCLUDE AND EXCLUDE LISTS"
 104 .PP
 105 This application supplies exclude lists via the
 106 \fBsmbclient\fR
 107 \fB\-TX\fR
 108 option\&. Normal shell\-style wildcard expressions, using * and ?, are not supported\&. All expressions are matched only from the base directory of the DLE\&. Expressions that match a directory may have a leading or trailing "/"\&. Example expressions:
 109 .sp
 110 .nf
 111   \&./temp\-files           # exclude top\-level dir "temp\-files" entirely
 112   \&./temp\-files/          # same
 113   /temp\-files            # same
 114   temp\-files             # same
 115   \&./temp\-files/*         # BAD: does nothing
 116   *\&.iso                  # BAD: does nothing
 117   proxy/local/cache      # exclude "cache" in dir "proxy/local"
 118 .fi
 119 .PP
 120 Include lists are supported only if excludes are not given\&. They are handled via the
 121 \fBsmbclient\fR
 122 \fB\-TI\fR
 123 option\&. Include matching is identical to the exclude matching described above\&.
 124 .SH "EXAMPLE"
 125 .nf
 126   define application app_amsamba {
 127     property "SMBCLIENT\-PATH" "/usr/bin/smbclient"
 128     property "GNUTAR\-PATH" "/bin/tar"
 129     property "AMANDAPASS" /etc/amandapass"
 130     property "ALLOW\-ANONYMOUS" "guest"
 131   }
 132 .fi
 133 .SH "SEE ALSO"
 134 .PP
 135 \fBamanda\fR(8),
 136 \fBamanda.conf\fR(5),
 137 \fBamanda-applications\fR(7)
 138 .PP
 139 The Amanda Wiki:
 140 : http://wiki.zmanda.com/
 141 .SH "AUTHOR"
 142 .PP
 143 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
 144 .RS 4
 145 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
 146 .RE