1AMSAMBA(8)              System Administration Commands              AMSAMBA(8)
2
3
4

NAME

6       amsamba - Amanda Application to interface with smbclient
7

DESCRIPTION

9       Amsamba is an Amanda Application API script. It should not be run by
10       users directly. It uses smbclient to backup and restore data.
11
12       The diskdevice in the disklist (DLE) must have the form
13       '//CIFSHOST/SHARE/SUBDIR' where CIFSHOST is the CIFS host containing
14       the data to be backed up, SHARE is the share to connect, and subdir is
15       the subdirectory to backup. '/subdir' can be ommited, in which case the
16       complete share is archived.
17
18       Unlike most applications, amsamba backs up and restores data located on
19       a different system from that where amsamba itself runs. The host
20       containing the data is the CIFS host. In practice, amsamba is usually
21       run on the same system as the Amanda server, with a DLE like
22
23       localhost "//CIFSHOST/SHARENAME" amsamba-dumptype
24
25       Include or exclude can be used, but not both. The path for 'exclude
26       list' or 'include list' must be absolute path on the CIFS host. The
27       estimate calculates the complete size of the share, without regard for
28       include or exclude directives. It will be larger than the actual dump
29       if you use include or exclude. Using 'estimate server' in the dumptype
30       could give better estimate.
31

PROPERTIES

33       This section lists the properties that control amsamba's functionality.
34       See amanda-applications(7) for information on application properties
35       and how they are configured.
36
37       SMBCLIENT-PATH
38
39           The path to the smbclient binary.  The default is set when Amanda
40           is built by the --with-smbclient configure option.
41
42       GNUTAR-PATH
43
44           The path to the gnutar binary.  The default is set when Amanda is
45           built by the --with-gnutar configure option. gnutar is used to
46           create the index.
47
48       AMANDAPASS
49
50           Location of the amandapass file, defaulting to
51           "$CONFIG_DIR/amandapass".  Relative pathnames are relative to the
52           configuration directory, "$CONFIG_DIR/<config>".  Note that this
53           file is located on the client, not on the server.  The format of
54           the file is as follow:
55             Sharename User%Password Domain
56
57           Sharename is '//HOST/SHARE' without the SUBDIR.  Sharename can be
58           quoted, it can be '*' to match all share, it can be '//pc-host/*'
59           to match all share on pc-host.  User is the username use to connect
60           to the share.  Password is the password use to connect to the
61           share.  '%Password' is optional if the user can connect to the
62           share without password.  'User%Password' is optional, the user
63           'guest' without password is use to connect to the share.  Domain is
64           optional. Example:
65             //another-pc/share otheruser%otherpw domain
66             //another-pc/share otheruser%otherpw
67             //another-pc/share myuser mydomain
68             //another-pc/share myuser
69             //another-pc/share
70
71       ALLOW-ANONYMOUS
72
73           This username without password is used to connect to the share if
74           no matching entry is found in the amandapass file.
75
76       DIRECTORY
77
78           For restore command only, the data is recoved in that directory.
79           Must be a unix path for "tar" RECOVER-MODE or a smb path for "smb"
80           recover-MODE.
81
82       RECOVER-MODE
83
84           "tar" or "smb", default to "tar". If "tar", the data is recovered
85           on the local machine, If "smb", the data is recovered on the smb
86           client machine.
87

INCLUDE AND EXCLUDE LISTS

89       This application supplies exclude lists via the smbclient -TX option.
90       Normal shell-style wildcard expressions, using * and ?, are not
91       supported. All expressions are matched only from the base directory of
92       the DLE. Expressions that match a directory may have a leading or
93       trailing "/". Example expressions:
94
95         ./temp-files           # exclude top-level dir "temp-files" entirely
96         ./temp-files/          # same
97         /temp-files            # same
98         temp-files             # same
99         ./temp-files/*         # BAD: does nothing
100         *.iso                  # BAD: does nothing
101         proxy/local/cache      # exclude "cache" in dir "proxy/local"
102
103       Include lists are supported only if excludes are not given. They are
104       handled via the smbclient -TI option. Include matching is identical to
105       the exclude matching described above.
106

EXAMPLE

108         define application app_amsamba {
109           property "SMBCLIENT-PATH" "/usr/bin/smbclient"
110           property "GNUTAR-PATH" "/bin/tar"
111           property "AMANDAPASS" /etc/amandapass"
112           property "ALLOW-ANONYMOUS" "guest"
113         }
114

SEE ALSO

116       amanda(8), amanda.conf(5), amanda-applications(7)
117
118       The Amanda Wiki: : http://wiki.zmanda.com/
119

AUTHOR

121       Jean-Louis Martineau <martineau@zmanda.com>
122           Zmanda, Inc. (http://www.zmanda.com)
123
124
125
126Amanda 3.3.3                      01/10/2013                        AMSAMBA(8)
Impressum