"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
[
<!-- entities files to use -->
- <!ENTITY % global_entities SYSTEM '../entities/global.entities'>
+ <!ENTITY % global_entities SYSTEM 'global.entities'>
%global_entities;
]>
<refmeta>
<refentrytitle>amdump</refentrytitle>
<manvolnum>8</manvolnum>
+&rmi.source;
+&rmi.version;
+&rmi.manual.8;
</refmeta>
<refnamediv>
<refname>amdump</refname>
-<refpurpose>back up all disks in an &A; configuration</refpurpose>
+<refpurpose>back up all disks in an Amanda configuration</refpurpose>
</refnamediv>
+<refentryinfo>
+&author.jds;
+&author.sgw.xml;
+</refentryinfo>
<!-- body begins here -->
<refsynopsisdiv>
<cmdsynopsis>
<command>amdump</command>
+ <arg choice='opt'><option>--no-taper</option></arg>
+ &configoverride.synopsis;
<arg choice='plain'><replaceable>config</replaceable></arg>
<arg choice='opt' rep='repeat'>
<arg choice='plain'><replaceable>host</replaceable></arg>
<arg choice='opt' rep='repeat'><replaceable>disk</replaceable></arg>
</arg>
- <arg choice='plain' rep='repeat'><group><arg choice='plain'>-o </arg><replaceable>configoption</replaceable></group></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1><title>DESCRIPTION</title>
<para><emphasis remap='B'>Amdump</emphasis>
-switches to the appropriate &A; configuration directory,
-e.g. /usr/local/etc/amanda/<emphasis remap='I'>config</emphasis>,
-then attempts to back up every disk specified by the
-<emphasis remap='I'>amanda.conf</emphasis>
-file.
+is the main interface to the Amanda backup process. It loads the specified configuration
+and attempts to back up every disk specified by the
+&disklist;.
<emphasis remap='B'>Amdump</emphasis>
is normally run by
<emphasis remap='B'>cron</emphasis>.</para>
-<para>You can specify many host/disk expressions, only disks that
-match an expression will be dumped. All disks are dumped if no
-expressions are given.</para>
+<para>The command optionally takes a set of DLE specifications
+ (see <manref
+ name="amanda-match" vol="7"/>) to narrow the DLEs that will be dumped.
+All disks are dumped if no expressions are given.</para>
-<para>If the file /usr/local/etc/amanda/<emphasis remap='I'>config</emphasis>/hold exists,
+<para>If a file named <filename>hold</filename> exists in the configuration directory,
<command>amdump</command>
will wait until it is removed before starting the backups.
This allows scheduled backups to be delayed when circumstances warrant, for example,
<command>amdump</command>
checks for the hold file every minute.</para>
+<para>In some cases it is desirable to dump all Amanda clients to holding disk
+without writing anything to storage media. The <option>--no-taper</option>
+option instructs Amanda to not start the taper, and thus enter degraded mode
+immediately.</para>
+
<para>See the
-<citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
-man page for more details about &A;.</para>
+<manref name="amanda" vol="8"/>
+man page for more details about Amanda.</para>
</refsect1>
<refsect1><title>OPTIONS</title>
<varlistentry>
<term><replaceable>host</replaceable> [<replaceable>disk</replaceable>]*</term>
<listitem>
-<para>Specify the host and disk on which the command will work.</para>
+<para>Specify the host and disk on which the command will work -- see
+ the description of DLE specifications in <manref name="amanda-match" vol="7"/>. </para>
</listitem>
</varlistentry>
- <varlistentry>
- <term><emphasis remap='B'>-o</emphasis> <replaceable>configoption</replaceable></term>
- <listitem>
-<para>See the "<emphasis remap='B'>CONFIGURATION OVERRIDE</emphasis>" section in <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
- </listitem>
- </varlistentry>
+ &configoverride.varlistentry;
</variablelist>
</refsect1>
</programlisting>
<para>Please see the
-<citerefentry><refentrytitle>crontab</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+<manref name="crontab" vol="5"/>
or
-<citerefentry><refentrytitle>crontab</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+<manref name="crontab" vol="1"/>
manual page for the correct crontab format for your system.</para>
</refsect1>
This run is terminated.
If the problem is caused by the remains of a previous run,
you must execute
-<citerefentry><refentrytitle>amcleanup</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+<manref name="amcleanup" vol="8"/>
and then rerun
<command>amdump</command>.</para>
</listitem>
</variablelist>
</refsect1>
-<refsect1><title>AUTHOR</title>
-<para>James da Silva, &email.jds; : Original text</para>
-<para>&maintainer.sgw;: XML-conversion</para>
+<refsect1><title>EXIT CODE</title>
+The exit code of <command>amdump</command> is the ORed value of:
+<programlisting>
+ 0 = success
+ 1 = error
+ 2 = a dle give strange message
+ 4 = a dle failed
+ 8 = Don't know the status of a dle (RESULT_MISSING in the report)
+ 16 = tape error or no more tape
+</programlisting>
</refsect1>
-<refsect1><title>SEE ALSO</title>
-<para>
- <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>amcheck</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>amcleanup</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>amrestore</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>amflush</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>cron</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
- <ulink url="http://wiki.zmanda.com"/>
-</para>
-</refsect1>
+<seealso>
+<manref name="amcheck" vol="8"/>,
+<manref name="amcleanup" vol="8"/>,
+<manref name="amrestore" vol="8"/>,
+<manref name="amflush" vol="8"/>,
+<manref name="cron" vol="8"/>
+<manref name="amanda-match" vol="7"/>
+</seealso>
+
</refentry>
projects / debian / amanda / blobdiff