"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>amflush</refentrytitle>
<manvolnum>8</manvolnum>
+&rmi.source;
+&rmi.version;
+&rmi.manual.8;
</refmeta>
<refnamediv>
<refname>amflush</refname>
-<refpurpose>flush &A; backup files from holding disk to tape</refpurpose>
+<refpurpose>flush Amanda backup files from holding disk to tape</refpurpose>
</refnamediv>
+<refentryinfo>
+&author.jds;
+&author.sgw.xml;
+</refentryinfo>
<!-- body begins here -->
<refsynopsisdiv>
<cmdsynopsis>
<arg choice='opt'>-b</arg>
<arg choice='opt'>-f</arg>
<arg choice='opt'>-s</arg>
- <group><arg choice='plain'>-D</arg><arg choice='plain'><replaceable>datestamp</replaceable></arg></group>*
+ <arg choice='opt'>-D <replaceable>datestamp</replaceable></arg>
<arg choice='plain'><replaceable>config</replaceable></arg>
- <group><arg choice='plain'><replaceable>host</replaceable></arg><arg choice='opt'><replaceable>disk</replaceable></arg>*</group>*
- <group><arg choice='plain'>-o</arg><arg choice='plain'><replaceable>configoption</replaceable></arg></group>*
+ <arg choice='opt' rep='repeat'>
+ <arg choice='plain'><replaceable>host</replaceable></arg>
+ <arg choice='opt' rep='repeat'><replaceable>disk</replaceable></arg>
+ </arg>
+ &configoverride.synopsis;
</cmdsynopsis>
</refsynopsisdiv>
<refsect1><title>DESCRIPTION</title>
<para><emphasis remap='B'>Amflush</emphasis>
-writes &A; backups from the holding disks to tape,
-and updates the &A; info database and tapelist accordingly.
+writes Amanda backups from the holding disks to tape,
+and updates the Amanda info database and &tapelist; accordingly.
+It is similar to amdump, but does not perform any backup operations on
+Amanda clients.
Backups may stay in a holding disk when something is wrong with the tape
-at the time
-<emphasis remap='B'>amdump</emphasis>
-is run.
+at the time <command>amdump</command> is run.
When this happens, the problem must be corrected and
-<command>amflush</command>
-run by hand.</para>
+<command>amflush</command> run by hand.</para>
+
+<para>The command optionally takes a set of DLE specifications
+ (see <manref
+ name="amanda-match" vol="7"/>) to narrow the DLEs for which dumps will be flushed.
+All dumps in holding are flushed if no expressions are given.</para>
+
</refsect1>
<refsect1><title>OPTIONS</title>
<varlistentry>
<term><option>-D datestamp</option></term>
<listitem>
-<para>specify a datestamp expression you want to flush, see the
-"DATESTAMP EXPRESSION" section of
-<citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
-for a description.
+<para>specify a datestamp expression you want to flush; see
+<manref name="amanda-match" vol="7"/>
+for details on the format of this expression.
<option>-D 20001225-7</option>
-will flush all
-dumps from 25 december 2000 to 27 december 2000.</para>
+will flush all dumps from 25 december 2000 to 27 december 2000.</para>
</listitem>
</varlistentry>
<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 OVERWRITE</emphasis>" section in <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
- </listitem>
- </varlistentry>
+
+ &configoverride.varlistentry;
</variablelist>
<para>You can specify many host/disk expressions, only disks that
match an expression will be flushed. All disks are flushed if no
expressions are given. see the "HOST & DISK EXPRESSION" section of
-<citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+<manref name="amanda" vol="8"/>
for a description.</para>
<para><emphasis remap='B'>Amflush</emphasis>
will look in the holding disks specified by the
<emphasis remap='I'>amanda.conf</emphasis>
file in /usr/local/etc/amanda/<emphasis remap='I'>config</emphasis>
-for any non-empty &A; work directories.
+for any non-empty Amanda work directories.
It then prompts you to select a directory
or to process all of the directories.
The work directories in the holding disks are named by the date at the time
<literal>19910215</literal>.</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>EXAMPLE</title>
<command>amflush</command>
writes the data to tape, updates the databases and sends
a mail report similar to
-<citerefentry><refentrytitle>amdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
+<manref name="amdump" vol="8"/>.</para>
<programlisting>
-% amflush daily
+% amflush MyConfig
Scanning /amanda-hold...
- 20001113: found &A; directory.
- 20001114: found &A; directory.
+ 20001113: found Amanda directory.
+ 20001114: found Amanda directory.
-Multiple &A; directories, please pick one by letter:
+Multiple Amanda directories, please pick one by letter:
A. 20001113
B. 20001114
Select directories to flush [A..B]: [ALL] all
Running in background, you can log off now.
You'll get mail when amflush is finished.
</programlisting>
-</refsect1>
-<refsect1><title>AUTHOR</title>
-<para>James da Silva, &email.jds; : Original text</para>
-<para>&maintainer.sgw;: XML-conversion</para>
+<para>The following example causes amflush to flush everything to tape, then
+ejects tape, using 'at' to run the task in the background.</para>
+
+<programlisting>
+% echo 'amflush -b -f MyConfig && mt offline' | at now
+</programlisting>
</refsect1>
-<refsect1><title>SEE ALSO</title>
-<para><citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-<citerefentry><refentrytitle>amdump</refentrytitle><manvolnum>8</manvolnum></citerefentry></para>
+<refsect1><title>EXIT CODE</title>
+The exit code of <command>amflush</command> is the ORed value of:
+<programlisting>
+ 0 = success
+ 1 = error
+ 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>
+
+<seealso>
+<manref name="amdump" vol="8"/>
+<manref name="amanda-match" vol="7"/>
+</seealso>
+
</refentry>
projects / debian / amanda / blobdiff