NAME

       amstar - Amanda Application to interface with star

DESCRIPTION

       Amstar is an Amanda Application API script. It should not be run by users directly. It
       uses star to backup and restore data.

       The diskdevice in the disklist (DLE) must be the directory to backup.

INCLUDE - EXCLUDE

       amstar doesn't support include. Both 'exclude list' and 'exclude file' are supported.
       There is a maximum of 100 patterns (limit of star).

       Moving directories into and out of directories on the exclude list causes incremental
       backups to not contain the files in the moved directories until the next full backup
       unless the moved files are modified after the move.

PROPERTIES

       This section lists the properties that control amstar's functionality. See amanda-
       applications(7) for information on application properties and how they are configured.

       ACL

           If "YES" (the default), amstar will store files acl by passing the -acl argument to
           star. If "NO", then the -acl option is not given to star, and it will not try to
           backup the acl.

       COMMAND-OPTIONS
           If set, theses options are passed asis to star. Each option must be a different value
           of the property. Some option can break how amanda do backup, use it with care.

           Use:
             property "COMMAND-OPTIONS" "--foo" "bar"

           Do not use:
             property "COMMAND-OPTIONS" "--foo bar"

       DIRECTORY

           If set, gnutar will backup from that directory instead of the diskdevice set by the
           DLE. On restore, the data is restore in that directpory instead of the current working
           directory.

       ONE-FILE-SYSTEM

           The default is "YES". This property is deprecated and the default value can't be
           changed. star requires it when it works in dump mode.  This corresponds to the -xdev
           option of star.

       SPARSE

           If "YES" (the default), star will store sparse files efficiently. If "NO", then the
           -sparse option is not given to star, and it will not try to detect sparse files.

       STAR-DLE-TARDUMP

           If "YES", amstar will use a different tardump file for each DLE. The default is "NO".
           This property is needed with older versions of star doing many dumps in parallel,
           because of a race condition in updating the tardump file.

       STAR-PATH

           The path to the star binary. The default is set when Amanda is built by the
           --with-star configure option.

       STAR-TARDUMP

           The directory where star stores the database it uses to generate incremental dumps.
           The default is /etc/tardumps.

       NORMAL

           List all regex (POSIX Extended Regular Expression syntax) that are normal output from
           star. These output are in the "FAILED DUMP DETAILS" section of the email report if the
           dump result is STRANGE or FAILED. Default values:
             "^could not open conf file"
             "^Type of this level "
             "^Date of this level "
             "^Date of last level "
             "^Dump record  level "
             "^Throughput"
             "^.*is sparse$"
             "^star: dumped [0-9][0-9]* (tar )?files"
             "^.*The following problems occurred during .* processing.*$"
             "^.*Processed all possible files, despite earlier errors.*$"
             "^.*not written due to problems during backup.*$"
           To treat one of these default patterns differently, specify it explicitly in a
           different property.

       IGNORE

           List all regex (POSIX Extended Regular Expression syntax) that amanda ignore. These
           output are never in the email report.

       STRANGE

           List all regex (POSIX Extended Regular Expression syntax) that are strange output from
           star. All star output that doesn't match a normal or ignore regex are strange by
           default. The result of the dump is STRANGE if star produce a strange output. These
           output are in the "FAILED DUMP DETAILS" section of the email report.
             "^Perform a level 0 dump first.*$"
           To treat one of these default patterns differently, specify it explicitly in a
           different property.

SEE ALSO

       amanda(8), amanda.conf(5), amanda-applications(7)

       The Amanda Wiki: : http://wiki.zmanda.com/

AUTHORS

       Jean-Louis Martineau <martineau@zmanda.com>
           Zmanda, Inc. (http://www.zmanda.com)

       Dustin J. Mitchell <dustin@zmanda.com>
           Zmanda, Inc. (http://www.zmanda.com)