3 .\" Author: Jean-Louis Martineau <martineau@zmanda.com>
4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
6 .\" Manual: System Administration Commands
7 .\" Source: Amanda 3.3.3
10 .TH "AMSAMBA" "8" "01/10/2013" "Amanda 3\&.3\&.3" "System Administration Commands"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
25 .\" disable justification (adjust text to left margin only)
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
31 amsamba \- Amanda Application to interface with smbclient
34 Amsamba is an Amanda Application API script\&. It should not be run by users directly\&. It uses smbclient to backup and restore data\&.
38 in the disklist (DLE) must have the form \*(Aq//CIFSHOST/SHARE/SUBDIR\*(Aq 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\&. \*(Aq/subdir\*(Aq can be ommited, in which case the complete share is archived\&.
40 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
43 localhost "//CIFSHOST/SHARENAME" amsamba\-dumptype
46 Include or exclude can be used, but not both\&. The path for \*(Aqexclude list\*(Aq or \*(Aqinclude list\*(Aq 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 \*(Aqestimate server\*(Aq in the dumptype could give better estimate\&.
49 This section lists the properties that control amsamba\*(Aqs functionality\&. See
50 \fBamanda-applications\fR(7)
51 for information on application properties and how they are configured\&.
56 The path to the smbclient binary\&. The default is set when Amanda is built by the
57 \-\-with\-smbclient configure option\&.
63 The path to the gnutar binary\&. The default is set when Amanda is built by the
64 \-\-with\-gnutar configure option\&. gnutar is used to create the index\&.
70 Location of the amandapass file, defaulting to "$CONFIG_DIR/amandapass"\&.
71 Relative pathnames are relative to the configuration directory,
72 "$CONFIG_DIR/<config>"\&.
73 Note that this file is located on the client, not on the server\&.
74 The format of the file is as follow:
76 Sharename User%Password Domain
79 Sharename is \*(Aq//HOST/SHARE\*(Aq without the SUBDIR\&.
80 Sharename can be quoted,
81 it can be \*(Aq*\*(Aq to match all share,
82 it can be \*(Aq//pc\-host/*\*(Aq to match all share on pc\-host\&.
83 User is the username use to connect to the share\&.
84 Password is the password use to connect to the share\&.
85 \*(Aq%Password\*(Aq is optional if the user can connect to the share without password\&.
86 \*(AqUser%Password\*(Aq is optional, the user \*(Aqguest\*(Aq without password is use to connect to the share\&.
87 Domain is optional\&. Example:
89 //another\-pc/share otheruser%otherpw domain
90 //another\-pc/share otheruser%otherpw
91 //another\-pc/share myuser mydomain
92 //another\-pc/share myuser
100 This username without password is used to connect to the share if no matching entry is found in the amandapass file\&.
106 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\&.
112 "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\&.
114 .SH "INCLUDE AND EXCLUDE LISTS"
116 This application supplies exclude lists via the
119 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:
122 \&./temp\-files # exclude top\-level dir "temp\-files" entirely
123 \&./temp\-files/ # same
126 \&./temp\-files/* # BAD: does nothing
127 *\&.iso # BAD: does nothing
128 proxy/local/cache # exclude "cache" in dir "proxy/local"
131 Include lists are supported only if excludes are not given\&. They are handled via the
134 option\&. Include matching is identical to the exclude matching described above\&.
137 define application app_amsamba {
138 property "SMBCLIENT\-PATH" "/usr/bin/smbclient"
139 property "GNUTAR\-PATH" "/bin/tar"
140 property "AMANDAPASS" /etc/amandapass"
141 property "ALLOW\-ANONYMOUS" "guest"
147 \fBamanda.conf\fR(5),
148 \fBamanda-applications\fR(7)
151 : http://wiki.zmanda.com/
154 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
156 Zmanda, Inc\&. (http://www\&.zmanda\&.com)