AMSAMBA(8) System Administration Commands AMSAMBA(8)NAMEamsamba - Amanda Application to interface with smbclient
DESCRIPTION
Amsamba is an Amanda Application API script. It should not be run by
users directly. It uses smbclient to backup and restore data.
The diskdevice in the disklist (DLE) 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.
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
localhost "//CIFSHOST/SHARENAME" amsamba-dumptype
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.
PROPERTIES
This section lists the properties that control amsamba's functionality.
See amanda-applications(7) for information on application properties
and how they are configured.
SMBCLIENT-PATH
The path to the smbclient binary. The default is set when Amanda
is built by the --with-smbclient configure option.
GNUTAR-PATH
The path to the gnutar binary. The default is set when Amanda is
built by the --with-gnutar configure option. gnutar is used to
create the index.
AMANDAPASS
Location of the amandapass file, defaulting to
"$CONFIG_DIR/amandapass". Relative pathnames are relative to the
configuration directory, "$CONFIG_DIR/<config>". Note that this
file is located on the client, not on the server. The format of
the file is as follow:
Sharename User%Password Domain
Sharename is '//HOST/SHARE' without the SUBDIR. Sharename can be
quoted, it can be '*' to match all share, it can be '//pc-host/*'
to match all share on pc-host. User is the username use to connect
to the share. Password is the password use to connect to the
share. '%Password' is optional if the user can connect to the
share without password. 'User%Password' is optional, the user
'guest' without password is use to connect to the share. Domain is
optional. Example:
//another-pc/share otheruser%otherpw domain
//another-pc/share otheruser%otherpw
//another-pc/share myuser mydomain
//another-pc/share myuser
//another-pc/share
ALLOW-ANONYMOUS
This username without password is used to connect to the share if
no matching entry is found in the amandapass file.
DIRECTORY
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.
RECOVER-MODE
"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.
INCLUDE AND EXCLUDE LISTS
This application supplies exclude lists via the smbclient -TX 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:
./temp-files # exclude top-level dir "temp-files" entirely
./temp-files/ # same
/temp-files # same
temp-files # same
./temp-files/* # BAD: does nothing
*.iso # BAD: does nothing
proxy/local/cache # exclude "cache" in dir "proxy/local"
Include lists are supported only if excludes are not given. They are
handled via the smbclient -TI option. Include matching is identical to
the exclude matching described above.
EXAMPLE
define application app_amsamba {
property "SMBCLIENT-PATH" "/usr/bin/smbclient"
property "GNUTAR-PATH" "/bin/tar"
property "AMANDAPASS" /etc/amandapass"
property "ALLOW-ANONYMOUS" "guest"
}
SEE ALSOamanda(8), amanda.conf(5), amanda-applications(7)
The Amanda Wiki: : http://wiki.zmanda.com/
AUTHOR
Jean-Louis Martineau <martineau@zmanda.com>
Zmanda, Inc. (http://www.zmanda.com)
Amanda 3.3.3 01/10/2013 AMSAMBA(8)
