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