Imported Upstream version 3.3.2
[debian/amanda] / man / amstatus.8
1 '\" t
2 .\"     Title: amstatus
3 .\"    Author: Stefan G. Weichinger <sgw@amanda.org>
4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
5 .\"      Date: 07/25/2012
6 .\"    Manual: System Administration Commands
7 .\"    Source: Amanda 3.3.2
8 .\"  Language: English
9 .\"
10 .TH "AMSTATUS" "8" "07/25/2012" "Amanda 3\&.3\&.2" "System Administration Commands"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el       .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 amstatus \- display the state of an Amanda run
32 .SH "SYNOPSIS"
33 .HP \w'\fBamstatus\fR\ 'u
34 \fBamstatus\fR [\-\-file\ \fIamdumpfile\fR] [\-\-summary] [\-\-dumping] [\-\-waitdumping] [\-\-waittaper] [\-\-dumpingtape] [\-\-writingtape] [\-\-finished] [\-\-failed] [\-\-estimate] [\-\-gestimate] [\-\-stats] [\-\-locale\-independent\-date\-format] [\-\-config] \fIconfig\fR
35 .SH "DESCRIPTION"
36 .PP
37 \fBAmstatus\fR
38 gives the current state of the Amanda run specified by the
39 \fIconfig\fR
40 configuration\&. If there is no active Amanda running, it summarizes the result of the last run\&. It may also be used to summarize the results of a previous run\&.
41 .PP
42 See the
43 \fBamanda\fR(8)
44 man page for more details about Amanda\&.
45 .SH "OPTIONS"
46 .PP
47 All options may be abbreviated to the shortest non\-ambiguous sub\-string\&. If no options are given, everything is displayed\&.
48 .PP
49 \fB[\-\-config] config\fR
50 .RS 4
51 Specify the Amanda configuration you want to display the state for\&.
52 .RE
53 .PP
54 \fB\-\-file amdumpfile\fR
55 .RS 4
56 Specify an alternate file instead of the
57 \fIamdump\fR
58 or
59 \fIamflush\fR
60 file\&.
61 .RE
62 .PP
63 \fB\-\-summary\fR
64 .RS 4
65 Display a summary of the state of the run\&.
66 .RE
67 .PP
68 \fB\-\-dumping\fR
69 .RS 4
70 Display all partitions that are dumping\&.
71 .RE
72 .PP
73 \fB\-\-waitdumping|wdumping\fR
74 .RS 4
75 Display all partitions that are waiting to be dumped\&.
76 .RE
77 .PP
78 \fB\-\-waittaper|wtaper\fR
79 .RS 4
80 Display all partitions dumped that are waiting to be written to tape\&.
81 .RE
82 .PP
83 \fB\-\-dumpingtape|dtape\fR
84 .RS 4
85 Display all partitions that are dumping directly to tape\&.
86 .RE
87 .PP
88 \fB\-\-writingtape|wtape\fR
89 .RS 4
90 Display all partitions that are writing to tape\&.
91 .RE
92 .PP
93 \fB\-\-finished\fR
94 .RS 4
95 Display all partitions that are dumped and written to tape\&.
96 .RE
97 .PP
98 \fB\-\-failed|error\fR
99 .RS 4
100 Display all partitions that failed\&.
101 .RE
102 .PP
103 \fB\-\-estimate\fR
104 .RS 4
105 Display all partitions whose estimate is finished\&. Works only during the estimate phase\&.
106 .RE
107 .PP
108 \fB\-\-gestimate|gettingestimate\fR
109 .RS 4
110 Display all partitions whose estimate is not finished\&. Works only during the estimate phase\&.
111 .RE
112 .PP
113 \fB\-\-stats|statistics\fR
114 .RS 4
115 Display statistics about active\-time of taper and dumpers\&.
116 .RE
117 .PP
118 \fB\-\-locale\-independent\-date\-format\fR
119 .RS 4
120 Output the date in a locale independent format\&. The format is the same executing: date +\*(Aq%Y\-%m\-%d %H:%M:%S %Z\*(Aq
121 .RE
122 .SH "EXIT CODE"
123
124 The exit code of \fBamstatus\fR is the ORed value of:
125 .nf
126  0  = success
127  1  = error
128  4  = a dle failed
129  8  = Don\*(Aqt know the status of a dle (RESULT_MISSING in the report)
130  16 = tape error or no more tape
131 .fi
132 .SH "SEE ALSO"
133 .PP
134 \fBamanda\fR(8),
135 \fBamcheck\fR(8),
136 \fBamdump\fR(8),
137 \fBamrestore\fR(8),
138 \fBamadmin\fR(8)
139 .PP
140 The Amanda Wiki:
141 : http://wiki.zmanda.com/
142 .SH "AUTHOR"
143 .PP
144 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>