amreport(8)

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

NAME

6       amreport - generate a formatted output of statistics for an Amanda run
7

SYNOPSIS

9       amreport [config] [{-o configoption}...] [(1) command-line options |
10                (2) script options]
11
12       (1) [--log=logfile] [--ps=filename] [--text=filename] [--xml=filename]
13           [--print=printer] [--mail-text=recipient]
14       (2) [-i] [-M address] [-l logfile] [-f outputfile] [-p postscriptfile]
15           [--from-amdump]
16

DESCRIPTION

18       Amreport generates a summary report of an Amanda backup run.
19
20       See the amanda(8) man page for more details about Amanda.
21

OPTIONS

23       config
24           Name of the configuration to process. If no configuration name is
25           specified, amanda.conf is read from the current directory.
26
27       -o configoption
28           See the "CONFIGURATION OVERRIDE" section in amanda(8).
29
30       Amreport operates in two distinct modes. Command-line mode is intended
31       for use by an administrator from the command line, and uses long
32       command-line options for clarity. Script mode is intended for use from
33       scripts such as amdump, and has a lot of non-obvious default behaviors
34       to suit that need.
35
36       Unless a script-mode option is given, amreport defaults to command-line
37       mode. If no options are given, amreport writes a report for the most
38       recent logfile to stdout.
39
40   Command-Line Mode Options
41       --log=logfile
42           Use this logfile as the basis for the report. If this option is
43           given, then the report is a "historical" report and will not
44           include current state from e.g., holding disk and curinfo. If this
45           option is not specified, then the most recent logfile will be used.
46
47       --ps=filename
48           Write a postscript label to filename. See "LABEL PRINTING" below.
49           If filename is not specified, then the label is written to stdout.
50
51       --text=filename
52           Write a human-readable text report to filename. If filename is not
53           specified, then the report is written to stdout.
54
55       --xml=filename
56           Write an XML-formatted report to filename. If filename is not
57           specified, then the report is written to stdout.
58
59       --print=printer
60           Pipe a postscript label to lp or lpr, specifying the given printer.
61           If the printer is not specified, uses the default from the Amanda
62           configuration, or the system default printer.
63
64       --mail-text=recipient
65           Send a human-readable text report to the given recipient via the
66           mailer specified in the Amanda configuration. If the recipient is
67           not specified, this uses the mailto from the Amanda configuration.
68
69   Script Mode Options
70       -i
71           Don´t email the report.
72
73       -M address
74           Mail the report to address instead of the mailto value from
75           amanda.conf.
76
77       -l logfile
78           Name of the log file to parse to generate the report. If a log file
79           is not specified, it defaults to the file $logdir/log, where
80           $logdir is the log directory defined in amanda.conf.
81
82       -f outputfile
83           Normally, amreport sends the report via e-mail to the mailto user
84           as defined in the amanda.conf file. If outputfile is specified,
85           then the report is put in outputfile.
86
87       -p postscriptfile
88           Send the postscript output to the file postscriptfile instead of to
89           the lpr(1) command. This option has an effect only if the lbl-templ
90           directive is specified in amanda.conf.
91
92       --from-amdump
93           Force script mode. Has no other effect.
94

LABEL PRINTING

96       Amanda can print postscript labels describing the contents of tape(s)
97       written in a run. The labels are designed to be folded and inserted
98       into the tape case along with the tape or hole punched and put in a
99       3-ring binder. Various label templates are provided to format data for
100       different tape sizes.
101
102       The information printed varies slightly between label templates due to
103       size constraints. Labels contain one line for each host/file-system
104       pair and may also contain the file number on the tape, the level of the
105       dump, the original size of the dump and the size of the (possibly
106       compressed) tape file.
107
108       Add the lbl-templ parameter to the tapetype definition in amanda.conf
109       to enable labels. If you don´t add this line to your tapetype
110       definition, amreport will not print tape labels.
111
112       You may use the printer keyword in amanda.conf to print to other than
113       the system default printer.
114

TEMPLATES

116       Amanda provides label templates for the following tape types. These are
117       pretty generic labels and should be easy to customize for other tape
118       types or particular site needs.
119
120           * ExaByte 8mm tapes
121           * DAT 4mm tapes
122           * DLT tapes
123           * 3-ring binder
124
125       The 3-ring binder type is the most generic. It may be used to make a
126       hardcopy log of the tapes.
127

EXIT CODE

129       The exit code of amreport is the ORed value of:
130        0  = success
131        1  = error
132        2  = a dle give strange message
133        4  = a dle failed
134        8  = Don´t know the status of a dle (RESULT_MISSING in the report)
135        16 = tape error or no more tape
136

AUTHOR

143       Stefan G. Weichinger <sgw@amanda.org>
144
145
146
147Amanda 3.1.3                      10/04/2010                       AMREPORT(8)