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 '../entities/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 &A; 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     <arg choice='plain' rep='repeat'><group><arg choice='plain'>-o </arg><replaceable>configoption</replaceable></group></arg>
  38 </cmdsynopsis>
  39 </refsynopsisdiv>
  40
  41
  42 <refsect1><title>DESCRIPTION</title>
  43 <para><emphasis remap='B'>Amdump</emphasis>
  44 switches to the appropriate &A; 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 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  68 man page for more details about &A;.</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   <varlistentry>
  82   <term><emphasis remap='B'>-o</emphasis> <replaceable>configoption</replaceable></term>
  83   <listitem>
  84 <para>See the "<emphasis remap='B'>CONFIGURATION OVERRIDE</emphasis>" section in <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
  85   </listitem>
  86   </varlistentry>
  87
  88 </variablelist>
  89 </refsect1>
  90
  91 <refsect1><title>EXAMPLE</title>
  92 <para>Here is a typical crontab entry. It runs
  93 <command>amdump</command>
  94 every weeknight at 1 a.m. as user
  95 <emphasis remap='B'>bin</emphasis>:</para>
  96
  97 <programlisting>
  98 0 1 * * 1-5 bin /usr/local/sbin/amdump daily
  99 </programlisting>
 100
 101 <para>Please see the
 102 <citerefentry><refentrytitle>crontab</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 103 or
 104 <citerefentry><refentrytitle>crontab</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 105 manual page for the correct crontab format for your system.</para>
 106 </refsect1>
 107
 108 <refsect1><title>MESSAGES</title>
 109 <variablelist remap='TP'>
 110   <varlistentry>
 111   <term>amdump: waiting for hold file to be removed</term>
 112   <listitem>
 113 <para>The &quot;hold&quot; file exists and &amdump; is waiting for it to be removed
 114 before starting backups.</para>
 115   </listitem>
 116   </varlistentry>
 117   <varlistentry>
 118   <term>amdump: amdump or amflush is already running, or you must run amcleanup</term>
 119   <listitem>
 120 <para>Amdump detected another &amdump; or &amflush; running,
 121 or the remains of a previous incomplete &amdump; or &amflush; run.
 122 This run is terminated.
 123 If the problem is caused by the remains of a previous run,
 124 you must execute
 125 <citerefentry><refentrytitle>amcleanup</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 126 and then rerun
 127 <command>amdump</command>.</para>
 128   </listitem>
 129   </varlistentry>
 130 </variablelist>
 131 </refsect1>
 132
 133 <refsect1><title>EXIT CODE</title>
 134 The exit code of <command>amdump</command> is the ORed value of:
 135 <programlisting>
 136  0  = success
 137  1  = error
 138  2  = a dle give strange message
 139  4  = a dle failed
 140  8  = Don't know the status of a dle (RESULT_MISSING in the report)
 141  16 = tape error or no more tape
 142 </programlisting>
 143 </refsect1>
 144
 145 <refsect1><title>SEE ALSO</title>
 146 <para>
 147   <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 148   <citerefentry><refentrytitle>amcheck</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 149   <citerefentry><refentrytitle>amcleanup</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 150   <citerefentry><refentrytitle>amrestore</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 151   <citerefentry><refentrytitle>amflush</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 152   <citerefentry><refentrytitle>cron</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 153   <ulink url="http://wiki.zmanda.com"/>
 154 </para>
 155 </refsect1>
 156 </refentry>
 157