191f8a14042d5140fdc8483fbcabef80e0375eb6
[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: 11/05/2009
6 .\"    Manual: System Administration Commands
7 .\"    Source: Amanda 2.6.1p2
8 .\"  Language: English
9 .\"
10 .TH "AMSTATUS" "8" "11/05/2009" "Amanda 2\&.6\&.1p2" "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 \fIAmanda\fR 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
30 \fIAmanda\fR
31 run specified by the
32 \fIconfig\fR
33 configuration\&. If there is no active
34 \fIAmanda\fR
35 running, it summarizes the result of the last run\&. It may also be used to summarize the results of a previous run\&.
36 .PP
37 See the
38 \fBamanda\fR(8)
39 man page for more details about
40 \fIAmanda\fR\&.
41 .SH "OPTIONS"
42 .PP
43 All options may be abbreviated to the shortest non\-ambiguous sub\-string\&. If no options are given, everything is displayed\&.
44 .PP
45 \fB[\-\-config] config\fR
46 .RS 4
47 Specify the
48 \fIAmanda\fR
49 configuration you want to display the state for\&.
50 .RE
51 .PP
52 \fB\-\-file amdumpfile\fR
53 .RS 4
54 Specify an alternate file instead of the
55 \fIamdump\fR
56 or
57 \fIamflush\fR
58 file\&.
59 .RE
60 .PP
61 \fB\-\-summary\fR
62 .RS 4
63 Display a summary of the state of the run\&.
64 .RE
65 .PP
66 \fB\-\-dumping\fR
67 .RS 4
68 Display all partitions that are dumping\&.
69 .RE
70 .PP
71 \fB\-\-waitdumping|wdumping\fR
72 .RS 4
73 Display all partitions that are waiting to be dumped\&.
74 .RE
75 .PP
76 \fB\-\-waittaper|wtaper\fR
77 .RS 4
78 Display all partitions dumped that are waiting to be written to tape\&.
79 .RE
80 .PP
81 \fB\-\-dumpingtape|dtape\fR
82 .RS 4
83 Display all partitions that are dumping directly to tape\&.
84 .RE
85 .PP
86 \fB\-\-writingtape|wtape\fR
87 .RS 4
88 Display all partitions that are writing to tape\&.
89 .RE
90 .PP
91 \fB\-\-finished\fR
92 .RS 4
93 Display all partitions that are dumped and written to tape\&.
94 .RE
95 .PP
96 \fB\-\-failed|error\fR
97 .RS 4
98 Display all partitions that failed\&.
99 .RE
100 .PP
101 \fB\-\-estimate\fR
102 .RS 4
103 Display all partitions whose estimate is finished\&. Works only during the estimate phase\&.
104 .RE
105 .PP
106 \fB\-\-gestimate|gettingestimate\fR
107 .RS 4
108 Display all partitions whose estimate is not finished\&. Works only during the estimate phase\&.
109 .RE
110 .PP
111 \fB\-\-stats|statistics\fR
112 .RS 4
113 Display statistics about active\-time of taper and dumpers\&.
114 .RE
115 .PP
116 \fB\-\-locale\-independent\-date\-format\fR
117 .RS 4
118 Output the date in a locale independent format\&. The format is the same executing: date +\'%Y\-%m\-%d %H:%M:%S %Z\'
119 .RE
120 .SH "EXIT CODE"
121
122 The exit code of \fBamstatus\fR is the ORed value of:
123 .nf
124  0  = success
125  1  = error
126  4  = a dle failed
127  8  = Don\'t know the status of a dle (RESULT_MISSING in the report)
128  16 = tape error or no more tape
129 .fi
130 .SH "SEE ALSO"
131 .PP
132 \fBamanda\fR(8),
133 \fBamcheck\fR(8),
134 \fBamdump\fR(8),
135 \fBamrestore\fR(8),
136 \fBamadmin\fR(8),
137 : http://wiki.zmanda.com
138 .SH "AUTHOR"
139 .PP
140 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>