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' rep='repeat'>
  34        <arg choice='plain'><replaceable>host</replaceable></arg>
  35        <arg choice='opt' rep='repeat'><replaceable>disk</replaceable></arg>
  36     </arg>
  37     &configoverride.synopsis;
  38 </cmdsynopsis>
  39 </refsynopsisdiv>
  40
  41
  42 <refsect1><title>DESCRIPTION</title>
  43 <para><emphasis remap='B'>Amdump</emphasis>
  44 switches to the appropriate Amanda configuration directory,
  45 e.g. /usr/local/etc/amanda/<emphasis remap='I'>config</emphasis>,
  46 then attempts to back up every disk specified by the
  47 <emphasis remap='I'>amanda.conf</emphasis>
  48 file.
  49 <emphasis remap='B'>Amdump</emphasis>
  50 is normally run by
  51 <emphasis remap='B'>cron</emphasis>.</para>
  52
  53 <para>You can specify many host/disk expressions, only disks that
  54 match an expression will be dumped. All disks are dumped if no
  55 expressions are given.</para>
  56
  57 <para>If the file /usr/local/etc/amanda/<emphasis remap='I'>config</emphasis>/hold exists,
  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>See the
  67 <manref name="amanda" vol="8"/>
  68 man page for more details about Amanda.</para>
  69 </refsect1>
  70
  71 <refsect1><title>OPTIONS</title>
  72 <variablelist remap='TP'>
  73
  74   <varlistentry>
  75   <term><replaceable>host</replaceable> [<replaceable>disk</replaceable>]*</term>
  76   <listitem>
  77 <para>Specify the host and disk on which the command will work.</para>
  78   </listitem>
  79   </varlistentry>
  80
  81   &configoverride.varlistentry;
  82
  83 </variablelist>
  84 </refsect1>
  85
  86 <refsect1><title>EXAMPLE</title>
  87 <para>Here is a typical crontab entry. It runs
  88 <command>amdump</command>
  89 every weeknight at 1 a.m. as user
  90 <emphasis remap='B'>bin</emphasis>:</para>
  91
  92 <programlisting>
  93 0 1 * * 1-5 bin /usr/local/sbin/amdump daily
  94 </programlisting>
  95
  96 <para>Please see the
  97 <manref name="crontab" vol="5"/>
  98 or
  99 <manref name="crontab" vol="1"/>
 100 manual page for the correct crontab format for your system.</para>
 101 </refsect1>
 102
 103 <refsect1><title>MESSAGES</title>
 104 <variablelist remap='TP'>
 105   <varlistentry>
 106   <term>amdump: waiting for hold file to be removed</term>
 107   <listitem>
 108 <para>The &quot;hold&quot; file exists and &amdump; is waiting for it to be removed
 109 before starting backups.</para>
 110   </listitem>
 111   </varlistentry>
 112   <varlistentry>
 113   <term>amdump: amdump or amflush is already running, or you must run amcleanup</term>
 114   <listitem>
 115 <para>Amdump detected another &amdump; or &amflush; running,
 116 or the remains of a previous incomplete &amdump; or &amflush; run.
 117 This run is terminated.
 118 If the problem is caused by the remains of a previous run,
 119 you must execute
 120 <manref name="amcleanup" vol="8"/>
 121 and then rerun
 122 <command>amdump</command>.</para>
 123   </listitem>
 124   </varlistentry>
 125 </variablelist>
 126 </refsect1>
 127
 128 <refsect1><title>EXIT CODE</title>
 129 The exit code of <command>amdump</command> is the ORed value of:
 130 <programlisting>
 131  0  = success
 132  1  = error
 133  2  = a dle give strange message
 134  4  = a dle failed
 135  8  = Don't know the status of a dle (RESULT_MISSING in the report)
 136  16 = tape error or no more tape
 137 </programlisting>
 138 </refsect1>
 139
 140 <seealso>
 141 <manref name="amcheck" vol="8"/>,
 142 <manref name="amcleanup" vol="8"/>,
 143 <manref name="amrestore" vol="8"/>,
 144 <manref name="amflush" vol="8"/>,
 145 <manref name="cron" vol="8"/>
 146 </seealso>
 147
 148 </refentry>
 149