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

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
   4 [
   5   <!-- entities files to use -->
   6   <!ENTITY % global_entities SYSTEM 'global.entities'>
   7   %global_entities;
   8 ]>
   9
  10 <!-- lifted from troff+man by doclifter -->
  11
  12 <refentry id='amstatus.8'>
  13
  14 <refmeta>
  15 <refentrytitle>amstatus</refentrytitle>
  16 <manvolnum>8</manvolnum>
  17 &rmi.source;
  18 &rmi.version;
  19 &rmi.manual.8;
  20 </refmeta>
  21 <refnamediv>
  22 <refname>amstatus</refname>
  23 <refpurpose>display the state of an Amanda run</refpurpose>
  24 </refnamediv>
  25 <refentryinfo>
  26 &author.sgw.xml;
  27 </refentryinfo>
  28 <!-- body begins here -->
  29 <refsynopsisdiv>
  30 <cmdsynopsis>
  31   <command>amstatus</command>
  32     <arg choice='opt'><arg choice='plain'>--file </arg><arg choice='plain'><replaceable>amdumpfile</replaceable></arg></arg>
  33     <arg choice='opt'>--summary </arg>
  34     <arg choice='opt'>--dumping </arg>
  35     <arg choice='opt'>--waitdumping </arg>
  36     <arg choice='opt'>--waittaper </arg>
  37     <arg choice='opt'>--dumpingtape </arg>
  38     <arg choice='opt'>--writingtape </arg>
  39     <arg choice='opt'>--finished </arg>
  40     <arg choice='opt'>--failed </arg>
  41     <arg choice='opt'>--estimate </arg>
  42     <arg choice='opt'>--gestimate </arg>
  43     <arg choice='opt'>--stats </arg>
  44     <arg choice='opt'>--locale-independent-date-format </arg>
  45     <arg choice='opt'>--config </arg>
  46     <arg choice='plain'><replaceable>config</replaceable></arg>
  47 </cmdsynopsis>
  48 </refsynopsisdiv>
  49
  50
  51 <refsect1><title>DESCRIPTION</title>
  52 <para><emphasis remap='B'>Amstatus</emphasis>
  53 gives the current state of the Amanda run specified by the
  54 <emphasis remap='I'>config</emphasis>
  55 configuration.
  56 If there is no active Amanda running, it summarizes the result of the last run.
  57 It may also be used to summarize the results of a previous run.</para>
  58
  59 <para>See the
  60 <manref name="amanda" vol="8"/>
  61 man page for more details about Amanda.</para>
  62 </refsect1>
  63
  64 <refsect1><title>OPTIONS</title>
  65 <para>All options may be abbreviated to the shortest non-ambiguous sub-string.
  66 If no options are given, everything is displayed.</para>
  67 <variablelist remap='TP'>
  68   <varlistentry>
  69   <term><emphasis remap='B'>[--config] config</emphasis></term>
  70   <listitem>
  71 <para>Specify the Amanda configuration you want to display the state for.</para>
  72   </listitem>
  73   </varlistentry>
  74   <varlistentry>
  75   <term><option>--file amdumpfile</option></term>
  76   <listitem>
  77 <para>Specify an alternate file instead of the
  78 <emphasis remap='I'>amdump</emphasis>
  79 or
  80 <emphasis remap='I'>amflush</emphasis>
  81 file.</para>
  82   </listitem>
  83   </varlistentry>
  84   <varlistentry>
  85   <term><option>--summary</option></term>
  86   <listitem>
  87 <para>Display a summary of the state of the run.</para>
  88   </listitem>
  89   </varlistentry>
  90   <varlistentry>
  91   <term><option>--dumping</option></term>
  92   <listitem>
  93 <para>Display all partitions that are dumping.</para>
  94   </listitem>
  95   </varlistentry>
  96   <varlistentry>
  97   <term><option>--waitdumping|wdumping</option></term>
  98   <listitem>
  99 <para>Display all partitions that are waiting to be dumped.</para>
 100   </listitem>
 101   </varlistentry>
 102   <varlistentry>
 103   <term><option>--waittaper|wtaper</option></term>
 104   <listitem>
 105 <para>Display all partitions dumped that are waiting to be written to tape.</para>
 106   </listitem>
 107   </varlistentry>
 108   <varlistentry>
 109   <term><option>--dumpingtape|dtape</option></term>
 110   <listitem>
 111 <para>Display all partitions that are dumping directly to tape.</para>
 112   </listitem>
 113   </varlistentry>
 114   <varlistentry>
 115   <term><option>--writingtape|wtape</option></term>
 116   <listitem>
 117 <para>Display all partitions that are writing to tape.</para>
 118   </listitem>
 119   </varlistentry>
 120   <varlistentry>
 121   <term><option>--finished</option></term>
 122   <listitem>
 123 <para>Display all partitions that are dumped and written to tape.</para>
 124   </listitem>
 125   </varlistentry>
 126   <varlistentry>
 127   <term><option>--failed|error</option></term>
 128   <listitem>
 129 <para>Display all partitions that failed.</para>
 130   </listitem>
 131   </varlistentry>
 132   <varlistentry>
 133   <term><option>--estimate</option></term>
 134   <listitem>
 135 <para>Display all partitions whose estimate is finished.
 136 Works only during the estimate phase.</para>
 137   </listitem>
 138   </varlistentry>
 139   <varlistentry>
 140   <term><option>--gestimate|gettingestimate</option></term>
 141   <listitem>
 142 <para>Display all partitions whose estimate is not finished.
 143 Works only during the estimate phase.</para>
 144   </listitem>
 145   </varlistentry>
 146   <varlistentry>
 147   <term><option>--stats|statistics</option></term>
 148   <listitem>
 149 <para>Display statistics about active-time of taper and dumpers.</para>
 150   </listitem>
 151   </varlistentry>
 152   <varlistentry>
 153   <term><option>--locale-independent-date-format</option></term>
 154   <listitem>
 155 <para>Output the date in a locale independent format. The format is the same executing: date +'%Y-%m-%d %H:%M:%S %Z'</para>
 156   </listitem>
 157   </varlistentry>
 158 </variablelist>
 159 </refsect1>
 160
 161 <refsect1><title>EXIT CODE</title>
 162 The exit code of <command>amstatus</command> is the ORed value of:
 163 <programlisting>
 164  0  = success
 165  1  = error
 166  4  = a dle failed
 167  8  = Don't know the status of a dle (RESULT_MISSING in the report)
 168  16 = tape error or no more tape
 169 </programlisting>
 170 </refsect1>
 171
 172 <seealso>
 173 <manref name="amcheck" vol="8"/>,
 174 <manref name="amdump" vol="8"/>,
 175 <manref name="amrestore" vol="8"/>,
 176 <manref name="amadmin" vol="8"/>
 177 </seealso>
 178
 179 </refentry>
 180