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>amverify</command>
180 <arg choice='plain'><replaceable>config</replaceable></arg>
185 <command>amverifyrun</command>
186 <arg choice='plain'><replaceable>config</replaceable></arg>
192 <refsect1><title>DESCRIPTION</title>
194 "Advanced Maryland Automatic Network Disk Archiver".
195 This manual page gives an overview of the &A; commands and
196 configuration files for quick reference.</para>
198 <para>Here are all the &A; commands.
199 Each one has its own manual page.
200 See them for all the gory details.</para>
201 <variablelist remap='TP'>
203 <term><emphasis remap='B'>amdump</emphasis></term>
205 <para>Take care of automatic &A; backups.
206 This is normally executed by
207 <emphasis remap='B'>cron</emphasis>
208 on a computer called the
209 <emphasis remap='I'>tape server host</emphasis>
210 and requests backups of file systems located on
211 <emphasis remap='I'>backup</emphasis>
212 <emphasis remap='I'>clients</emphasis>.
213 <emphasis remap='B'>Amdump</emphasis>
214 backs up all disks in the
215 <emphasis remap='I'>disklist</emphasis>
216 file (discussed below) to tape or, if there is a problem, to a special
217 <emphasis remap='I'>holding</emphasis>
218 <emphasis remap='I'>disk</emphasis>.
219 After all backups are done,
220 <command>amdump</command>
221 sends mail reporting failures and successes.</para>
225 <term><emphasis remap='B'>amflush</emphasis></term>
227 <para>Flush backups from the holding disk to tape.
228 <emphasis remap='B'>Amflush</emphasis>
230 <command>amdump</command>
231 has reported it could not write backups to tape for some reason.
232 When this happens, backups stay in the holding disk.
233 Run <emphasis remap='B'>amflush</emphasis> after the tape problem is corrected
234 to write backups from the holding disk to tape.</para>
238 <term><emphasis remap='B'>amcleanup</emphasis></term>
240 <para>Clean up after an interrupted
241 <command>amdump</command>.
242 This command is only needed if
243 <command>amdump</command>
244 was unable to complete for some reason, usually because the
245 tape server host crashed while
246 <command>amdump</command>
251 <term><emphasis remap='B'>amrecover</emphasis></term>
253 <para>Provides an interactive interface to browse the &A; index files
254 (backup image catalogues)
255 and select which tapes to recover files from.
257 <emphasis remap='B'>amrestore</emphasis>
258 and a restore program (e.g.
259 <emphasis remap='B'>tar</emphasis>)
260 to actually recover the files.</para>
264 <term><emphasis remap='B'>amrestore</emphasis></term>
266 <para>Read an &A; tape, searching for requested backups.
267 <emphasis remap='B'>Amrestore</emphasis>
268 is suitable for everything from interactive restores of single files
269 to a full restore of all partitions on a failed disk.</para>
273 <term><emphasis remap='B'>amfetchdump</emphasis></term>
275 <para>Performs &A; tape restoration, similar to <emphasis
276 remap='B'>amrestore</emphasis>. Additional capabilities include
277 "hands-off" searching of multiple tapes, automatic
278 retrieval of specific dump files based on dump logs, and assembly of
279 tape-spanning split dump files.</para>
283 <term><emphasis remap='B'>amlabel</emphasis></term>
285 <para>Write an &A; format label onto a tape.
286 All &A; tapes must be labeled with
287 <emphasis remap='B'>amlabel</emphasis>.
288 <emphasis remap='B'>Amdump</emphasis>
290 <emphasis remap='B'>amflush</emphasis>
291 will not write to an unlabeled tape (see TAPE MANAGEMENT below).</para>
295 <term><emphasis remap='B'>amcheck</emphasis></term>
297 <para>Verify the correct tape is mounted and all file systems on all backup client systems
298 are ready to be backed up. Often run by
299 <emphasis remap='B'>cron</emphasis>
301 <command>amdump</command>
302 to generate a mail warning that backups might fail
303 unless corrective action is taken.</para>
307 <term><emphasis remap='B'>amadmin</emphasis></term>
309 <para>Take care of administrative tasks like finding out which
310 tapes are needed to restore a filesystem,
311 forcing hosts to do full backups of selected disks
312 and looking at schedule balance information.</para>
316 <term><emphasis remap='B'>amtape</emphasis></term>
318 <para>Take care of tape changer control operations like loading particular tapes,
319 ejecting tapes and scanning the tape storage slots.</para>
323 <term><emphasis remap='B'>amverify</emphasis></term>
325 <para>Check &A; backup tapes for errors.</para>
329 <term><emphasis remap='B'>amrmtape</emphasis></term>
331 <para>Delete a tape from the &A; databases.</para>
335 <term><emphasis remap='B'>amstatus</emphasis></term>
337 <para>Report the status of a running or completed
338 <command>amdump</command>.</para>
342 <term><emphasis remap='B'>amoverview</emphasis></term>
344 <para>Display a chart of hosts and file systems backed up every run.</para>
348 <term><emphasis remap='B'>amplot</emphasis></term>
350 <para>Generate utilization plots of &A; runs for performance tuning.</para>
354 <term><emphasis remap='B'>amreport</emphasis></term>
356 <para>Generate an &A; summary E-mail report.</para>
360 <term><emphasis remap='B'>amtoc</emphasis></term>
362 <para>Generate table of content files for &A; tapes.</para>
366 <term><emphasis remap='B'>amcheckdb</emphasis></term>
368 <para>Verify every tape &A; knows about is consistent in the database.</para>
372 <term><emphasis remap='B'>amgetconf</emphasis></term>
374 <para>Look up parameters in the &A; configuration file.</para>
378 <term><emphasis remap='B'>amtapetype</emphasis></term>
380 <para>Generate a tapetype definition.</para>
384 <term><emphasis remap='B'>amaespipe</emphasis></term>
386 <para>Wrapper program from aespipe (data encryption utility)</para>
390 <term><emphasis remap='B'>amcrypt</emphasis></term>
392 <para>Reference encryption program for Amanda symmetric data encryption</para>
398 <refsect1><title>CONFIGURATION</title>
399 <para>There are three user-editable files that control the behavior of &A;.
403 <emphasis remap='B'>amanda.conf</emphasis>,
404 the main configuration file.
405 It contains parameters to customize &A; for the site.
407 <citerefentry><refentrytitle>amanda.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
408 manpage for details on &A; configuration parameters.
412 <emphasis remap='I'>disklist</emphasis>
413 file, which lists hosts and disk partitions to back up.
417 <emphasis remap='I'>tapelist</emphasis>
418 file, which lists tapes that are currently active.
419 These files are described in more detail in the following sections.</para>
421 <para>All files are stored in individual configuration
422 directories under <filename>/usr/local/etc/amanda/</filename>.
423 A site will often have more than
425 For example, it might have a
426 <emphasis remap='I'>normal</emphasis>
427 configuration for everyday backups and an
428 <emphasis remap='I'>archive</emphasis>
429 configuration for infrequent full archival backups.
430 The configuration files would be stored under directories
431 <filename>/usr/local/etc/amanda/normal/</filename> and
432 <filename>/usr/local/etc/amanda/archive/</filename>, respectively.
433 Part of the job of an &A; administrator is to create,
434 populate and maintain these directories.</para>
436 <para>All log and database files generated by &A; go in corresponding
437 directories somewhere.
438 The exact location is controlled by entries in
439 <emphasis remap='B'>amanda.conf</emphasis>.
440 A typical location would be under <filename>/var/adm/amanda</filename>.
441 For the above example, the files might go in
442 <filename>/var/adm/amanda/normal/</filename> and
443 <filename>/var/adm/amanda/archive/</filename>.
446 <para>As log files are no longer needed (no longer contain relevant information),
447 &A; cycles them out in various ways, depending on the type of file.</para>
449 <para>Detailed information about
450 <command>amdump</command>
451 runs are stored in files named
452 <emphasis remap='B'>amdump.</emphasis><emphasis remap='I'>NN</emphasis>
454 <emphasis remap='I'>NN</emphasis>
455 is a sequence number, with 1 being the most recent file.
456 <emphasis remap='B'>Amdump</emphasis>
457 rotates these files each run, keeping roughly the last
458 <emphasis remap='B'>tapecycle</emphasis>
460 worth of them.</para>
462 <para>The file used by
463 <emphasis remap='B'>amreport</emphasis>
464 to generate the mail summary is named
465 <emphasis remap='B'>log.</emphasis><emphasis remap='I'>YYYYMMDD.NN</emphasis>
467 <emphasis remap='I'>YYYYMMDD</emphasis>
468 is the datestamp of the start of the
469 <command>amdump</command>
471 <emphasis remap='I'>NN</emphasis>
472 is a sequence number started at 0.
474 <command>amdump</command>
476 log files for runs whose tapes have been reused are renamed
477 into a subdirectory of the main log directory (see the
478 <emphasis remap='B'>logdir</emphasis>
481 <emphasis remap='B'>oldlog</emphasis>.
482 It is up to the &A; administrator to remove them from this
483 directory when desired.</para>
485 <para>Index (backup image catalogue) files older than the full dump
486 matching the oldest backup image for a given client and disk
488 <command>amdump</command>
489 at the end of each run.</para>
492 <refsect1><title>DISKLIST FILE</title>
494 <emphasis remap='I'>disklist</emphasis>
495 file determines which disks will be backed up by &A;.
496 The file usually contains one line per disk:</para>
499 <emphasis>hostname diskname</emphasis> [<emphasis>diskdevice</emphasis>] <emphasis>dumptype</emphasis> [<emphasis>spindle</emphasis> [<emphasis>interface</emphasis>] ]
502 <para>All pairs [ <emphasis>hostname diskname</emphasis> ] must be unique.</para>
504 <para>Lines starting with # are ignored, as are blank lines.
505 The fields have the following meanings:</para>
506 <variablelist remap='TP'>
508 <term><emphasis remap='I'>hostname</emphasis></term>
510 <para>The name of the host to be backed up.
512 <emphasis remap='B'>diskdevice</emphasis>
513 refers to a PC share, this is the host &A; will run the Samba
514 <emphasis remap='B'>smbclient</emphasis> program on to back up the share.</para>
518 <term><emphasis remap='I'>diskname</emphasis></term>
520 <para>The name of the disk (a label).
521 In most case, you set your
522 <emphasis remap='B'>diskname</emphasis>
524 <emphasis remap='B'>diskdevice</emphasis>
525 and you don't set the
526 <emphasis remap='B'>diskdevice.</emphasis>
527 If you want multiple entries with the same
528 <emphasis remap='B'>diskdevice</emphasis>,
529 you must set a different
530 <emphasis remap='B'>diskname</emphasis>
531 for each entry. It's the
532 <emphasis remap='B'>diskname</emphasis>
533 that you use on the commandline for any &A; command.
534 Look at the example/disklist file for example.</para>
538 <term><emphasis remap='I'>diskdevice</emphasis></term>
540 <para>Default: same as diskname.
541 The name of the disk device to be backed up. It may be a full device name,
542 a device name without the
543 <filename>/dev/</filename>
545 <emphasis remap='I'>sd0a</emphasis>,
546 or a mount point such as
547 <filename>/usr</filename>.</para>
549 <para>It may also refer to a PC share by starting the name with two (forward) slashes, e.g.
550 <filename>//some-pc/home</filename>.
552 <emphasis remap='B'>program</emphasis>
553 option in the associated
554 <emphasis remap='B'>dumptype</emphasis>
556 <emphasis remap='B'>GNUTAR</emphasis>.
557 It is the combination of the double slash disk name and
558 <emphasis remap='B'>program GNUTAR</emphasis>
560 <emphasis remap='B'>dumptype</emphasis>
561 that triggers the use of Samba.</para>
566 <term><emphasis remap='I'>dumptype</emphasis></term>
569 <emphasis remap='B'>dumptype</emphasis>
571 <emphasis remap='B'>amanda.conf</emphasis>
573 <emphasis remap='I'>Dumptype</emphasis>s
574 specify backup related parameters,
575 such as whether to compress the backups,
576 whether to record backup results in
577 <filename>/etc/dumpdates</filename>, the disk's relative priority, etc.</para>
581 <term><emphasis remap='I'>spindle</emphasis></term>
585 A number used to balance backup load on a host.
586 &A; will not run multiple backups at the same time
587 on the same spindle, unless the spindle number is -1,
588 which means there is no spindle restriction.</para>
592 <term><emphasis remap='I'>interface</emphasis></term>
595 <emphasis remap='I'>local</emphasis>.
596 The name of a network interface definition in the
597 <emphasis remap='B'>amanda.conf</emphasis>
598 file, used to balance network load.</para>
603 <para>Instead of naming a
604 <emphasis remap='B'>dumptype</emphasis>,
605 it is possible to define one in-line, enclosing
606 <emphasis remap='B'>dumptype</emphasis>
607 options within curly braces, one per line, just like a
608 <emphasis remap='B'>dumptype</emphasis>
610 <emphasis remap='B'>amanda.conf</emphasis>.
612 <emphasis remap='B'>dumptype</emphasis>s
613 are valid option names, this syntax may be used to customize
614 <emphasis remap='B'>dumptype</emphasis>s
615 for particular disks.</para>
618 <emphasis remap='B'>must</emphasis>
619 follow the left curly bracket.</para>
621 <para>For instance, if a
622 <emphasis remap='B'>dumptype</emphasis>
624 <emphasis remap='I'>normal</emphasis>
625 is used for most disks, but use of the holding disk needs to be disabled
626 for the file system that holds it, this would work instead of defining
627 a new dumptype:</para>
630 <emphasis remap='I'>hostname diskname</emphasis> [ <emphasis remap='I'>diskdevice</emphasis> ] {
633 } [ <emphasis remap='I'>spindle</emphasis> [ <emphasis remap='I'>interface</emphasis> ] ]
638 <refsect1><title>TAPE MANAGEMENT</title>
640 <emphasis remap='I'>tapelist</emphasis>
641 file contains the list of tapes in active use.
642 This file is maintained entirely by &A; and should not be created
643 or edited during normal operation.
644 It contains lines of the form:</para>
646 <para><programlisting>YYYYMMDD label flags
647 </programlisting></para>
650 <emphasis remap='I'>YYYYMMDD</emphasis>
651 is the date the tape was written,
652 <emphasis remap='I'>label</emphasis>
653 is a label for the tape as written by
654 <emphasis remap='B'>amlabel</emphasis>
656 <emphasis remap='I'>flags</emphasis>
657 tell &A; whether the tape may be reused, etc (see the
658 <emphasis remap='B'>reuse</emphasis>
660 <emphasis remap='B'>amadmin</emphasis>).</para>
662 <para><emphasis remap='B'>Amdump</emphasis>
664 <emphasis remap='B'>amflush</emphasis>
665 will refuse to write to an unlabeled tape, or to a labeled tape that is considered active.
666 There must be more tapes in active rotation (see the
667 <emphasis remap='B'>tapecycle</emphasis>
668 option) than there are runs in the backup cycle (see the
669 <emphasis remap='B'>dumpcycle</emphasis>
670 option) to prevent overwriting a backup image that would be needed to do a full recovery.</para>
673 <refsect1 id='output_drivers'><title>OUTPUT DRIVERS</title>
674 <para>The normal value for the
675 <emphasis remap='B'>tapedev</emphasis>
676 parameter, or for what a tape changer returns,
677 is a full path name to a non-rewinding tape device, such as
678 <filename>/dev/nst0</filename>
680 <filename>/dev/rmt/0mn</filename>
682 <filename>/dev/nst0.1</filename>
683 or whatever conventions the operating system uses. &A; provides additional application level drivers that
684 support non-traditional tape-simulations or features. To access a specific output driver, set
685 <emphasis remap='B'>tapedev</emphasis>
686 (or configure your changer to return) a string of the form
687 <emphasis remap='I'>driver</emphasis>:<emphasis remap='I'>driver-info</emphasis>
689 <emphasis remap='I'>driver</emphasis>
690 is one of the supported drivers and
691 <emphasis remap='I'>driver-info</emphasis>
692 is optional additional information needed by the driver.</para>
694 <para>The supported drivers are:</para>
695 <variablelist remap='TP'>
697 <term><emphasis remap='I'>tape</emphasis></term>
699 <para>This is the default driver.
701 <emphasis remap='I'>driver-info</emphasis>
702 is the tape device name.
704 <programlisting>tapedev /dev/rmt/0mn
706 is really a short hand for
707 <programlisting>tapedev tape:/dev/rmt/0mn
708 </programlisting>.</para>
712 <term><emphasis remap='I'>null</emphasis></term>
714 <para>This driver throws away anything written to it and returns EOF
715 for any reads except a special case is made for reading a label,
716 in which case a "fake" value is returned that &A; checks for
717 and allows through regardless of what you have set in
718 <emphasis remap='B'>labelstr</emphasis>.
720 <emphasis remap='I'>driver-info</emphasis>
721 field is not used and may be left blank:</para>
723 <para><programlisting>tapedev null:
724 </programlisting></para>
726 <para>The <emphasis remap='I'>length</emphasis>
727 value from the associated
728 <emphasis remap='B'>tapetype</emphasis>
729 is used to limit the amount of data written. When the limit is reached, the driver will simulate end of tape.</para>
731 <note>This driver should only be used for debugging and testing,
732 and probably only with the
733 <emphasis remap='B'>record</emphasis>
735 <emphasis remap='I'>no</emphasis>.</note>
740 <term><emphasis remap='I'>rait</emphasis></term>
742 <para><emphasis remap='I'>R</emphasis>edundant
743 <emphasis remap='I'>A</emphasis>rray
745 <emphasis remap='I'>I</emphasis>nexpensive (?)
746 <emphasis remap='I'>T</emphasis>apes.
747 Reads and writes tapes mounted on multiple drives by spreading
748 the data across N-1 drives and using the last drive for a checksum.
749 See docs/RAIT for more information.</para>
752 <emphasis remap='I'>driver-info</emphasis>
753 field describes the devices to use. Curly braces indicate multiple replacements in the string.
756 <para><programlisting>tapedev rait:/dev/rmt/tps0d{4,5,6}n
757 </programlisting></para>
759 <para>would use the following devices:</para>
761 <para><filename>/dev/rmt/tps0d4n</filename>
762 <filename>/dev/rmt/tps0d5n</filename>
763 <filename>/dev/rmt/tps0d6n</filename>
768 <variablelist remap='TP'>
770 <term><emphasis remap='I'>file</emphasis></term>
772 <para>This driver emulates a tape device with a set of files in a directory.
774 <emphasis remap='I'>driver-info</emphasis>
775 field must be the name of an existing directory.
776 The driver will test for a subdirectory of that named
777 <emphasis remap='I'>data</emphasis>
779 <emphasis remap='B'>offline</emphasis>
781 When present, the driver uses two files in the
782 <emphasis remap='I'>data</emphasis>
783 subdirectory for each tape file. One contains the actual data.
784 The other contains record length information.</para>
786 <para>The driver uses a file named
787 <emphasis remap='I'>status</emphasis>
789 <emphasis remap='B'>file</emphasis>
790 device directory to hold driver status information, such as tape position.
791 If not present, the driver will create it as though the device is rewound.</para>
794 <emphasis remap='I'>length</emphasis>
795 value from the associated
796 <emphasis remap='B'>tapetype</emphasis>
797 is used to limit the amount of data written.
798 When the limit is reached, the driver will simulate end of tape.</para>
800 <para>One way to use this driver with a real device such as a CD-writer is to
801 create a directory for the
802 <emphasis remap='B'>file</emphasis>
803 device and one or more other directories for the actual data.
804 Create a symlink named
805 <emphasis remap='I'>data</emphasis>
807 <emphasis remap='B'>file</emphasis>
808 directory to one of the data directories.
810 <emphasis remap='B'>tapetype</emphasis>
811 length to whatever the medium will hold.</para>
813 <para>When &A; fills the
814 <emphasis remap='B'>file</emphasis>
815 device, remove the symlink and (optionally) create a new symlink to another
817 Use a CD writer software package to burn the image from the first data area.</para>
819 <para>To read the CD, mount it and create the
820 <emphasis remap='I'>data</emphasis>
822 <emphasis remap='B'>file</emphasis>
823 device directory.</para>
829 <refsect1><title>AUTHORIZATION</title>
830 <para>&A; processes on the tape server host run as the
831 <emphasis remap='B'>dumpuser</emphasis>
833 <emphasis remap='B'>amanda.conf</emphasis>.
834 When they connect to a backup client, they do so with an &A;-specific protocol.
835 They do not, for instance, use
836 <emphasis remap='B'>rsh</emphasis>
838 <emphasis remap='B'>ssh</emphasis>
841 <para>On the client side, the
842 <emphasis remap='B'>amandad</emphasis>
843 daemon validates the connection using one of several methods,
844 depending on how it was compiled and on options it is passed:</para>
846 <variablelist remap='IP'>
850 <para>Even though &A; does not use
851 <emphasis remap='B'>rsh</emphasis>,
853 <markup>.rhosts</markup>-style
855 <markup>.rhosts</markup>
860 <term>.amandahosts</term>
862 <para>This is essentially the same as
863 <markup>.rhosts</markup>
864 authentication except a different file, with almost the same format, is used.
865 This is the default mechanism built into &A;.</para>
867 <para>The format of the
868 <filename>.amandahosts</filename>
871 <para><emphasis remap='I'>hostname</emphasis>
873 <emphasis remap='I'>username</emphasis>
875 <emphasis remap='I'>service</emphasis>
879 <emphasis remap='I'>username</emphasis>
880 is ommitted, it defaults to the user running
881 <emphasis remap='B'>amandad</emphasis>,
882 i.e. the user listed in the
883 <emphasis remap='B'>inetd</emphasis>
885 <emphasis remap='B'>xinetd</emphasis>
886 configuration file.</para>
887 <para>The <emphasis remap='I'>service</emphasis> is a list of the service the client is authorized to execute:
888 <emphasis remap='B'>amdump</emphasis>,
889 <emphasis remap='B'>noop</emphasis>,
890 <emphasis remap='B'>selfcheck</emphasis>,
891 <emphasis remap='B'>sendsize</emphasis>,
892 <emphasis remap='B'>sendbackup</emphasis>,
893 <emphasis remap='B'>amindexd</emphasis>,
894 <emphasis remap='B'>amidxtaped</emphasis>.
895 <emphasis remap='B'>amdump</emphasis> is a shortcut for "noop selfcheck sendsize sendbackup"</para>
899 <term>Kerberos</term>
901 <para>&A; may use the Kerberos authentication system.
902 Further information is in the
903 <emphasis remap='B'>docs/KERBEROS</emphasis>
904 <!-- TODO: edit link -->
905 file that comes with an &A; distribution.</para>
907 <para>For Samba access,
908 &A; needs a file on the Samba server (which may
909 or may not also be the tape server) named
910 <filename>/etc/amandapass</filename>
911 with share names, (clear text) passwords and (optional) domain names,
912 in that order, one per line, whitespace separated.
913 By default, the user used to connect to the PC is the same for all
914 PC's and is compiled into &A;.
915 It may be changed on a host by host basis
916 by listing it first in the password field followed
917 by a percent sign and then the password.
921 //some-pc/home normalpw
922 //another-pc/disk otheruser%otherpw
925 With clear text passwords, this file should obviously be tightly protected.
926 It only needs to be readable by the &A;-user on the Samba server.
928 <para>You can find further information in the
929 <emphasis remap='B'>docs/SAMBA</emphasis>
930 <!-- TODO: edit link -->
931 file that comes with an &A; distribution.</para>
938 <refsect1><title>HOST & DISK EXPRESSION</title>
939 <para>All host and disk arguments to programs are special expressions.
940 The command applies to all disks that match your arguments.
941 This section describes the matcher.</para>
943 <para>The matcher matches by word, each word is a glob expression, words
944 are separated by the separator '.' for host and '/' for disk. You
945 can anchor the expression at left with a '^'. You can
946 anchor the expression at right with a '$'. The matcher
947 is case insensitive for host but is case sensitive for disk. A match
948 succeeds if all words in your expression match contiguous words in
949 the host or disk.</para>
952 <literallayout remap='.nf'>
953 . word separator for a host
954 / word separator for a disk
957 ? match exactly one character except the separator
958 * match zero or more characters except the separator
959 ** match zero or more characters including the separator
963 <para>Some examples:</para>
965 <literallayout remap='.nf'>
966 EXPRESSION WILL MATCH WILL NOT MATCH
973 ho*na hoina ho.aina.org
976 ^hosta hosta foo.hosta.org
979 /opt/ opt (disk) opt (host)
980 .opt. opt (host) opt (disk)
990 <refsect1><title>DATESTAMP EXPRESSION</title>
992 <emphasis remap='I'>datestamp</emphasis>
993 expression is a range expression where we only match the prefix.
994 Leading ^ is removed. Trailing $ forces an exact match.</para>
996 <informaltable frame="all">
997 <tgroup cols="2" alignment="left">
1001 <entry>20001212-14</entry>
1002 <entry>match all dates beginning with 20001212, 20001213 or 20001214</entry>
1006 <entry>20001212-4</entry>
1007 <entry>same as previous</entry>
1011 <entry>20001212-24</entry>
1012 <entry>match all dates between 20001212 and 20001224</entry>
1016 <entry>2000121</entry>
1017 <entry>match all dates that start with 2000121 (20001210-20001219)</entry>
1022 <entry>match all dates that start with 2 (20000101-29991231)</entry>
1026 <entry>2000-10</entry>
1027 <entry>match all dates between 20000101-20101231</entry>
1031 <entry>200010$</entry>
1032 <entry>match only 200010</entry>
1042 <refsect1><title>CONFIGURATION OVERWRITE</title>
1043 <para>Most command allow to overwrite any configuration parameter on
1044 the command line with the -o option.</para>
1045 <para>-o NAME=value</para>
1046 <para>eg. -o runtapes=2</para>
1047 <para>eg. -o DUMPTYPE:no-compress:compress="server fast"</para>
1048 <para>eg. -o TAPETYPE:HP-DAT:length=2000m</para>
1049 <para>eg. -o INTERFACE:local:use="2000 kbps"</para>
1054 <refsect1><title>AUTHOR</title>
1055 <para>James da Silva, &email.jds; : Original text</para>
1056 <para>&maintainer.sgw;: XML-conversion, major update</para>
1059 <refsect1><title>SEE ALSO</title>
1061 <citerefentry><refentrytitle>amadmin</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1062 <citerefentry><refentrytitle>amanda.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1063 <citerefentry><refentrytitle>amanda-client.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1064 <citerefentry><refentrytitle>amcheck</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1065 <citerefentry><refentrytitle>amcheckdb</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1066 <citerefentry><refentrytitle>amcleanup</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1067 <citerefentry><refentrytitle>amdd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1068 <citerefentry><refentrytitle>amdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1069 <citerefentry><refentrytitle>amfetchdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>
1070 <citerefentry><refentrytitle>amflush</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1071 <citerefentry><refentrytitle>amgetconf</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1072 <citerefentry><refentrytitle>amlabel</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1073 <citerefentry><refentrytitle>ammt</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1074 <citerefentry><refentrytitle>amoverview</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1075 <citerefentry><refentrytitle>amplot</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1076 <citerefentry><refentrytitle>amrecover</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1077 <citerefentry><refentrytitle>amreport</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1078 <citerefentry><refentrytitle>amrestore</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1079 <citerefentry><refentrytitle>amrmtape</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1080 <citerefentry><refentrytitle>amstatus</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1081 <citerefentry><refentrytitle>amtape</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1082 <citerefentry><refentrytitle>amtapetype</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1083 <citerefentry><refentrytitle>amtoc</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1084 <citerefentry><refentrytitle>amverify</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1085 <citerefentry><refentrytitle>amverifyrun</refentrytitle><manvolnum>8</manvolnum></citerefentry></para>