1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
10 .de Sp \" Vertical space (when we can't use .PP)
16 .ie \\n(.$>=3 .ne \\$3
20 .TH "AMANDA" 8 "" "" ""
22 amanda - Advanced Maryland Automatic Network Disk Archiver
25 \fBamadmin\fR \fIconfig\fR \fIcommand\fR [\fIoptions\fR]
29 \fBamcheck\fR [\fIoptions\fR] \fIconfig\fR
33 \fBamcheckdb\fR \fIconfig\fR
37 \fBamcleanup\fR \fIconfig\fR
45 \fBamdd\fR [\fIoptions\fR]
47 \fBamdump\fR \fIconfig\fR
55 \fBamflush\fR [-f] \fIconfig\fR
59 \fBamgetconf\fR [\fIconfig\fR] \fIparameter\fR
63 \fBamlabel\fR \fIconfig\fR \fIlabel\fR [\fIslot\fR \fIslot\fR]
67 \fBammt\fR [\fIoptions\fR]
69 \fBamoverview\fR \fIconfig\fR [\fIoptions\fR]
73 \fBamplot\fR [\fIoptions\fR] \fIamdump-files\fR
77 \fBamrecover\fR [\fIconfig\fR] [\fIoptions\fR]
81 \fBamreport\fR [\fIconfig\fR] [\fIoptions\fR]
85 \fBamrestore\fR [\fIoptions\fR] \fItapedevice\fR [\fIhostname\fR [\fIdiskname\fR]]
89 \fBamfetchdump\fR [\fIoptions\fR] \fIconfig\fR [\fIhostname\fR [\fIdiskname\fR [\fIdate\fR [level]]]]
91 \fBamrmtape\fR [\fIoptions\fR] \fIconfig\fR \fIlabel\fR
95 \fBamstatus\fR \fIconfig\fR [\fIoptions\fR]
99 \fBamtape\fR \fIconfig\fR \fIcommand\fR [\fIoptions\fR]
103 \fBamtapetype\fR [\fIoptions\fR]
105 \fBamtoc\fR [\fIoptions\fR] \fIlogfile\fR
109 \fBamverify\fR \fIconfig\fR
113 \fBamverifyrun\fR \fIconfig\fR
117 is the "Advanced Maryland Automatic Network Disk Archiver". This manual page gives an overview of the
119 commands and configuration files for quick reference.
123 commands. Each one has its own manual page. See them for all the gory details.
126 Take care of automatic
128 backups. This is normally executed by
130 on a computer called the
131 \fBtape server host\fR
132 and requests backups of file systems located on
133 \fBbackup\fR\fBclients\fR.
135 backs up all disks in the
137 file (discussed below) to tape or, if there is a problem, to a special
138 \fBholding\fR\fBdisk\fR. After all backups are done,
140 sends mail reporting failures and successes.
143 Flush backups from the holding disk to tape.
147 has reported it could not write backups to tape for some reason. When this happens, backups stay in the holding disk. Run
149 after the tape problem is corrected to write backups from the holding disk to tape.
152 Clean up after an interrupted
153 \fBamdump\fR. This command is only needed if
155 was unable to complete for some reason, usually because the tape server host crashed while
160 Provides an interactive interface to browse the
162 index files (backup image catalogues) and select which tapes to recover files from. It can also run
164 and a restore program (e.g.
165 \fBtar\fR) to actually recover the files.
170 tape, searching for requested backups.
172 is suitable for everything from interactive restores of single files to a full restore of all partitions on a failed disk.
177 tape restoration, similar to
178 \fBamrestore\fR. Additional capabilities include "hands-off" searching of multiple tapes, automatic retrieval of specific dump files based on dump logs, and assembly of tape-spanning split dump files.
183 format label onto a tape. All
185 tapes must be labeled with
190 will not write to an unlabeled tape (see TAPE MANAGEMENT below).
193 Verify the correct tape is mounted and all file systems on all backup client systems are ready to be backed up. Often run by
197 to generate a mail warning that backups might fail unless corrective action is taken.
200 Take care of administrative tasks like finding out which tapes are needed to restore a filesystem, forcing hosts to do full backups of selected disks and looking at schedule balance information.
203 Take care of tape changer control operations like loading particular tapes, ejecting tapes and scanning the tape storage slots.
208 backup tapes for errors.
211 Delete a tape from the
216 Report the status of a running or completed
220 Display a chart of hosts and file systems backed up every run.
223 Generate utilization plots of
225 runs for performance tuning.
230 summary E-mail report.
233 Generate table of content files for
240 knows about is consistent in the database.
243 Look up parameters in the
248 Generate a tapetype definition.
251 Wrapper program from aespipe (data encryption utility)
254 Reference encryption program for Amanda symmetric data encryption
257 There are three user-editable files that control the behavior of
261 \fBamanda.conf\fR, the main configuration file. It contains parameters to customize
263 for the site. Refer to the
264 \fBamanda.conf\fR(5), manpage for details on
266 configuration parameters.
270 file, which lists hosts and disk partitions to back up.
274 file, which lists tapes that are currently active. These files are described in more detail in the following sections.
276 All files are stored in individual configuration directories under
277 \fI/usr/local/etc/amanda/\fR. A site will often have more than one configuration. For example, it might have a
279 configuration for everyday backups and an
281 configuration for infrequent full archival backups. The configuration files would be stored under directories
282 \fI/usr/local/etc/amanda/normal/\fR
284 \fI/usr/local/etc/amanda/archive/\fR, respectively. Part of the job of an
286 administrator is to create, populate and maintain these directories.
288 All log and database files generated by
290 go in corresponding directories somewhere. The exact location is controlled by entries in
291 \fBamanda.conf\fR. A typical location would be under
292 \fI/var/adm/amanda\fR. For the above example, the files might go in
293 \fI/var/adm/amanda/normal/\fR
295 \fI/var/adm/amanda/archive/\fR.
297 As log files are no longer needed (no longer contain relevant information),
299 cycles them out in various ways, depending on the type of file.
301 Detailed information about
303 runs are stored in files named
304 \fBamdump.\fR\fBNN\fR
307 is a sequence number, with 1 being the most recent file.
309 rotates these files each run, keeping roughly the last
311 (see below) worth of them.
315 to generate the mail summary is named
316 \fBlog.\fR\fBYYYYMMDD.NN\fR
319 is the datestamp of the start of the
323 is a sequence number started at 0. At the end of each
325 run, log files for runs whose tapes have been reused are renamed into a subdirectory of the main log directory (see the
327 parameter below) named
328 \fBoldlog\fR. It is up to the
330 administrator to remove them from this directory when desired.
332 Index (backup image catalogue) files older than the full dump matching the oldest backup image for a given client and disk are removed by
334 at the end of each run.
339 file determines which disks will be backed up by
340 \fBAmanda\fR. The file usually contains one line per disk:
343 \fBhostname diskname\fR [\fBdiskdevice\fR] \fBdumptype\fR [\fBspindle\fR [\fBinterface\fR] ]
347 \fBhostname diskname\fR
350 Lines starting with # are ignored, as are blank lines. The fields have the following meanings:
353 The name of the host to be backed up. If
355 refers to a PC share, this is the host
359 program on to back up the share.
362 The name of the disk (a label). In most case, you set your
366 and you don't set the
368 If you want multiple entries with the same
369 \fBdiskdevice\fR, you must set a different
371 for each entry. It's the
373 that you use on the commandline for any
375 command. Look at the example/disklist file for example.
378 Default: same as diskname. The name of the disk device to be backed up. It may be a full device name, a device name without the
381 \fBsd0a\fR, or a mount point such as
384 It may also refer to a PC share by starting the name with two (forward) slashes, e.g.
385 \fI//some-pc/home\fR. In this case, the
387 option in the associated
390 \fBGNUTAR\fR. It is the combination of the double slash disk name and
394 that triggers the use of Samba.
402 \fBDumptype\fRs specify backup related parameters, such as whether to compress the backups, whether to record backup results in
403 \fI/etc/dumpdates\fR, the disk's relative priority, etc.
407 \fB-1\fR. A number used to balance backup load on a host.
409 will not run multiple backups at the same time on the same spindle, unless the spindle number is -1, which means there is no spindle restriction.
413 \fBlocal\fR. The name of a network interface definition in the
415 file, used to balance network load.
418 \fBdumptype\fR, it is possible to define one in-line, enclosing
420 options within curly braces, one per line, just like a
423 \fBamanda.conf\fR. Since pre-existing
424 \fBdumptype\fRs are valid option names, this syntax may be used to customize
425 \fBdumptype\fRs for particular disks.
429 follow the left curly bracket.
435 is used for most disks, but use of the holding disk needs to be disabled for the file system that holds it, this would work instead of defining a new dumptype:
438 \fBhostname diskname\fR [ \fBdiskdevice\fR ] {
441 } [ \fBspindle\fR [ \fBinterface\fR ] ]
443 .SH "TAPE MANAGEMENT"
447 file contains the list of tapes in active use. This file is maintained entirely by
449 and should not be created or edited during normal operation. It contains lines of the form:
460 is the date the tape was written,
462 is a label for the tape as written by
468 whether the tape may be reused, etc (see the
476 will refuse to write to an unlabeled tape, or to a labeled tape that is considered active. There must be more tapes in active rotation (see the
478 option) than there are runs in the backup cycle (see the
480 option) to prevent overwriting a backup image that would be needed to do a full recovery.
483 The normal value for the
485 parameter, or for what a tape changer returns, is a full path name to a non-rewinding tape device, such as
491 or whatever conventions the operating system uses.
493 provides additional application level drivers that support non-traditional tape-simulations or features. To access a specific output driver, set
495 (or configure your changer to return) a string of the form
496 \fBdriver\fR:\fBdriver-info\fR
499 is one of the supported drivers and
501 is optional additional information needed by the driver.
503 The supported drivers are:
506 This is the default driver. The
508 is the tape device name. Entering
514 is really a short hand for
518 tapedev tape:/dev/rmt/0mn
523 This driver throws away anything written to it and returns EOF for any reads except a special case is made for reading a label, in which case a "fake" value is returned that
525 checks for and allows through regardless of what you have set in
528 field is not used and may be left blank:
539 value from the associated
541 is used to limit the amount of data written. When the limit is reached, the driver will simulate end of tape.
544 .nr an-no-space-flag 1
548 This driver should only be used for debugging and testing,
549 and probably only with the
556 \fBI\fRnexpensive (?)
557 \fBT\fRapes. Reads and writes tapes mounted on multiple drives by spreading the data across N-1 drives and using the last drive for a checksum. See docs/RAIT for more information.
561 field describes the devices to use. Curly braces indicate multiple replacements in the string. For instance:
566 tapedev rait:/dev/rmt/tps0d{4,5,6}n
570 would use the following devices:
572 \fI/dev/rmt/tps0d4n\fR\fI/dev/rmt/tps0d5n\fR\fI/dev/rmt/tps0d6n\fR
575 This driver emulates a tape device with a set of files in a directory. The
577 field must be the name of an existing directory. The driver will test for a subdirectory of that named
581 until it is present. When present, the driver uses two files in the
583 subdirectory for each tape file. One contains the actual data. The other contains record length information.
585 The driver uses a file named
589 device directory to hold driver status information, such as tape position. If not present, the driver will create it as though the device is rewound.
593 value from the associated
595 is used to limit the amount of data written. When the limit is reached, the driver will simulate end of tape.
597 One way to use this driver with a real device such as a CD-writer is to create a directory for the
599 device and one or more other directories for the actual data. Create a symlink named
603 directory to one of the data directories. Set the
605 length to whatever the medium will hold.
611 device, remove the symlink and (optionally) create a new symlink to another data area. Use a CD writer software package to burn the image from the first data area.
613 To read the CD, mount it and create the
621 processes on the tape server host run as the
624 \fBamanda.conf\fR. When they connect to a backup client, they do so with an
625 \fBAmanda\fR-specific protocol. They do not, for instance, use
631 On the client side, the
633 daemon validates the connection using one of several methods, depending on how it was compiled and on options it is passed:
639 \fBrsh\fR, it can use
640 .rhosts-style authentication and a
645 This is essentially the same as
647 authentication except a different file, with almost the same format, is used. This is the default mechanism built into
663 is ommitted, it defaults to the user running
664 \fBamandad\fR, i.e. the user listed in the
672 is a list of the service the client is authorized to execute:
681 is a shortcut for "noop selfcheck sendsize sendbackup"
685 may use the Kerberos authentication system. Further information is in the
686 \fBdocs/KERBEROS\fRfile that comes with an
692 needs a file on the Samba server (which may or may not also be the tape server) named
693 \fI/etc/amandapass\fR
694 with share names, (clear text) passwords and (optional) domain names, in that order, one per line, whitespace separated. By default, the user used to connect to the PC is the same for all PC's and is compiled into
695 \fBAmanda\fR. It may be changed on a host by host basis by listing it first in the password field followed by a percent sign and then the password. For instance:
698 //some-pc/home normalpw
699 //another-pc/disk otheruser%otherpw
703 With clear text passwords, this file should obviously be tightly protected.
704 It only needs to be readable by the \fBAmanda\fR-user on the Samba server.
706 You can find further information in the
707 \fBdocs/SAMBA\fRfile that comes with an
710 .SH "HOST & DISK EXPRESSION"
712 All host and disk arguments to programs are special expressions. The command applies to all disks that match your arguments. This section describes the matcher.
714 The matcher matches by word, each word is a glob expression, words are separated by the separator '.' for host and '/' for disk. You can anchor the expression at left with a '^'. You can anchor the expression at right with a '$'. The matcher is case insensitive for host but is case sensitive for disk. A match succeeds if all words in your expression match contiguous words in the host or disk.
718 . word separator for a host
719 / word separator for a disk
722 ? match exactly one character except the separator
723 * match zero or more characters except the separator
724 ** match zero or more characters including the separator
732 EXPRESSION WILL MATCH WILL NOT MATCH
739 ho*na hoina ho.aina.org
742 ^hosta hosta foo.hosta.org
745 /opt/ opt (disk) opt (host)
746 .opt. opt (host) opt (disk)
753 .SH "DATESTAMP EXPRESSION"
757 expression is a range expression where we only match the prefix. Leading ^ is removed. Trailing $ forces an exact match.
758 20001212-14match all dates beginning with 20001212, 20001213 or 2000121420001212-4same as previous20001212-24match all dates between 20001212 and 200012242000121match all dates that start with 2000121 (20001210-20001219)2match all dates that start with 2 (20000101-29991231)2000-10match all dates between 20000101-20101231200010$match only 200010.PP
760 .SH "CONFIGURATION OVERWRITE"
762 Most command allow to overwrite any configuration parameter on the command line with the -o option.
768 eg. -o DUMPTYPE:no-compress:compress="server fast"
770 eg. -o TAPETYPE:HP-DAT:length=2000m
772 eg. -o INTERFACE:local:use="2000 kbps"
779 Stefan G. Weichinger,
780 <sgw@amanda.org>, maintainer of the
781 \fBAmanda\fR-documentation: XML-conversion, major update
785 \fBamanda.conf\fR(5),
786 \fBamanda-client.conf\fR(5),
792 \fBamfetchdump\fR(8)\fBamflush\fR(8),
projects / debian / amanda / blob