git.gag.com Git - debian/amanda/blob - man/amstatus.8

   1 .\"     Title: amstatus
   2 .\"    Author: Stefan G. Weichinger <sgw@amanda.org>
   3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
   4 .\"      Date: 01/22/2009
   5 .\"    Manual: System Administration Commands
   6 .\"    Source: Amanda 2.6.1
   7 .\"  Language: English
   8 .\"
   9 .TH "AMSTATUS" "8" "01/22/2009" "Amanda 2\&.6\&.1" "System Administration Commands"
  10 .\" -----------------------------------------------------------------
  11 .\" * (re)Define some macros
  12 .\" -----------------------------------------------------------------
  13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  14 .\" toupper - uppercase a string (locale-aware)
  15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  16 .de toupper
  17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
  18 \\$*
  19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
  20 ..
  21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  22 .\" SH-xref - format a cross-reference to an SH section
  23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24 .de SH-xref
  25 .ie n \{\
  26 .\}
  27 .toupper \\$*
  28 .el \{\
  29 \\$*
  30 .\}
  31 ..
  32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  33 .\" SH - level-one heading that works better for non-TTY output
  34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35 .de1 SH
  36 .\" put an extra blank line of space above the head in non-TTY output
  37 .if t \{\
  38 .sp 1
  39 .\}
  40 .sp \\n[PD]u
  41 .nr an-level 1
  42 .set-an-margin
  43 .nr an-prevailing-indent \\n[IN]
  44 .fi
  45 .in \\n[an-margin]u
  46 .ti 0
  47 .HTML-TAG ".NH \\n[an-level]"
  48 .it 1 an-trap
  49 .nr an-no-space-flag 1
  50 .nr an-break-flag 1
  51 \." make the size of the head bigger
  52 .ps +3
  53 .ft B
  54 .ne (2v + 1u)
  55 .ie n \{\
  56 .\" if n (TTY output), use uppercase
  57 .toupper \\$*
  58 .\}
  59 .el \{\
  60 .nr an-break-flag 0
  61 .\" if not n (not TTY), use normal case (not uppercase)
  62 \\$1
  63 .in \\n[an-margin]u
  64 .ti 0
  65 .\" if not n (not TTY), put a border/line under subheading
  66 .sp -.6
  67 \l'\n(.lu'
  68 .\}
  69 ..
  70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  71 .\" SS - level-two heading that works better for non-TTY output
  72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  73 .de1 SS
  74 .sp \\n[PD]u
  75 .nr an-level 1
  76 .set-an-margin
  77 .nr an-prevailing-indent \\n[IN]
  78 .fi
  79 .in \\n[IN]u
  80 .ti \\n[SN]u
  81 .it 1 an-trap
  82 .nr an-no-space-flag 1
  83 .nr an-break-flag 1
  84 .ps \\n[PS-SS]u
  85 \." make the size of the head bigger
  86 .ps +2
  87 .ft B
  88 .ne (2v + 1u)
  89 .if \\n[.$] \&\\$*
  90 ..
  91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  92 .\" BB/BE - put background/screen (filled box) around block of text
  93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  94 .de BB
  95 .if t \{\
  96 .sp -.5
  97 .br
  98 .in +2n
  99 .ll -2n
 100 .gcolor red
 101 .di BX
 102 .\}
 103 ..
 104 .de EB
 105 .if t \{\
 106 .if "\\$2"adjust-for-leading-newline" \{\
 107 .sp -1
 108 .\}
 109 .br
 110 .di
 111 .in
 112 .ll
 113 .gcolor
 114 .nr BW \\n(.lu-\\n(.i
 115 .nr BH \\n(dn+.5v
 116 .ne \\n(BHu+.5v
 117 .ie "\\$2"adjust-for-leading-newline" \{\
 118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 119 .\}
 120 .el \{\
 121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 122 .\}
 123 .in 0
 124 .sp -.5v
 125 .nf
 126 .BX
 127 .in
 128 .sp .5v
 129 .fi
 130 .\}
 131 ..
 132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 133 .\" BM/EM - put colored marker in margin next to block of text
 134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 135 .de BM
 136 .if t \{\
 137 .br
 138 .ll -2n
 139 .gcolor red
 140 .di BX
 141 .\}
 142 ..
 143 .de EM
 144 .if t \{\
 145 .br
 146 .di
 147 .ll
 148 .gcolor
 149 .nr BH \\n(dn
 150 .ne \\n(BHu
 151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
 152 .in 0
 153 .nf
 154 .BX
 155 .in
 156 .fi
 157 .\}
 158 ..
 159 .\" -----------------------------------------------------------------
 160 .\" * set default formatting
 161 .\" -----------------------------------------------------------------
 162 .\" disable hyphenation
 163 .nh
 164 .\" disable justification (adjust text to left margin only)
 165 .ad l
 166 .\" -----------------------------------------------------------------
 167 .\" * MAIN CONTENT STARTS HERE *
 168 .\" -----------------------------------------------------------------
 169 .SH "Name"
 170 amstatus \- display the state of an \fIAmanda\fR run
 171 .SH "Synopsis"
 172 .fam C
 173 .HP \w'\fBamstatus\fR\ 'u
 174 \fBamstatus\fR [\-\-config] \fIconfig\fR [\-\-file\ \fIamdumpfile\fR] [\-\-summary] [\-\-dumping] [\-\-waitdumping] [\-\-waittaper] [\-\-dumpingtape] [\-\-writingtape] [\-\-finished] [\-\-failed] [\-\-estimate] [\-\-gestimate] [\-\-stats] [\-\-locale\-independent\-date\-format]
 175 .fam
 176 .SH "DESCRIPTION"
 177 .PP
 178 \fBAmstatus\fR
 179 gives the current state of the
 180 \fIAmanda\fR
 181 run specified by the
 182 \fIconfig\fR
 183 configuration\&. If there is no active
 184 \fIAmanda\fR
 185 running, it summarizes the result of the last run\&. It may also be used to summarize the results of a previous run\&.
 186 .PP
 187 See the
 188 \fBamanda\fR(8)
 189 man page for more details about
 190 \fIAmanda\fR\&.
 191 .SH "OPTIONS"
 192 .PP
 193 All options may be abbreviated to the shortest non\-ambiguous sub\-string\&. If no options are given, everything is displayed\&.
 194 .PP
 195 \fB[\-\-config] config\fR
 196 .RS 4
 197 Specify the
 198 \fIAmanda\fR
 199 configuration you want to display the state for\&.
 200 .RE
 201 .PP
 202 \fB\-\-file amdumpfile\fR
 203 .RS 4
 204 Specify an alternate file instead of the
 205 \fIamdump\fR
 206 or
 207 \fIamflush\fR
 208 file\&.
 209 .RE
 210 .PP
 211 \fB\-\-summary\fR
 212 .RS 4
 213 Display a summary of the state of the run\&.
 214 .RE
 215 .PP
 216 \fB\-\-dumping\fR
 217 .RS 4
 218 Display all partitions that are dumping\&.
 219 .RE
 220 .PP
 221 \fB\-\-waitdumping|wdumping\fR
 222 .RS 4
 223 Display all partitions that are waiting to be dumped\&.
 224 .RE
 225 .PP
 226 \fB\-\-waittaper|wtaper\fR
 227 .RS 4
 228 Display all partitions dumped that are waiting to be written to tape\&.
 229 .RE
 230 .PP
 231 \fB\-\-dumpingtape|dtape\fR
 232 .RS 4
 233 Display all partitions that are dumping directly to tape\&.
 234 .RE
 235 .PP
 236 \fB\-\-writingtape|wtape\fR
 237 .RS 4
 238 Display all partitions that are writing to tape\&.
 239 .RE
 240 .PP
 241 \fB\-\-finished\fR
 242 .RS 4
 243 Display all partitions that are dumped and written to tape\&.
 244 .RE
 245 .PP
 246 \fB\-\-failed|error\fR
 247 .RS 4
 248 Display all partitions that failed\&.
 249 .RE
 250 .PP
 251 \fB\-\-estimate\fR
 252 .RS 4
 253 Display all partitions whose estimate is finished\&. Works only during the estimate phase\&.
 254 .RE
 255 .PP
 256 \fB\-\-gestimate|gettingestimate\fR
 257 .RS 4
 258 Display all partitions whose estimate is not finished\&. Works only during the estimate phase\&.
 259 .RE
 260 .PP
 261 \fB\-\-stats|statistics\fR
 262 .RS 4
 263 Display statistics about active\-time of taper and dumpers\&.
 264 .RE
 265 .PP
 266 \fB\-\-locale\-independent\-date\-format\fR
 267 .RS 4
 268 Output the date in a locale independent format\&. The format is the same executing: date +\'%Y\-%m\-%d %H:%M:%S %Z\'
 269 .RE
 270 .SH "EXIT CODE"
 271
 272 The exit code of \fBamstatus\fR is the ORed value of:
 273 .nf
 274  0  = success
 275  1  = error
 276  4  = a dle failed
 277  8  = Don\'t know the status of a dle (RESULT_MISSING in the report)
 278  16 = tape error or no more tape
 279 .fi
 280 .SH "SEE ALSO"
 281 .PP
 282 \fBamanda\fR(8),
 283 \fBamcheck\fR(8),
 284 \fBamdump\fR(8),
 285 \fBamrestore\fR(8),
 286 \fBamadmin\fR(8),
 287 : http://wiki.zmanda.com
 288 .SH "Author"
 289 .PP
 290 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>