AMGTAR(8)

NAME
amgtar - Amanda Application to interface with GNU Tar

DESCRIPTION

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

PROPERTIES

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

ATIME-PRESERVE
    If "YES" (the default), amgtar use the --atime-preserve=system option of gnutar to not update the atime of all files accessed; if "NO", gnutar will updates the atime for all files accessed. This property works only if you have gnutar 1.15.90 or newer, if not, you must set ATIME_PRESERVE to "NO".

CHECK-DEVICE
    If "YES" (the default), amgtar checks that the device number doesn't change for each file. If "NO", changes in device number are ignored. To ignore device numbers, tar must support the --no-check-device option (gnutar 1.19.90 and newer). This option is needed for some filesystems and devices on which device numbers change frequently, such as LVM or FiberChannel.

DIRECTORY
    If set, gnutar will backup from that directory instead of the diskdevice set by the DLE.

GNUTAR-LISTDIR
    The directory where gnutar stores the database it uses to generate incremental dumps. The default is set when Amanda is built.

GNUTAR-PATH
    The path to the gnutar binary. The default is set when Amanda is built.

ONE-FILE-SYSTEM
    If "YES" (the default), do not allow gnutar to cross filesystem boundaries. If "NO", gnutar will cross filesystem boundaries. This corresponds to the --one-filesystem option of gnutar.

TAR-BLOCKSIZE
    Block size of Nx512 bytes (default N=20). This corresponds to the --blocking-factor option of gnutar.

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

EXIT-HANDLING
    List which exit status of gtar are good or bad. eg. "1=GOOD 2=BAD", exit status of 1 will produce a good backup, exit status of 2 will give an error.

NORMAL
    List all regex (POSIX Extended Regular Expression syntax) that are normal output from gtar. 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"
      "^Elapsed time:"
      "^Throughput"
      ": socket ignored$"
      ": File .* shrunk by [0-9][0-9]* bytes, padding with zeros"
      ": Cannot add file .*: No such file or directory$"
      ": Error exit delayed from previous errors"
    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. Default values:
      ": Directory is new$"
      ": Directory has been renamed"
    To treat one of these default patterns differently, specify it explicitly in a different property.

STRANGE
    List all regex (POSIX Extended Regular Expression syntax) that are strange output from gtar. All gtar output that doesn't match a normal or ignore regex are strange by default. The result of the dump is STRANGE if gtar produce a strange output. These output are in the "FAILED DUMP DETAILS" section of the email report.

EXAMPLE
  define application-tool app_amgtar {
    property "ATIME-PRESERVE" "NO"
    property "CHECK-DEVICE" "YES"
    property "GNUTAR-LISTDIR" "
    property "GNUTAR-PATH" "/bin/tar"
    property "ONE-FILE-SYSTEM" "YES"
    property "TAR_BLOCKSIZE" "20"
    property "SPARSE" "YES"
    property "EXIT-HANDLING" "1=GOOD 2=BAD"
    # change a default NORMAL regex to a STRANGE regex.
    property "STRANGE" ": socket ignored$"
    # add three new IGNORE regex
    property "IGNORE" ": Directory is new$"
    property append "IGNORE" ": Directory has been renamed"
    property append "IGNORE" "file changed as we read it$"
  }

SEE ALSO

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

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)