NAME
amreport - generate a formatted output of statistics for an Amanda run
SYNOPSIS
amreport [config] [{-o configoption}...] [(1) command-line options |
(2) script options]
(1) [--log=logfile] [--ps=filename] [--text=filename] [--xml=filename]
[--print=printer] [--mail-text=recipient]
(2) [-i] [-M address] [-l logfile] [-f outputfile] [-p postscriptfile]
[--from-amdump]
DESCRIPTION
Amreport generates a summary report of an Amanda backup run.
See the amanda(8) man page for more details about Amanda.
OPTIONS
config
Name of the configuration to process. If no configuration name is
specified, amanda.conf is read from the current directory.
-o configoption
See the "CONFIGURATION OVERRIDE" section in amanda(8).
Amreport operates in two distinct modes. Command-line mode is intended
for use by an administrator from the command line, and uses long
command-line options for clarity. Script mode is intended for use from
scripts such as amdump, and has a lot of non-obvious default behaviors
to suit that need.
Unless a script-mode option is given, amreport defaults to command-line
mode. If no options are given, amreport writes a report for the most
recent logfile to stdout.
Command-Line Mode Options
--log=logfile
Use this logfile as the basis for the report. If this option is
given, then the report is a "historical" report and will not
include current state from e.g., holding disk and curinfo. If this
option is not specified, then the most recent logfile will be used.
--ps=filename
Write a postscript label to filename. See "LABEL PRINTING" below.
If filename is not specified, then the label is written to stdout.
--text=filename
Write a human-readable text report to filename. If filename is not
specified, then the report is written to stdout.
--xml=filename
Write an XML-formatted report to filename. If filename is not
specified, then the report is written to stdout.
--print=printer
Pipe a postscript label to lp or lpr, specifying the given printer.
If the printer is not specified, uses the default from the Amanda
configuration, or the system default printer.
--mail-text=recipient
Send a human-readable text report to the given recipient via the
mailer specified in the Amanda configuration. If the recipient is
not specified, this uses the mailto from the Amanda configuration.
Script Mode Options
-i
Don´t email the report.
-M address
Mail the report to address instead of the mailto value from
amanda.conf.
-l logfile
Name of the log file to parse to generate the report. If a log file
is not specified, it defaults to the file $logdir/log, where
$logdir is the log directory defined in amanda.conf.
-f outputfile
Normally, amreport sends the report via e-mail to the mailto user
as defined in the amanda.conf file. If outputfile is specified,
then the report is put in outputfile.
-p postscriptfile
Send the postscript output to the file postscriptfile instead of to
the lpr(1) command. This option has an effect only if the lbl-templ
directive is specified in amanda.conf.
--from-amdump
Force script mode. Has no other effect.
LABEL PRINTING
Amanda can print postscript labels describing the contents of tape(s)
written in a run. The labels are designed to be folded and inserted
into the tape case along with the tape or hole punched and put in a
3-ring binder. Various label templates are provided to format data for
different tape sizes.
The information printed varies slightly between label templates due to
size constraints. Labels contain one line for each host/file-system
pair and may also contain the file number on the tape, the level of the
dump, the original size of the dump and the size of the (possibly
compressed) tape file.
Add the lbl-templ parameter to the tapetype definition in amanda.conf
to enable labels. If you don´t add this line to your tapetype
definition, amreport will not print tape labels.
You may use the printer keyword in amanda.conf to print to other than
the system default printer.
TEMPLATES
Amanda provides label templates for the following tape types. These are
pretty generic labels and should be easy to customize for other tape
types or particular site needs.
* ExaByte 8mm tapes
* DAT 4mm tapes
* DLT tapes
* 3-ring binder
The 3-ring binder type is the most generic. It may be used to make a
hardcopy log of the tapes.
EXIT CODE
The exit code of amreport is the ORed value of:
0 = success
1 = error
2 = a dle give strange message
4 = a dle failed
8 = Don´t know the status of a dle (RESULT_MISSING in the report)
16 = tape error or no more tape
SEE ALSO
amanda(8), amflush(8)
The Amanda Wiki: : http://wiki.zmanda.com/
AUTHOR
Stefan G. Weichinger <sgw@amanda.org>