git.gag.com Git - debian/amanda/blob - man/xml-source/amdump.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 <refentry id='amdump.8'>
  12
  13 <refmeta>
  14 <refentrytitle>amdump</refentrytitle>
  15 <manvolnum>8</manvolnum>
  16 &rmi.source;
  17 &rmi.version;
  18 &rmi.manual.8;
  19 </refmeta>
  20 <refnamediv>
  21 <refname>amdump</refname>
  22 <refpurpose>back up all disks in an Amanda configuration</refpurpose>
  23 </refnamediv>
  24 <refentryinfo>
  25 &author.jds;
  26 &author.sgw.xml;
  27 </refentryinfo>
  28 <!-- body begins here -->
  29 <refsynopsisdiv>
  30 <cmdsynopsis>
  31   <command>amdump</command>
  32     <arg choice='opt'>--no-taper</arg>
  33     <arg choice='opt'>--exact-match</arg>
  34     &configoverride.synopsis;
  35     <arg choice='plain'><replaceable>config</replaceable></arg>
  36     <arg choice='opt' rep='repeat'>
  37        <arg choice='plain'><replaceable>host</replaceable></arg>
  38        <arg choice='opt' rep='repeat'><replaceable>disk</replaceable></arg>
  39     </arg>
  40 </cmdsynopsis>
  41 </refsynopsisdiv>
  42
  43
  44 <refsect1><title>DESCRIPTION</title>
  45 <para><emphasis remap='B'>Amdump</emphasis>
  46 is the main interface to the Amanda backup process.  It loads the specified configuration
  47 and attempts to back up every disk specified by the
  48 &disklist;.
  49 <emphasis remap='B'>Amdump</emphasis>
  50 is normally run by
  51 <emphasis remap='B'>cron</emphasis>.</para>
  52
  53 <para>The command optionally takes a set of DLE specifications
  54     (see <manref
  55     name="amanda-match" vol="7"/>) to narrow the DLEs that will be dumped.
  56 All disks are dumped if no expressions are given.</para>
  57
  58 <para>If a file named <filename>hold</filename> exists in the configuration directory,
  59 <command>amdump</command>
  60 will wait until it is removed before starting the backups.
  61 This allows scheduled backups to be delayed when circumstances warrant, for example,
  62 if the tape device is being used for some other purpose.
  63 While waiting,
  64 <command>amdump</command>
  65 checks for the hold file every minute.</para>
  66
  67 <para>In some cases it is desirable to dump all Amanda clients to holding disk
  68 without writing anything to storage media.  The <option>--no-taper</option>
  69 option instructs Amanda to not start the taper, and thus enter degraded mode
  70 immediately.</para>
  71
  72 <para>See the
  73 <manref name="amanda" vol="8"/>
  74 man page for more details about Amanda.</para>
  75 </refsect1>
  76
  77 <refsect1><title>OPTIONS</title>
  78 <variablelist remap='TP'>
  79
  80   <varlistentry>
  81   <term><replaceable>host</replaceable> [<replaceable>disk</replaceable>]*</term>
  82   <listitem>
  83 <para>Specify the host and disk on which the command will work -- see
  84     the description of DLE specifications in <manref name="amanda-match" vol="7"/>. </para>
  85   </listitem>
  86   </varlistentry>
  87
  88   <varlistentry>
  89   <term><option>--exact-match</option></term>
  90   <listitem>
  91 <para>The host and disk are parsed as exact values</para>
  92   </listitem>
  93   </varlistentry>
  94
  95   &configoverride.varlistentry;
  96
  97 </variablelist>
  98 </refsect1>
  99
 100 <refsect1><title>EXAMPLE</title>
 101 <para>Here is a typical crontab entry. It runs
 102 <command>amdump</command>
 103 every weeknight at 1 a.m. as user
 104 <emphasis remap='B'>bin</emphasis>:</para>
 105
 106 <programlisting>
 107 0 1 * * 1-5 bin /usr/local/sbin/amdump daily
 108 </programlisting>
 109
 110 <para>Please see the
 111 <manref name="crontab" vol="5"/>
 112 or
 113 <manref name="crontab" vol="1"/>
 114 manual page for the correct crontab format for your system.</para>
 115 </refsect1>
 116
 117 <refsect1><title>MESSAGES</title>
 118 <variablelist remap='TP'>
 119   <varlistentry>
 120   <term>amdump: waiting for hold file to be removed</term>
 121   <listitem>
 122 <para>The &quot;hold&quot; file exists and &amdump; is waiting for it to be removed
 123 before starting backups.</para>
 124   </listitem>
 125   </varlistentry>
 126   <varlistentry>
 127   <term>amdump: amdump or amflush is already running, or you must run amcleanup</term>
 128   <listitem>
 129 <para>Amdump detected another &amdump; or &amflush; running,
 130 or the remains of a previous incomplete &amdump; or &amflush; run.
 131 This run is terminated.
 132 If the problem is caused by the remains of a previous run,
 133 you must execute
 134 <manref name="amcleanup" vol="8"/>
 135 and then rerun
 136 <command>amdump</command>.</para>
 137   </listitem>
 138   </varlistentry>
 139 </variablelist>
 140 </refsect1>
 141
 142 <refsect1><title>EXIT CODE</title>
 143 The exit code of <command>amdump</command> is the ORed value of:
 144 <programlisting>
 145  0  = success
 146  1  = error
 147  2  = a dle give strange message
 148  4  = a dle failed
 149  8  = Don't know the status of a dle (RESULT_MISSING in the report)
 150  16 = tape error or no more tape
 151 </programlisting>
 152 </refsect1>
 153
 154 <seealso>
 155 <manref name="amcheck" vol="8"/>,
 156 <manref name="amcleanup" vol="8"/>,
 157 <manref name="amrestore" vol="8"/>,
 158 <manref name="amflush" vol="8"/>,
 159 <manref name="cron" vol="8"/>
 160 <manref name="amanda-match" vol="7"/>
 161 </seealso>
 162
 163 </refentry>
 164