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