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>
18 <refname>amanda</refname>
19 <refpurpose>Advanced Maryland Automatic Network Disk Archiver</refpurpose>
21 <!-- body begins here -->
25 <command>amadmin</command>
26 <arg choice='plain'><replaceable>config</replaceable></arg>
27 <arg choice='plain'><replaceable>command</replaceable></arg>
28 <arg choice='opt'><replaceable>options</replaceable></arg>
33 <command>amcheck</command>
34 <arg choice='opt'><replaceable>options</replaceable></arg>
35 <arg choice='plain'><replaceable>config</replaceable></arg>
40 <command>amcheckdb</command>
41 <arg choice='plain'><replaceable>config</replaceable></arg>
47 <command>amcleanup</command>
48 <arg choice='plain'><replaceable>config</replaceable></arg>
53 <command>amcrypt</command>
58 <command>amdd</command>
59 <arg choice='opt'><replaceable>options</replaceable></arg>
63 <command>amdump</command>
64 <arg choice='plain'><replaceable>config</replaceable></arg>
69 <command>amaespipe</command>
74 <command>amflush</command>
75 <arg choice='opt'>-f </arg>
76 <arg choice='plain'><replaceable>config</replaceable></arg>
81 <command>amgetconf</command>
82 <arg choice='opt'><replaceable>config</replaceable></arg>
83 <arg choice='plain'><replaceable>parameter</replaceable></arg>
88 <command>amlabel</command>
89 <arg choice='plain'><replaceable>config</replaceable></arg>
90 <arg choice='plain'><replaceable>label</replaceable></arg>
91 <arg choice='opt'><arg choice='plain'><replaceable>slot</replaceable></arg><arg choice='plain'><replaceable>slot</replaceable></arg></arg>
96 <command>ammt</command>
97 <arg choice='opt'><replaceable>options</replaceable></arg>
101 <command>amoverview</command>
102 <arg choice='plain'><replaceable>config</replaceable></arg>
103 <arg choice='opt'><replaceable>options</replaceable></arg>
108 <command>amplot</command>
109 <arg choice='opt'><replaceable>options</replaceable></arg>
110 <arg choice='plain'><replaceable>amdump-files</replaceable></arg>
115 <command>amrecover</command>
116 <arg choice='opt'><replaceable>config</replaceable></arg>
117 <arg choice='opt'><replaceable>options</replaceable></arg>
122 <command>amreport</command>
123 <arg choice='opt'><replaceable>config</replaceable></arg>
124 <arg choice='opt'><replaceable>options</replaceable></arg>
129 <command>amrestore</command>
130 <arg choice='opt'><replaceable>options</replaceable></arg>
131 <arg choice='plain'><replaceable>tapedevice</replaceable></arg>
132 <arg choice='opt'><arg choice='plain'><replaceable>hostname</replaceable></arg><arg choice='opt'><replaceable>diskname</replaceable></arg></arg>
137 <command>amfetchdump</command>
138 <arg choice='opt'><replaceable>options</replaceable></arg>
139 <arg choice='plain'><replaceable>config</replaceable></arg>
140 <arg choice='opt'><arg choice='plain'><replaceable>hostname</replaceable></arg><arg choice='opt'><arg choice='plain'><replaceable>diskname</replaceable></arg><arg choice='opt'><arg choice='plain'><replaceable>date</replaceable></arg><arg choice='opt'>level</arg></arg></arg></arg>
144 <command>amrmtape</command>
145 <arg choice='opt'><replaceable>options</replaceable></arg>
146 <arg choice='plain'><replaceable>config</replaceable></arg>
147 <arg choice='plain'><replaceable>label</replaceable></arg>
152 <command>amstatus</command>
153 <arg choice='plain'><replaceable>config</replaceable></arg>
154 <arg choice='opt'><replaceable>options</replaceable></arg>
159 <command>amtape</command>
160 <arg choice='plain'><replaceable>config</replaceable></arg>
161 <arg choice='plain'><replaceable>command</replaceable></arg>
162 <arg choice='opt'><replaceable>options</replaceable></arg>
167 <command>amtapetype</command>
168 <arg choice='opt'><replaceable>options</replaceable></arg>
172 <command>amtoc</command>
173 <arg choice='opt'><replaceable>options</replaceable></arg>
174 <arg choice='plain'><replaceable>logfile</replaceable></arg>
179 <command>amcheckdump</command>
180 <arg choice='opt'><replaceable>options</replaceable></arg>
181 <arg choice='plain'><replaceable>config</replaceable></arg>
186 <command>amserverconfig</command>
187 <arg choice='opt'><replaceable>options</replaceable></arg>
188 <arg choice='plain'><replaceable>config</replaceable></arg>
193 <command>amaddclient</command>
194 <arg choice='plain'><replaceable>config</replaceable></arg>
195 <arg choice='opt'><replaceable>options</replaceable></arg>
201 <refsect1><title>DESCRIPTION</title>
203 "Advanced Maryland Automatic Network Disk Archiver".
204 This manual page gives an overview of the &A; commands and
205 configuration files for quick reference.</para>
207 <para>Here are all the &A; commands.
208 Each one has its own manual page.
209 See them for all the gory details.</para>
210 <variablelist remap='TP'>
212 <term><emphasis remap='B'>amdump</emphasis></term>
214 <para>Take care of automatic &A; backups.
215 This is normally executed by
216 <emphasis remap='B'>cron</emphasis>
217 on a computer called the
218 <emphasis remap='I'>tape server host</emphasis>
219 and requests backups of file systems located on
220 <emphasis remap='I'>backup</emphasis>
221 <emphasis remap='I'>clients</emphasis>.
222 <emphasis remap='B'>Amdump</emphasis>
223 backs up all disks in the
224 <emphasis remap='I'>disklist</emphasis>
225 file (discussed below) to tape or, if there is a problem, to a special
226 <emphasis remap='I'>holding</emphasis>
227 <emphasis remap='I'>disk</emphasis>.
228 After all backups are done,
229 <command>amdump</command>
230 sends mail reporting failures and successes.</para>
234 <term><emphasis remap='B'>amflush</emphasis></term>
236 <para>Flush backups from the holding disk to tape.
237 <emphasis remap='B'>Amflush</emphasis>
239 <command>amdump</command>
240 has reported it could not write backups to tape for some reason.
241 When this happens, backups stay in the holding disk.
242 Run <emphasis remap='B'>amflush</emphasis> after the tape problem is corrected
243 to write backups from the holding disk to tape.</para>
247 <term><emphasis remap='B'>amcleanup</emphasis></term>
249 <para>Clean up after an interrupted
250 <command>amdump</command>.
251 This command is only needed if
252 <command>amdump</command>
253 was unable to complete for some reason, usually because the
254 tape server host crashed while
255 <command>amdump</command>
260 <term><emphasis remap='B'>amrecover</emphasis></term>
262 <para>Provides an interactive interface to browse the &A; index files
263 (backup image catalogues)
264 and select which tapes to recover files from.
266 <emphasis remap='B'>amrestore</emphasis>
267 and a restore program (e.g.
268 <emphasis remap='B'>tar</emphasis>)
269 to actually recover the files.</para>
273 <term><emphasis remap='B'>amrestore</emphasis></term>
275 <para>Read an &A; tape, searching for requested backups.
276 <emphasis remap='B'>Amrestore</emphasis>
277 is suitable for everything from interactive restores of single files
278 to a full restore of all partitions on a failed disk.</para>
282 <term><emphasis remap='B'>amfetchdump</emphasis></term>
284 <para>Performs &A; tape restoration, similar to <emphasis
285 remap='B'>amrestore</emphasis>. Additional capabilities include
286 "hands-off" searching of multiple tapes, automatic
287 retrieval of specific dump files based on dump logs, and assembly of
288 tape-spanning split dump files.</para>
292 <term><emphasis remap='B'>amlabel</emphasis></term>
294 <para>Write an &A; format label onto a tape.
295 All &A; tapes must be labeled with
296 <emphasis remap='B'>amlabel</emphasis>.
297 <emphasis remap='B'>Amdump</emphasis>
299 <emphasis remap='B'>amflush</emphasis>
300 will not write to an unlabeled tape (see TAPE MANAGEMENT below).</para>
304 <term><emphasis remap='B'>amcheck</emphasis></term>
306 <para>Verify the correct tape is mounted and all file systems on all backup client systems
307 are ready to be backed up. Often run by
308 <emphasis remap='B'>cron</emphasis>
310 <command>amdump</command>
311 to generate a mail warning that backups might fail
312 unless corrective action is taken.</para>
316 <term><emphasis remap='B'>amadmin</emphasis></term>
318 <para>Take care of administrative tasks like finding out which
319 tapes are needed to restore a filesystem,
320 forcing hosts to do full backups of selected disks
321 and looking at schedule balance information.</para>
325 <term><emphasis remap='B'>amtape</emphasis></term>
327 <para>Take care of tape changer control operations like loading particular tapes,
328 ejecting tapes and scanning the tape storage slots.</para>
332 <term><emphasis remap='B'>amcheckdump</emphasis></term>
334 <para>Check the results of an &A; dump.</para>
338 <term><emphasis remap='B'>amserverconfig</emphasis></term>
340 <para>Program to setup initial &A; configuration.</para>
344 <term><emphasis remap='B'>amaddclient</emphasis></term>
346 <para>Program to add client to an existing &A; configuration.</para>
350 <term><emphasis remap='B'>amrmtape</emphasis></term>
352 <para>Delete a tape from the &A; databases.</para>
356 <term><emphasis remap='B'>amstatus</emphasis></term>
358 <para>Report the status of a running or completed
359 <command>amdump</command>.</para>
363 <term><emphasis remap='B'>amoverview</emphasis></term>
365 <para>Display a chart of hosts and file systems backed up every run.</para>
369 <term><emphasis remap='B'>amplot</emphasis></term>
371 <para>Generate utilization plots of &A; runs for performance tuning.</para>
375 <term><emphasis remap='B'>amreport</emphasis></term>
377 <para>Generate an &A; summary E-mail report.</para>
381 <term><emphasis remap='B'>amtoc</emphasis></term>
383 <para>Generate table of content files for &A; tapes.</para>
387 <term><emphasis remap='B'>amcheckdb</emphasis></term>
389 <para>Verify every tape &A; knows about is consistent in the database.</para>
393 <term><emphasis remap='B'>amgetconf</emphasis></term>
395 <para>Look up parameters in the &A; configuration file.</para>
399 <term><emphasis remap='B'>amtapetype</emphasis></term>
401 <para>Generate a tapetype definition.</para>
405 <term><emphasis remap='B'>amaespipe</emphasis></term>
407 <para>Wrapper program from aespipe (data encryption utility)</para>
411 <term><emphasis remap='B'>amcrypt</emphasis></term>
413 <para>Reference encryption program for Amanda symmetric data encryption</para>
419 <refsect1><title>CONFIGURATION</title>
420 <para>There are three user-editable files that control the behavior of &A;.
424 <emphasis remap='B'>amanda.conf</emphasis>,
425 the main configuration file.
426 It contains parameters to customize &A; for the site.
428 <citerefentry><refentrytitle>amanda.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
429 manpage for details on &A; configuration parameters.
433 <emphasis remap='I'>disklist</emphasis>
434 file, which lists hosts and disk partitions to back up.
438 <emphasis remap='I'>tapelist</emphasis>
439 file, which lists tapes that are currently active.
440 These files are described in more detail in the following sections.</para>
442 <para>All files are stored in individual configuration
443 directories under <filename>/usr/local/etc/amanda/</filename>.
444 A site will often have more than
446 For example, it might have a
447 <emphasis remap='I'>normal</emphasis>
448 configuration for everyday backups and an
449 <emphasis remap='I'>archive</emphasis>
450 configuration for infrequent full archival backups.
451 The configuration files would be stored under directories
452 <filename>/usr/local/etc/amanda/normal/</filename> and
453 <filename>/usr/local/etc/amanda/archive/</filename>, respectively.
454 Part of the job of an &A; administrator is to create,
455 populate and maintain these directories.</para>
457 <para>All log and database files generated by &A; go in corresponding
458 directories somewhere.
459 The exact location is controlled by entries in
460 <emphasis remap='B'>amanda.conf</emphasis>.
461 A typical location would be under <filename>/var/adm/amanda</filename>.
462 For the above example, the files might go in
463 <filename>/var/adm/amanda/normal/</filename> and
464 <filename>/var/adm/amanda/archive/</filename>.
467 <para>As log files are no longer needed (no longer contain relevant information),
468 &A; cycles them out in various ways, depending on the type of file.</para>
470 <para>Detailed information about
471 <command>amdump</command>
472 runs are stored in files named
473 <emphasis remap='B'>amdump.</emphasis><emphasis remap='I'>NN</emphasis>
475 <emphasis remap='I'>NN</emphasis>
476 is a sequence number, with 1 being the most recent file.
477 <emphasis remap='B'>Amdump</emphasis>
478 rotates these files each run, keeping roughly the last
479 <emphasis remap='B'>tapecycle</emphasis>
481 worth of them.</para>
483 <para>The file used by
484 <emphasis remap='B'>amreport</emphasis>
485 to generate the mail summary is named
486 <emphasis remap='B'>log.</emphasis><emphasis remap='I'>YYYYMMDD.NN</emphasis>
488 <emphasis remap='I'>YYYYMMDD</emphasis>
489 is the datestamp of the start of the
490 <command>amdump</command>
492 <emphasis remap='I'>NN</emphasis>
493 is a sequence number started at 0.
495 <command>amdump</command>
497 log files for runs whose tapes have been reused are renamed
498 into a subdirectory of the main log directory (see the
499 <emphasis remap='B'>logdir</emphasis>
502 <emphasis remap='B'>oldlog</emphasis>.
503 It is up to the &A; administrator to remove them from this
504 directory when desired.</para>
506 <para>Index (backup image catalogue) files older than the full dump
507 matching the oldest backup image for a given client and disk
509 <command>amdump</command>
510 at the end of each run.</para>
513 <refsect1><title>DISKLIST FILE</title>
515 <emphasis remap='I'>disklist</emphasis>
516 file determines which disks will be backed up by &A;.
517 The file usually contains one line per disk:</para>
520 <emphasis>hostname diskname</emphasis> [<emphasis>diskdevice</emphasis>] <emphasis>dumptype</emphasis> [<emphasis>spindle</emphasis> [<emphasis>interface</emphasis>] ]
523 <para>All pairs [ <emphasis>hostname diskname</emphasis> ] must be unique.</para>
525 <para>Lines starting with # are ignored, as are blank lines.
526 The fields have the following meanings:</para>
527 <variablelist remap='TP'>
529 <term><emphasis remap='I'>hostname</emphasis></term>
531 <para>The name of the host to be backed up.
533 <emphasis remap='B'>diskdevice</emphasis>
534 refers to a PC share, this is the host &A; will run the Samba
535 <emphasis remap='B'>smbclient</emphasis> program on to back up the share.</para>
539 <term><emphasis remap='I'>diskname</emphasis></term>
541 <para>The name of the disk (a label).
542 In most case, you set your
543 <emphasis remap='B'>diskname</emphasis>
545 <emphasis remap='B'>diskdevice</emphasis>
546 and you don't set the
547 <emphasis remap='B'>diskdevice.</emphasis>
548 If you want multiple entries with the same
549 <emphasis remap='B'>diskdevice</emphasis>,
550 you must set a different
551 <emphasis remap='B'>diskname</emphasis>
552 for each entry. It's the
553 <emphasis remap='B'>diskname</emphasis>
554 that you use on the commandline for any &A; command.
555 Look at the example/disklist file for example.</para>
559 <term><emphasis remap='I'>diskdevice</emphasis></term>
561 <para>Default: same as diskname.
562 The name of the disk device to be backed up. It may be a full device name,
563 a device name without the
564 <filename>/dev/</filename>
566 <emphasis remap='I'>sd0a</emphasis>,
567 or a mount point such as
568 <filename>/usr</filename>.</para>
570 <para>It may also refer to a PC share by starting the name with two (forward) slashes, e.g.
571 <filename>//some-pc/home</filename>.
573 <emphasis remap='B'>program</emphasis>
574 option in the associated
575 <emphasis remap='B'>dumptype</emphasis>
577 <emphasis remap='B'>GNUTAR</emphasis>.
578 It is the combination of the double slash disk name and
579 <emphasis remap='B'>program GNUTAR</emphasis>
581 <emphasis remap='B'>dumptype</emphasis>
582 that triggers the use of Samba.</para>
587 <term><emphasis remap='I'>dumptype</emphasis></term>
590 <emphasis remap='B'>dumptype</emphasis>
592 <emphasis remap='B'>amanda.conf</emphasis>
594 <emphasis remap='I'>Dumptype</emphasis>s
595 specify backup related parameters,
596 such as whether to compress the backups,
597 whether to record backup results in
598 <filename>/etc/dumpdates</filename>, the disk's relative priority, etc.</para>
602 <term><emphasis remap='I'>spindle</emphasis></term>
606 A number used to balance backup load on a host.
607 &A; will not run multiple backups at the same time
608 on the same spindle, unless the spindle number is -1,
609 which means there is no spindle restriction.</para>
613 <term><emphasis remap='I'>interface</emphasis></term>
616 <emphasis remap='I'>local</emphasis>.
617 The name of a network interface definition in the
618 <emphasis remap='B'>amanda.conf</emphasis>
619 file, used to balance network load.</para>
624 <para>Instead of naming a
625 <emphasis remap='B'>dumptype</emphasis>,
626 it is possible to define one in-line, enclosing
627 <emphasis remap='B'>dumptype</emphasis>
628 options within curly braces, one per line, just like a
629 <emphasis remap='B'>dumptype</emphasis>
631 <emphasis remap='B'>amanda.conf</emphasis>.
633 <emphasis remap='B'>dumptype</emphasis>s
634 are valid option names, this syntax may be used to customize
635 <emphasis remap='B'>dumptype</emphasis>s
636 for particular disks.</para>
639 <emphasis remap='B'>must</emphasis>
640 follow the left curly bracket.</para>
642 <para>For instance, if a
643 <emphasis remap='B'>dumptype</emphasis>
645 <emphasis remap='I'>normal</emphasis>
646 is used for most disks, but use of the holding disk needs to be disabled
647 for the file system that holds it, this would work instead of defining
648 a new dumptype:</para>
651 <emphasis remap='I'>hostname diskname</emphasis> [ <emphasis remap='I'>diskdevice</emphasis> ] {
654 } [ <emphasis remap='I'>spindle</emphasis> [ <emphasis remap='I'>interface</emphasis> ] ]
659 <refsect1><title>TAPE MANAGEMENT</title>
661 <emphasis remap='I'>tapelist</emphasis>
662 file contains the list of tapes in active use.
663 This file is maintained entirely by &A; and should not be created
664 or edited during normal operation.
665 It contains lines of the form:</para>
667 <para><programlisting>YYYYMMDD label flags
668 </programlisting></para>
671 <emphasis remap='I'>YYYYMMDD</emphasis>
672 is the date the tape was written,
673 <emphasis remap='I'>label</emphasis>
674 is a label for the tape as written by
675 <emphasis remap='B'>amlabel</emphasis>
677 <emphasis remap='I'>flags</emphasis>
678 tell &A; whether the tape may be reused, etc (see the
679 <emphasis remap='B'>reuse</emphasis>
681 <emphasis remap='B'>amadmin</emphasis>).</para>
683 <para><emphasis remap='B'>Amdump</emphasis>
685 <emphasis remap='B'>amflush</emphasis>
686 will refuse to write to an unlabeled tape, or to a labeled tape that is considered active.
687 There must be more tapes in active rotation (see the
688 <emphasis remap='B'>tapecycle</emphasis>
689 option) than there are runs in the backup cycle (see the
690 <emphasis remap='B'>dumpcycle</emphasis>
691 option) to prevent overwriting a backup image that would be needed to do a full recovery.</para>
694 <refsect1 id='output_drivers'><title>OUTPUT DRIVERS</title>
695 <para>The normal value for the
696 <emphasis remap='B'>tapedev</emphasis>
697 parameter, or for what a tape changer returns,
698 is a full path name to a non-rewinding tape device, such as
699 <filename>/dev/nst0</filename>
701 <filename>/dev/rmt/0mn</filename>
703 <filename>/dev/nst0.1</filename>
704 or whatever conventions the operating system uses. &A; provides additional application level drivers that
705 support non-traditional tape-simulations or features. To access a specific output driver, set
706 <emphasis remap='B'>tapedev</emphasis>
707 (or configure your changer to return) a string of the form
708 <emphasis remap='I'>driver</emphasis>:<emphasis remap='I'>driver-info</emphasis>
710 <emphasis remap='I'>driver</emphasis>
711 is one of the supported drivers and
712 <emphasis remap='I'>driver-info</emphasis>
713 is optional additional information needed by the driver.</para>
715 <para>The supported drivers are:</para>
716 <variablelist remap='TP'>
718 <term><emphasis remap='I'>tape</emphasis></term>
720 <para>This is the default driver.
722 <emphasis remap='I'>driver-info</emphasis>
723 is the tape device name.
725 <programlisting>tapedev /dev/rmt/0mn
727 is really a short hand for
728 <programlisting>tapedev tape:/dev/rmt/0mn
729 </programlisting></para>
733 <term><emphasis remap='I'>null</emphasis></term>
735 <para>This driver throws away anything written to it and returns EOF
736 for any reads except a special case is made for reading a label,
737 in which case a "fake" value is returned that &A; checks for
738 and allows through regardless of what you have set in
739 <emphasis remap='B'>labelstr</emphasis>.
741 <emphasis remap='I'>driver-info</emphasis>
742 field is not used and may be left blank:</para>
744 <para><programlisting>tapedev null:
745 </programlisting></para>
747 <para>The <emphasis remap='I'>length</emphasis>
748 value from the associated
749 <emphasis remap='B'>tapetype</emphasis>
750 is used to limit the amount of data written. When the limit is reached, the driver will simulate end of tape.</para>
752 <note><para>This driver should only be used for debugging and testing,
753 and probably only with the
754 <emphasis remap='B'>record</emphasis>
756 <emphasis remap='I'>no</emphasis>.
763 <term><emphasis remap='I'>rait</emphasis></term>
765 <para><emphasis remap='I'>R</emphasis>edundant
766 <emphasis remap='I'>A</emphasis>rray
768 <emphasis remap='I'>I</emphasis>nexpensive (?)
769 <emphasis remap='I'>T</emphasis>apes.
770 Reads and writes tapes mounted on multiple drives by spreading
771 the data across N-1 drives and using the last drive for a checksum.
772 See docs/RAIT for more information.</para>
775 <emphasis remap='I'>driver-info</emphasis>
776 field describes the devices to use. Curly braces indicate multiple replacements in the string.
779 <para><programlisting>tapedev rait:/dev/rmt/tps0d{4,5,6}n
780 </programlisting></para>
782 <para>would use the following devices:</para>
784 <para><filename>/dev/rmt/tps0d4n</filename>
785 <filename>/dev/rmt/tps0d5n</filename>
786 <filename>/dev/rmt/tps0d6n</filename>
791 <variablelist remap='TP'>
793 <term><emphasis remap='I'>file</emphasis></term>
795 <para>This driver emulates a tape device with a set of files in a directory.
797 <emphasis remap='I'>driver-info</emphasis>
798 field must be the name of an existing directory.
799 The driver will test for a subdirectory of that named
800 <emphasis remap='I'>data</emphasis>
802 <emphasis remap='B'>offline</emphasis>
804 When present, the driver uses two files in the
805 <emphasis remap='I'>data</emphasis>
806 subdirectory for each tape file. One contains the actual data.
807 The other contains record length information.</para>
809 <para>The driver uses a file named
810 <emphasis remap='I'>status</emphasis>
812 <emphasis remap='B'>file</emphasis>
813 device directory to hold driver status information, such as tape position.
814 If not present, the driver will create it as though the device is rewound.</para>
817 <emphasis remap='I'>length</emphasis>
818 value from the associated
819 <emphasis remap='B'>tapetype</emphasis>
820 is used to limit the amount of data written.
821 When the limit is reached, the driver will simulate end of tape.</para>
823 <para>One way to use this driver with a real device such as a CD-writer is to
824 create a directory for the
825 <emphasis remap='B'>file</emphasis>
826 device and one or more other directories for the actual data.
827 Create a symlink named
828 <emphasis remap='I'>data</emphasis>
830 <emphasis remap='B'>file</emphasis>
831 directory to one of the data directories.
833 <emphasis remap='B'>tapetype</emphasis>
834 length to whatever the medium will hold.</para>
836 <para>When &A; fills the
837 <emphasis remap='B'>file</emphasis>
838 device, remove the symlink and (optionally) create a new symlink to another
840 Use a CD writer software package to burn the image from the first data area.</para>
842 <para>To read the CD, mount it and create the
843 <emphasis remap='I'>data</emphasis>
845 <emphasis remap='B'>file</emphasis>
846 device directory.</para>
852 <refsect1><title>AUTHORIZATION</title>
853 <para>&A; processes on the tape server host run as the
854 <emphasis remap='B'>dumpuser</emphasis>
856 <emphasis remap='B'>amanda.conf</emphasis>.
857 When they connect to a backup client, they do so with an &A;-specific protocol.
858 They do not, for instance, use
859 <emphasis remap='B'>rsh</emphasis>
861 <emphasis remap='B'>ssh</emphasis>
864 <para>On the client side, the
865 <emphasis remap='B'>amandad</emphasis>
866 daemon validates the connection using one of several methods,
867 depending on how it was compiled and on options it is passed:</para>
869 <variablelist remap='IP'>
873 <para>Even though &A; does not use
874 <emphasis remap='B'>rsh</emphasis>,
876 <markup>.rhosts</markup>-style
878 <markup>.rhosts</markup>
883 <term>.amandahosts</term>
885 <para>This is essentially the same as
886 <markup>.rhosts</markup>
887 authentication except a different file, with almost the same format, is used.
888 This is the default mechanism built into &A;.</para>
890 <para>The format of the
891 <filename>.amandahosts</filename>
894 <para><emphasis remap='I'>hostname</emphasis>
896 <emphasis remap='I'>username</emphasis>
898 <emphasis remap='I'>service</emphasis>
902 <emphasis remap='I'>username</emphasis>
903 is ommitted, it defaults to the user running
904 <emphasis remap='B'>amandad</emphasis>,
905 i.e. the user listed in the
906 <emphasis remap='B'>inetd</emphasis>
908 <emphasis remap='B'>xinetd</emphasis>
909 configuration file.</para>
910 <para>The <emphasis remap='I'>service</emphasis> is a list of the service the client is authorized to execute:
911 <emphasis remap='B'>amdump</emphasis>,
912 <emphasis remap='B'>noop</emphasis>,
913 <emphasis remap='B'>selfcheck</emphasis>,
914 <emphasis remap='B'>sendsize</emphasis>,
915 <emphasis remap='B'>sendbackup</emphasis>,
916 <emphasis remap='B'>amindexd</emphasis>,
917 <emphasis remap='B'>amidxtaped</emphasis>.
918 <emphasis remap='B'>amdump</emphasis> is a shortcut for "noop selfcheck sendsize sendbackup"</para>
922 <term>Kerberos</term>
924 <para>&A; may use the Kerberos authentication system.
925 Further information is in the
926 <emphasis remap='B'>docs/KERBEROS</emphasis>
927 <!-- TODO: edit link -->
928 file that comes with an &A; distribution.</para>
930 <para>For Samba access,
931 &A; needs a file on the Samba server (which may
932 or may not also be the tape server) named
933 <filename>/etc/amandapass</filename>
934 with share names, (clear text) passwords and (optional) domain names,
935 in that order, one per line, whitespace separated.
936 By default, the user used to connect to the PC is the same for all
937 PC's and is compiled into &A;.
938 It may be changed on a host by host basis
939 by listing it first in the password field followed
940 by a percent sign and then the password.
943 //some-pc/home normalpw
944 //another-pc/disk otheruser%otherpw
946 <para>With clear text passwords, this file should obviously be tightly protected.
947 It only needs to be readable by the &A;-user on the Samba server. </para>
948 <para>You can find further information in the
949 <emphasis remap='B'>docs/SAMBA</emphasis>
950 <!-- TODO: edit link -->
951 file that comes with an &A; distribution.</para>
958 <refsect1><title>HOST & DISK EXPRESSION</title>
959 <para>All host and disk arguments to programs are special expressions.
960 The command applies to all disks that match your arguments.
961 This section describes the matcher.</para>
963 <para>The matcher matches by word, each word is a glob expression, words
964 are separated by the separator '.' for host and '/' for disk. You
965 can anchor the expression at left with a '^'. You can
966 anchor the expression at right with a '$'. The matcher
967 is case insensitive for host but is case sensitive for disk. A match
968 succeeds if all words in your expression match contiguous words in
969 the host or disk.</para>
972 <informaltable frame="none">
973 <tgroup cols="2" align="left">
978 <entry>word separator for a host</entry>
983 <entry>word separator for a disk</entry>
988 <entry>anchor at left</entry>
993 <entry>anchor at right</entry>
998 <entry>match exactly one character except the separator</entry>
1003 <entry>match zero or more characters except the separator</entry>
1008 <entry>match zero or more characters including the separator</entry>
1015 <para>Some examples:</para>
1017 <informaltable frame="none">
1018 <tgroup cols="3" align="left">
1022 <entry>EXPRESSION </entry>
1023 <entry>WILL MATCH</entry>
1024 <entry>WILL NOT MATCH</entry>
1028 <entry>hosta</entry>
1029 <entry>hosta</entry>
1030 <entry>hostb</entry>
1035 <entry>hoSTA.dOMAIna.ORG</entry>
1041 <entry>foo.hosta.org</entry>
1048 <entry>hosta</entry>
1052 <entry>host?</entry>
1053 <entry>hosta</entry>
1059 <entry>hostb</entry>
1064 <entry>ho*na</entry>
1065 <entry>hoina</entry>
1066 <entry>ho.aina.org</entry>
1070 <entry>ho**na</entry>
1071 <entry>hoina</entry>
1077 <entry>ho.aina.org</entry>
1082 <entry>^hosta</entry>
1083 <entry>hosta</entry>
1084 <entry>foo.hosta.org</entry>
1089 <entry>/dev/sda1</entry>
1095 <entry>/dev/sda12</entry>
1101 <entry>opt (disk)</entry>
1102 <entry>opt (host)</entry>
1106 <entry>.opt.</entry>
1107 <entry>opt (host)</entry>
1108 <entry>opt (disk)</entry>
1114 <entry>any other disk</entry>
1125 <entry>/usr/opt</entry>
1130 <entry>/usr$</entry>
1132 <entry>/usr/opt</entry>
1142 <refsect1><title>DATESTAMP EXPRESSION</title>
1144 <emphasis remap='I'>datestamp</emphasis>
1145 expression is a range expression where we only match the prefix.
1146 Leading ^ is removed. Trailing $ forces an exact match.</para>
1148 <informaltable frame="all">
1149 <tgroup cols="2" align="left">
1153 <entry>20001212-14</entry>
1154 <entry>match all dates beginning with 20001212, 20001213 or 20001214</entry>
1158 <entry>20001212-4</entry>
1159 <entry>same as previous</entry>
1163 <entry>20001212-24</entry>
1164 <entry>match all dates between 20001212 and 20001224</entry>
1168 <entry>2000121</entry>
1169 <entry>match all dates that start with 2000121 (20001210-20001219)</entry>
1174 <entry>match all dates that start with 2 (20000101-29991231)</entry>
1178 <entry>2000-10</entry>
1179 <entry>match all dates between 20000101-20101231</entry>
1183 <entry>200010$</entry>
1184 <entry>match only 200010</entry>
1194 <refsect1><title>DUMP SPECIFICATIONS</title> <para>A dump
1195 specification selects one or more dumps. It has the form <emphasis
1196 remap="I">[host][:disk][@datestamp]</emphasis>, where each component
1197 is a pattern as described above. If a component is missing, it
1198 is treated as a wildcard. The characters ':', '@', and '\' may be
1199 escaped within any component by preceding them with a '\'.</para>
1201 <para>Some examples:</para>
1203 <informaltable frame="none">
1204 <tgroup cols="2" align="left">
1208 <entry>DUMPSPEC</entry>
1209 <entry>DESCRIPTION</entry>
1213 <entry>client17</entry>
1214 <entry>all dumps of client17</entry>
1218 <entry>@20080615</entry>
1219 <entry>All dumps on with datestamps matching 20080615</entry>
1223 <entry>webserver:/var/www</entry>
1224 <entry>All dumps of /var/www on host webserver</entry>
1228 <entry>webserver:/var/www@200806150317</entry>
1229 <entry>The dump of webserver with datestamp 200806150317</entry>
1233 <entry>:/var/www</entry>
1234 <entry>All dumps of /var/www on any host</entry>
1244 <refsect1><title>CONFIGURATION OVERRIDE</title>
1245 <para>Most commands allow the override of specific
1246 configuration options on the command line, using the <arg
1247 choice="plain">-o</arg> option. This option has the form <arg
1248 choice="plain">-o</arg><replaceable>name</replaceable>=<replaceable>value</replaceable>.
1249 An optional space is allowed after the <arg choice="plain">-o</arg>.
1250 Each configuration option should be specified in a separate
1251 command-line option.</para>
1253 <para>For global options, <replaceable>name</replaceable> is simply the name of the option, e.g.,
1257 For options in a named section of the configuration, <replaceable>name</replaceable> has the
1258 form <replaceable>SECTION</replaceable>:<replaceable>section_name</replaceable>:<replaceable>name</replaceable>,
1259 where <replaceable>SECTION</replaceable> is one of TAPETYPE, DUMPTYPE, HOLDINGDISK, or INTERFACE, and
1260 <replaceable>section_name</replaceable> is the name of the tapetype, dumptype, holdingdisk, or interface.
1263 amdump -o TAPETYPE:HP-DAT:length=2000m
1264 amdump -o DUMPTYPE:no-compress:compress="server fast"
1265 amdump -o HOLDINGDISK:hd1:use="-100 mb"
1266 amdump -o INTERFACE:local:use="2000 kbps"
1270 <para>Note that configuration overrides are not effective for tape
1271 changers, which supply a tapedev based on their own configuration. In order to
1272 override <emphasis remap="I">tapedev</emphasis>, you must also disable any changer:
1274 amdump -otapedev=/dev/nst1 -otpchanger=''
1280 <refsect1><title>AUTHOR</title>
1281 <para>James da Silva, &email.jds; : Original text</para>
1282 <para>&maintainer.sgw;: XML-conversion, major update</para>
1285 <refsect1><title>SEE ALSO</title>
1287 <citerefentry><refentrytitle>amadmin</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1288 <citerefentry><refentrytitle>amanda.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1289 <citerefentry><refentrytitle>amanda-client.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1290 <citerefentry><refentrytitle>amcheck</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1291 <citerefentry><refentrytitle>amcheckdb</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1292 <citerefentry><refentrytitle>amcleanup</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1293 <citerefentry><refentrytitle>amdd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1294 <citerefentry><refentrytitle>amdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1295 <citerefentry><refentrytitle>amfetchdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>
1296 <citerefentry><refentrytitle>amflush</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1297 <citerefentry><refentrytitle>amgetconf</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1298 <citerefentry><refentrytitle>amlabel</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1299 <citerefentry><refentrytitle>ammt</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1300 <citerefentry><refentrytitle>amoverview</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1301 <citerefentry><refentrytitle>amplot</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1302 <citerefentry><refentrytitle>amrecover</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1303 <citerefentry><refentrytitle>amreport</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1304 <citerefentry><refentrytitle>amrestore</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1305 <citerefentry><refentrytitle>amrmtape</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1306 <citerefentry><refentrytitle>amstatus</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1307 <citerefentry><refentrytitle>amtape</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1308 <citerefentry><refentrytitle>amtapetype</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1309 <citerefentry><refentrytitle>amtoc</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1310 <citerefentry><refentrytitle>amcheckdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1311 <citerefentry><refentrytitle>amserverconfig</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1312 <citerefentry><refentrytitle>amaddclient</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1313 <ulink url="http://wiki.zmanda.com"/>