"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;
]>
<!-- lifted from troff+man by doclifter -->
<refentry id='amadmin.8'>
+
<refmeta>
<refentrytitle>amadmin</refentrytitle>
<manvolnum>8</manvolnum>
+&rmi.source;
+&rmi.version;
+&rmi.manual.8;
</refmeta>
<refnamediv>
<refname>amadmin</refname>
-<refpurpose>administrative interface to control &A; backups</refpurpose>
+<refpurpose>administrative interface to control Amanda backups</refpurpose>
</refnamediv>
+<refentryinfo>
+&author.jds;
+&author.sgw.xml;
+</refentryinfo>
<!-- body begins here -->
<refsynopsisdiv>
<cmdsynopsis>
<arg choice='plain'><replaceable>config</replaceable></arg>
<arg choice='plain'><replaceable>command</replaceable></arg>
<arg choice='opt' rep='repeat'><replaceable>command_options</replaceable></arg>
- <arg choice='plain' rep='repeat'><group><option>-o </option><replaceable>configoption</replaceable></group></arg>
+ &configoverride.synopsis;
</cmdsynopsis>
</refsynopsisdiv>
<para><emphasis remap='B'>Amadmin</emphasis>
performs various administrative tasks on the
<emphasis remap='I'>config</emphasis>
-&A; configuration.</para>
+Amanda configuration.</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>COMMANDS</title>
-<para>Commands that take a
-<emphasis remap='I'>hostname</emphasis>
-[
-<emphasis remap='I'>disks</emphasis>
-]
-parameter pair operate on all disks in the
-<emphasis remap='I'>disklist</emphasis>
-for that
-<emphasis remap='I'>hostname</emphasis>
-if no disks are specified.
-Where
-<emphasis remap='I'>hostname</emphasis>
-is also marked as being optional,
-the command operates on all hosts and disks in the
-<emphasis remap='I'>disklist</emphasis>.
-Both
-<emphasis remap='I'>hostname</emphasis>
-and
-<emphasis remap='I'>disks</emphasis>
-are special expressions, see the "HOST & DISK EXPRESSION" section
-of
-<citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
-for a description.</para>
+<para>Commands that take a <emphasis remap='I'>hostname</emphasis> [ <emphasis remap='I'>disks</emphasis> ]
+parameter pair operate on all disks in the &disklist; for that
+<emphasis remap='I'>hostname</emphasis> if no disks are specified. Where
+<emphasis remap='I'>hostname</emphasis> is also marked as being optional,
+the command operates on all hosts and disks in the &disklist; when no hostname is given.
+Both <emphasis remap='I'>hostname</emphasis> and <emphasis remap='I'>disks</emphasis>
+are match expressions; see <manref name="amanda-match" vol="7"/> for a description.</para>
<variablelist remap='TP'>
<varlistentry>
The
<emphasis remap='I'>config</emphasis>
parameter must be present but is ignored.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>estimate</emphasis> [ <emphasis remap='I'>hostname</emphasis> [ <emphasis remap='I'>disks</emphasis> ]* ]*</term>
+ <listitem>
+<para>Print the server estimate for the dles, each output lines have the following format:</para>
+<programlisting>
+ hostname diskname level size
+</programlisting>
+<variablelist remap='TP'>
+<varlistentry>
+<term>hostname</term>
+<listitem>The quoted hostname
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>diskname</term>
+<listitem>The quoted diskname
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>level</term>
+<listitem>The level of the estimate
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>size</term>
+<listitem>The estimate size in kbytes
+</listitem>
+</varlistentry>
+</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<emphasis remap='I'>disks</emphasis>
on
<emphasis remap='I'>hostname</emphasis>
-to bump to a new incremental level during the next &A; run.</para>
+to bump to a new incremental level during the next Amanda run.</para>
</listitem>
</varlistentry>
<varlistentry>
<emphasis remap='I'>disks</emphasis>
on
<emphasis remap='I'>hostname</emphasis>
-to not bump to a new incremental level during the next &A; run.</para>
+to not bump to a new incremental level during the next Amanda run.</para>
</listitem>
</varlistentry>
<varlistentry>
<emphasis remap='I'>disks</emphasis>
on
<emphasis remap='I'>hostname</emphasis>
-to do a full (level 0) backup during the next &A; run.</para>
+to do a full (level 0) backup during the next Amanda run.</para>
</listitem>
</varlistentry>
<varlistentry>
Note that if this causes the number of reusable tapes to drop below the
<emphasis remap='B'>amanda.conf</emphasis>
<emphasis remap='I'>tapecycle</emphasis>
-value, &A; will request new tapes until the count is satisfied again.</para>
+value, Amanda will request new tapes until the count is satisfied again.</para>
+<para>Tape marked <emphasis remap='I'>no-reuse</emphasis> are available
+for recovery, marking them <emphasis remap='I'>no-reuse</emphasis> is a
+security to be sure amanda will not overwrite them.</para>
</listitem>
</varlistentry>
<varlistentry>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>find</emphasis> [ <option>--sort</option> <replaceable>hkdlpb</replaceable> ]<emphasis remap='B'></emphasis> [ <emphasis remap='I'>hostname</emphasis> [ <emphasis remap='I'>disks</emphasis> ]* ]*</term>
+ <term><emphasis remap='B'>find</emphasis> [ <option>--sort</option> <replaceable>hkdlpbfw</replaceable> ]<emphasis remap='B'></emphasis> [ <emphasis remap='I'>hostname</emphasis> [ <emphasis remap='I'>disks</emphasis> ]* ]*</term>
<listitem>
<para>Display all backups currently on tape or in the holding disk.
The tape label or holding disk filename,
<programlisting>
<emphasis>h</emphasis>: host name
<emphasis>k</emphasis>: disk name
-<emphasis>d</emphasis>: dump date
+<emphasis>d</emphasis>: dump timestamp
<emphasis>l</emphasis>: backup level
<emphasis>p</emphasis>: dump part
<emphasis>b</emphasis>: tape label
+<emphasis>f</emphasis>: filenum on tape
+<emphasis>w</emphasis>: write timestamp
</programlisting></para>
<para>An uppercase letter reverses the sort order for that key.
-The default sort order is <emphasis remap='B'>hkdlpb</emphasis>.</para>
+The default sort order is <emphasis remap='B'>hkdlpbfw</emphasis>.</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>holding delete</emphasis> <emphasis remap="I">hostname</emphasis> [ <emphasis remap="I">disk</emphasis> [ <emphasis remap="I">datestamp</emphasis> [ .. ] ] ]</term>
+ <listitem>
+
+ <para>Delete holding files matching the given specification. At least
+ a hostname must be provided.</para>
+
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><emphasis remap='B'>holding list</emphasis> [-l] [-d] [ <emphasis remap="I">hostname</emphasis> [ <emphasis remap="I">disk</emphasis> [ <emphasis remap="I">datestamp</emphasis> [ .. ] ] ] ]</term>
+ <listitem>
+
+ <para>List holding files matching the given dump specification, or all
+ holding files if no specification is provided. See <manref
+ name="amanda-match" vol="7"/> for more information on dump
+ specifications. With '-l', additional information (size, level, and
+ whether the dump is outdated) is provided. With '-d', only outdated
+ dumps are shown.</para>
+
+ <para>An outdated holding file is one which is not required for a
+ restore of the <emphasis>most recent</emphasis> dump. Note that
+ outdated dumps may still be required for restores at earlier dates.
+ For example, assume that a DLE had a level 0 on Monday, level
+ 1's Tuesday through Thursday, and a level 2 on Friday. Then the
+ files required for a restore of Fridays (the most recent) dump
+ are those from Monday (level 0), Thursday (level 1), and Friday
+ (level 2). Tuesday and Wednesday's files are outdated. </para>
+
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term><emphasis remap='B'>delete</emphasis> [ <emphasis remap='I'>hostname</emphasis> [ <emphasis remap='I'>disks</emphasis> ]* ]+</term>
<listitem>
<emphasis remap='I'>disks</emphasis>
on
<emphasis remap='I'>hostname</emphasis>
-from the &A; database.</para>
-<note><para>If you do not also remove the disk from the
-<emphasis remap='I'>disklist</emphasis>
-file, &A; will treat it as a new disk during the next run.</para>
+from the Amanda database.</para>
+<note><para>If you do not also remove the disk from the &disklist;
+file, Amanda will treat it as a new disk during the next run.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis remap='B'>tape</emphasis></term>
<listitem>
-<para>Display the tape(s) &A; expects to write to during the next run.
+<para>Display the tape(s) Amanda expects to write to during the next run.
See also
-<citerefentry><refentrytitle>amcheck</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
+<manref name="amcheck" vol="8"/>.</para>
</listitem>
</varlistentry>
<varlistentry>
<varlistentry>
<term><emphasis remap='B'>export</emphasis> [ <emphasis remap='I'>hostname</emphasis> [ <emphasis remap='I'>disks</emphasis> ]* ]*</term>
<listitem>
-<para>Convert records from the &A; database
-to a text format that may be transmitted to another &A; machine and
+<para>Convert records from the Amanda database
+to a text format that may be transmitted to another Amanda machine and
<emphasis remap='B'>import</emphasis>ed.</para>
</listitem>
</varlistentry>
<listitem>
<para>Convert
<emphasis remap='B'>export</emphasis>ed
-records read from standard input to a form &A; uses
+records read from standard input to a form Amanda uses
and insert them into the database on this machine.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis remap='B'>disklist</emphasis> [ <emphasis remap='I'>hostname</emphasis> [ <emphasis remap='I'>disks</emphasis> ]* ]*</term>
<listitem>
-<para>Display the
-<emphasis remap='I'>disklist</emphasis>
+<para>Display the &disklist;
information for each of the
<emphasis remap='I'>disks</emphasis>
on
<emphasis remap='I'>hostname</emphasis>
(or all hosts).
Mostly used for debugging.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>hosts</emphasis></term>
+ <listitem>
+<para>Output a list of distinct hosts in the &disklist;, one per line, for easy use in shell scripts.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>dles</emphasis></term>
+ <listitem>
+<para>Output a list of distinct DLEs in the &disklist;, one per line with host and diskname separated by a space, for easy use in shell scripts.</para>
</listitem>
</varlistentry>
<varlistentry>
</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>
</refsect1>
<refsect1><title>EXAMPLES</title>
<para>Request three specific file systems on
<emphasis remap='I'>machine-a</emphasis>
-get a full level 0 backup during the next &A; run.</para>
+get a full level 0 backup during the next Amanda run.</para>
<programlisting>
$ amadmin daily force machine-a / /var /usr
<para>Request all file systems on
<emphasis remap='I'>machine-b</emphasis>
-get a full level 0 backup during the next &A; run.</para>
+get a full level 0 backup during the next Amanda run.</para>
<programlisting>
$ amadmin daily force machine-b
<filename>/workspace</filename>
disk on
<emphasis remap='I'>machine-d</emphasis>.
-If you do not also remove the disk from the
-<emphasis remap='I'>disklist</emphasis>
-file, &A; will treat it as a new disk during the next run.</para>
+If you do not also remove the disk from the &disklist;
+file, Amanda will treat it as a new disk during the next run.</para>
<programlisting remap='.nf'>
$ amadmin daily delete machine-d /workspace
amadmin: machine-d:/workspace deleted from database.
-amadmin: NOTE: you'll have to remove these from the disklist yourself.
+amadmin: NOTE: you'll have to remove these from the &disklist; yourself.
</programlisting>
-<para>Find the next tape &A; will use (in this case, <literal>123456</literal>).</para>
+<para>Find the next tape Amanda will use (in this case, <literal>123456</literal>).</para>
<programlisting>
$ amadmin daily tape
-The next &A; run should go onto tape 123456 or a new tape.
+The next Amanda run should go onto tape 123456 or a new tape.
</programlisting>
<para>Show how well full backups are balanced across the dump cycle.
<emphasis remap='I'>balance</emphasis>
column shows how far off that night's backups are from the average size
(shown at the bottom of the balance column).
-&A; tries to keep the backups within +/- 5%,
+Amanda tries to keep the backups within +/- 5%,
but since the amount of data on each filesystem is always changing,
-and &A; will never delay backups just to rebalance the schedule,
+and Amanda will never delay backups just to rebalance the schedule,
it is common for the schedule to fluctuate by larger percentages.
In particular, in the case of a tape or backup failure, a bump will occur the following night,
which will not be smoothed out until the next pass through the schedule.</para>
-<para>The last line also shows an estimate of how many &A; runs will be
+<para>The last line also shows an estimate of how many Amanda runs will be
made between full backups for a file system.
In the example, a file system will probably have a full backup done
-every eight times &A; is run (e.g. every eight days).</para>
+every eight times Amanda is run (e.g. every eight days).</para>
<programlisting>
$ amadmin daily balance
</programlisting>
</refsect1>
-<refsect1><title>FILES</title>
-<para>/usr/local/etc/amanda/<emphasis remap='I'>config</emphasis>/amanda.conf</para>
-</refsect1>
+<seealso>
+<manref name="amanda" vol="8"/>,
+<manref name="amcheck" vol="8"/>,
+<manref name="amdump" vol="8"/>,
+<manref name="amrestore" vol="8"/>,
+<manref name="amfetchdump" vol="8"/>
+<manref name="amanda-match" vol="7"/>,
+</seealso>
-<refsect1><title>AUTHOR</title>
-<para>James da Silva, &email.jds; : Original text</para>
-<para>&maintainer.sgw;: XML-conversion</para>
-</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>amdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-<citerefentry><refentrytitle>amrestore</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-<citerefentry><refentrytitle>amfetchdump</refentrytitle><manvolnum>8</manvolnum></citerefentry></para>
-</refsect1>
</refentry>
projects / debian / amanda / blobdiff