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"
5 <!-- entities files to use -->
6 <!ENTITY % global_entities SYSTEM '../entities/global.entities'>
10 <!-- lifted from troff+man by doclifter -->
11 <refentry id='amanda.8'>
14 <refentrytitle>amanda</refentrytitle>
15 <manvolnum>8</manvolnum>
21 <refname>amanda</refname>
22 <refpurpose>The Open Source Backup Platform</refpurpose>
28 <!-- body begins here -->
30 <refsect1><title>DESCRIPTION</title>
31 <para>This manual page gives an overview of the &A; commands and
32 configuration files for quick reference.</para>
35 - NOTE: the comma after each citerefentry works around a bug in the docbook-to-man conversion; using
36 - causes problems in the docbook-to-html conversion.
39 <refsect2><title>COMMANDS</title> <!-- a.k.a. any section 8 manpage -->
40 <para>Here are all the &A; commands. Each one has its own manual page. See them for all the gory details.</para>
43 <citerefentry><refentrytitle>amaddclient</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
46 <citerefentry><refentrytitle>amadmin</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
49 <citerefentry><refentrytitle>amaespipe</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
52 <citerefentry><refentrytitle>amcheck</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
55 <citerefentry><refentrytitle>amcheckdb</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
58 <citerefentry><refentrytitle>amcheckdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
61 <citerefentry><refentrytitle>amcleanup</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
64 <citerefentry><refentrytitle>amcrypt-ossl-asym</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
67 <citerefentry><refentrytitle>amcrypt-ossl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
70 <citerefentry><refentrytitle>amcrypt</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
73 <citerefentry><refentrytitle>amcryptsimple</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
76 <citerefentry><refentrytitle>amdd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
79 <citerefentry><refentrytitle>amdevcheck</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
82 <citerefentry><refentrytitle>amdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
85 <citerefentry><refentrytitle>amfetchdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
88 <citerefentry><refentrytitle>amflush</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
91 <citerefentry><refentrytitle>amgetconf</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
94 <citerefentry><refentrytitle>amgpgcrypt</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
97 <citerefentry><refentrytitle>amgtar</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
100 <citerefentry><refentrytitle>amlabel</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
103 <citerefentry><refentrytitle>ammt</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
106 <citerefentry><refentrytitle>amoverview</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
109 <citerefentry><refentrytitle>amplot</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
112 <citerefentry><refentrytitle>amrecover</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
115 <citerefentry><refentrytitle>amreport</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
118 <citerefentry><refentrytitle>amrestore</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
121 <citerefentry><refentrytitle>amrmtape</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
124 <citerefentry><refentrytitle>amsamba</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
127 <citerefentry><refentrytitle>amserverconfig</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
130 <citerefentry><refentrytitle>amservice</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
133 <citerefentry><refentrytitle>amstar</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
136 <citerefentry><refentrytitle>amstatus</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
139 <citerefentry><refentrytitle>amtape</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
142 <citerefentry><refentrytitle>amtapetype</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
145 <citerefentry><refentrytitle>amtoc</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
148 <citerefentry><refentrytitle>amvault</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
151 <citerefentry><refentrytitle>amzfs-sendrecv</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
154 <citerefentry><refentrytitle>amzfs-snapshot</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
157 <citerefentry><refentrytitle>script-email</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
161 <refsect2><title>CONFIGURATION FILES</title> <!-- a.k.a. most section 5 manpages -->
164 <citerefentry><refentrytitle>amanda.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
167 <citerefentry><refentrytitle>amanda-client.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
170 <citerefentry><refentrytitle>disklist</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
173 <citerefentry><refentrytitle>tapelist</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
177 <refsect2><title>DATA FORMATS</title> <!-- a.k.a. section 5 manpages about internal data formats -->
180 <citerefentry><refentrytitle>amanda-archive-format</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
184 <refsect2><title>CONCEPTS</title> <!-- a.k.a. any section 7 manpage -->
187 <citerefentry><refentrytitle>amanda-applications</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
190 <citerefentry><refentrytitle>amanda-auth</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
193 <citerefentry><refentrytitle>amanda-changers</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
196 <citerefentry><refentrytitle>amanda-devices</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
199 <citerefentry><refentrytitle>amanda-scripts</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
205 <refsect1><title>CONFIGURATION</title>
206 <para>There are four user-editable files that control the behavior of &A;.
209 The first two are &amconf; and &amclientconf;,
210 the main configuration files for the server and client, respectively.
211 They contain parameters to customize &A; for the site.
214 Next is the &disklist; file, which lists hosts and disk partitions to back up.
217 Last is the seldom-edited &tapelist;
218 file, which lists tapes that are currently active.
219 These files are described in more detail in the following sections.</para>
221 <para>All files are stored in individual configuration
222 directories, usually under <filename>/etc/amanda/</filename>.
223 A site will often have more than
225 For example, it might have a
226 <emphasis remap='I'>normal</emphasis>
227 configuration for everyday backups and an
228 <emphasis remap='I'>archive</emphasis>
229 configuration for infrequent full archival backups.
230 The configuration files would be stored under directories
231 <filename>/etc/amanda/normal/</filename> and
232 <filename>/etc/amanda/archive/</filename>, respectively.
233 Part of the job of an &A; administrator is to create,
234 populate and maintain these directories.</para>
237 <refsect1><title>LOG FILES</title>
238 <para>All log and database files generated by &A; go in corresponding
239 directories somewhere.
240 The exact location is controlled by entries in
241 <citerefentry><refentrytitle>amanda.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
242 A typical location would be under <filename>/var/adm/amanda</filename>.
243 For the above example, the files might go in
244 <filename>/var/adm/amanda/normal/</filename> and
245 <filename>/var/adm/amanda/archive/</filename>.
248 <para>As log files are no longer needed (no longer contain relevant information),
249 &A; cycles them out in various ways, depending on the type of file.</para>
251 <para>Detailed information about
252 <command>amdump</command>
253 runs are stored in dump logs -- files named
254 <emphasis remap='B'>amdump.</emphasis><emphasis remap='I'>NN</emphasis>
256 <emphasis remap='I'>NN</emphasis>
257 is a sequence number, with 1 being the most recent file.
258 <emphasis remap='B'>Amdump</emphasis>
259 rotates these files each run, keeping roughly the last
260 <emphasis remap='B'>tapecycle</emphasis>
262 worth of them.</para>
264 <para>The file used by
265 <emphasis remap='B'>amreport</emphasis>
266 to generate the mail summary is the trace log. This file constitutes the "catalog"
267 describing the data on the tapes written in a run. It is named
268 <emphasis remap='B'>log.</emphasis><emphasis remap='I'>YYYYMMDDHHMMSS.NN</emphasis>
270 <emphasis remap='I'>YYYYMMDDHHMMSS</emphasis>
271 is the datestamp of the start of the
272 <command>amdump</command> or <command>amflush</command>
274 <emphasis remap='I'>NN</emphasis>
275 is a sequence number started at 0.
277 <command>amdump</command>
279 log files for runs whose tapes have been reused are renamed
280 into a subdirectory of the main log directory (see the
281 <emphasis remap='B'>logdir</emphasis>
284 <emphasis remap='B'>oldlog</emphasis>.
285 It is up to the &A; administrator to remove them from this
286 directory when desired.</para>
288 <para>Index (backup image catalogue) files older than the full dump
289 matching the oldest backup image for a given client and disk
291 <command>amdump</command>
292 at the end of each run.</para>
296 <refsect1><title>Using Samba</title>
297 <para>For Samba access, &A; needs a file on the Samba server (which may
298 or may not also be the tape server) named
299 <filename>/etc/amandapass</filename>
300 with share names, (clear text) passwords and (optional) domain names,
301 in that order, one per line, whitespace separated.
302 By default, the user used to connect to the PC is the same for all
303 PC's and is compiled into &A;.
304 It may be changed on a host by host basis
305 by listing it first in the password field followed
306 by a percent sign and then the password.
309 //some-pc/home normalpw
310 //another-pc/disk otheruser%otherpw
312 <para>With clear text passwords, this file should obviously be tightly protected.
313 It only needs to be readable by the &A;-user on the Samba server. </para>
316 <refsect1><title>HOST & DISK EXPRESSION</title>
317 <para>All host and disk arguments to programs are special expressions.
318 The command applies to all disks that match your arguments.
319 This section describes the matcher.</para>
321 <para>The matcher matches by word, each word is a glob expression, words
322 are separated by the separator '.' for host and '/' for disk. You
323 can anchor the expression at left with a '^'. You can
324 anchor the expression at right with a '$'. The matcher
325 is case insensitive for host but is case sensitive for disk. A match
326 succeeds if all words in your expression match contiguous words in
327 the host or disk.</para>
330 <variablelist remap='TP'>
333 <term>dot (.)</term> <!-- troff gets confused by a plain dot -->
334 <listitem><para>word separator for a host</para></listitem>
339 <listitem><para>word separator for a disk</para></listitem>
344 <listitem><para>anchor at left</para></listitem>
349 <listitem><para>anchor at right</para></listitem>
354 <listitem><para>match exactly one character except the separator</para></listitem>
359 <listitem><para>match zero or more characters except the separator</para></listitem>
364 <listitem><para>match zero or more characters including the separator</para></listitem>
369 <para>Some examples:</para>
371 <variablelist remap='TP'>
375 Will match <filename>hosta</filename>, <filename>foo.hosta.org</filename>, and
376 <filename>hoSTA.dOMAIna.ORG</filename> but not <filename>hostb</filename>.
383 Will match <filename>host</filename> but not <filename>hosta</filename>.
390 Will match <filename>hosta</filename> and <filename>hostb</filename>, but
391 not <filename>host</filename>.
398 Will match <filename>hoina</filename>
399 but not <filename>ho.aina.org</filename>.
406 Will match <filename>hoina</filename>
407 and <filename>ho.aina.org</filename>.
414 Will match <filename>hosta</filename>
415 but not <filename>foo.hosta.org</filename>.
422 Will match <filename>/dev/sda1</filename>
423 and <filename>/dev/sda12</filename>.
430 Will match the disk <filename>opt</filename>
431 but not the host <filename>opt</filename>.
436 <term>(note dots:) .opt.</term> <!-- nroff gets confused by dots -->
438 Will match the host <filename>opt</filename>
439 but not the disk <filename>opt</filename>.
446 Will match the disk <filename>/</filename>
454 Will match the disks <filename>/usr</filename>
455 and <filename>/usr/local</filename>.
462 Will match the disks <filename>/usr</filename>
463 but not <filename>/usr/local</filename>.
472 <refsect1><title>DATESTAMP EXPRESSION</title>
474 <emphasis remap='I'>datestamp</emphasis>
475 expression is a range expression where we only match the prefix.
476 Leading ^ is removed. Trailing $ forces an exact match.</para>
478 <variablelist remap="TP">
481 <term>20001212-14</term>
482 <listitem><para>match all dates beginning with 20001212, 20001213 or 20001214</para></listitem>
486 <term>20001212-4</term>
487 <listitem><para>same as previous</para></listitem>
491 <term>20001212-24</term>
492 <listitem><para>match all dates between 20001212 and 20001224</para></listitem>
497 <listitem><para>match all dates that start with 2000121 (20001210-20001219)</para></listitem>
502 <listitem><para>match all dates that start with 2 (20000101-29991231)</para></listitem>
507 <listitem><para>match all dates between 20000101-20101231</para></listitem>
512 <listitem><para>match only 200010</para></listitem>
519 <refsect1><title>DUMP SPECIFICATIONS</title> <para>A dump
520 specification selects one or more dumps. It has the form <emphasis
521 remap="I">[host][:disk][@datestamp]</emphasis>, where each component
522 is a pattern as described above. If a component is missing, it
523 is treated as a wildcard. The characters ':', '@', and '\' may be
524 escaped within any component by preceding them with a '\'.</para>
526 <para>Some examples:</para>
528 <variablelist remap='TP'>
530 <term>client17</term>
531 <listitem><para>all dumps of client17</para></listitem>
535 <term>@20080615</term>
536 <listitem><para>All dumps on with datestamps matching 20080615</para></listitem>
540 <term>webserver:/var/www</term>
541 <listitem><para>All dumps of /var/www on host webserver</para></listitem>
545 <term>webserver:/var/www@200806150317</term>
546 <listitem><para>The dump of webserver with datestamp 200806150317</para></listitem>
550 <term>:/var/www</term>
551 <listitem><para>All dumps of /var/www on any host</para></listitem>
558 <refsect1><title>CONFIGURATION OVERRIDE</title>
559 <para>Most commands allow the override of specific
560 configuration options on the command line, using the <arg
561 choice="plain">-o</arg> option. This option has the form <arg
562 choice="plain">-o</arg><replaceable>name</replaceable>=<replaceable>value</replaceable>.
563 An optional space is allowed after the <arg choice="plain">-o</arg>.
564 Each configuration option should be specified in a separate
565 command-line option.</para>
567 <para>For global options, <replaceable>name</replaceable> is simply the name of the option, e.g.,
571 For options in a named section of the configuration, <replaceable>name</replaceable> has the
572 form <replaceable>SECTION</replaceable>:<replaceable>section_name</replaceable>:<replaceable>name</replaceable>,
573 where <replaceable>SECTION</replaceable> is one of TAPETYPE, DUMPTYPE, HOLDINGDISK, or INTERFACE, and
574 <replaceable>section_name</replaceable> is the name of the tapetype, dumptype, holdingdisk, or interface.
577 amdump -o TAPETYPE:HP-DAT:length=2000m
578 amdump -o DUMPTYPE:no-compress:compress="server fast"
579 amdump -o HOLDINGDISK:hd1:use="-100 mb"
580 amdump -o INTERFACE:local:use="2000 kbps"
584 <para>When overriding device properties, one must carefully quote the
585 command line to simulate the syntax of real configuration files. The
586 following example should serve as a guide:
588 amdump -o 'device-property="PROPERTY_MAX_VOLUME_USAGE" "100000"'
589 </programlisting></para>
591 <para>Note that configuration overrides are not effective for tape
592 changers, which supply a tapedev based on their own configuration. In order to
593 override <emphasis remap="I">tapedev</emphasis>, you must also disable any changer:
595 amdump -otapedev=/dev/nst1 -otpchanger=''