3 .\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
8 .TH "AMANDA" "8" "02/07/2007" "" ""
9 .\" disable hyphenation
11 .\" disable justification (adjust text to left margin only)
14 amanda \- Advanced Maryland Automatic Network Disk Archiver
17 \fBamadmin\fR \fIconfig\fR \fIcommand\fR [\fIoptions\fR]
21 \fBamcheck\fR [\fIoptions\fR] \fIconfig\fR
25 \fBamcheckdb\fR \fIconfig\fR
29 \fBamcleanup\fR \fIconfig\fR
37 \fBamdd\fR [\fIoptions\fR]
39 \fBamdump\fR \fIconfig\fR
47 \fBamflush\fR [\-f] \fIconfig\fR
51 \fBamgetconf\fR [\fIconfig\fR] \fIparameter\fR
55 \fBamlabel\fR \fIconfig\fR \fIlabel\fR [\fIslot\fR\ \fIslot\fR]
59 \fBammt\fR [\fIoptions\fR]
61 \fBamoverview\fR \fIconfig\fR [\fIoptions\fR]
65 \fBamplot\fR [\fIoptions\fR] \fIamdump\-files\fR
69 \fBamrecover\fR [\fIconfig\fR] [\fIoptions\fR]
73 \fBamreport\fR [\fIconfig\fR] [\fIoptions\fR]
77 \fBamrestore\fR [\fIoptions\fR] \fItapedevice\fR [\fIhostname\fR\ [\fIdiskname\fR]]
81 \fBamfetchdump\fR [\fIoptions\fR] \fIconfig\fR [\fIhostname\fR\ [\fIdiskname\fR\ [\fIdate\fR\ [level]]]]
83 \fBamrmtape\fR [\fIoptions\fR] \fIconfig\fR \fIlabel\fR
87 \fBamstatus\fR \fIconfig\fR [\fIoptions\fR]
91 \fBamtape\fR \fIconfig\fR \fIcommand\fR [\fIoptions\fR]
95 \fBamtapetype\fR [\fIoptions\fR]
97 \fBamtoc\fR [\fIoptions\fR] \fIlogfile\fR
101 \fBamverify\fR \fIconfig\fR
105 \fBamverifyrun\fR \fIconfig\fR
109 is the "Advanced Maryland Automatic Network Disk Archiver". This manual page gives an overview of the
111 commands and configuration files for quick reference.
115 commands. Each one has its own manual page. See them for all the gory details.
119 Take care of automatic
121 backups. This is normally executed by
123 on a computer called the
124 \fItape server host\fR
125 and requests backups of file systems located on
129 backs up all disks in the
131 file (discussed below) to tape or, if there is a problem, to a special
133 \fIdisk\fR. After all backups are done,
135 sends mail reporting failures and successes.
140 Flush backups from the holding disk to tape.
144 has reported it could not write backups to tape for some reason. When this happens, backups stay in the holding disk. Run
146 after the tape problem is corrected to write backups from the holding disk to tape.
151 Clean up after an interrupted
152 \fBamdump\fR. This command is only needed if
154 was unable to complete for some reason, usually because the tape server host crashed while
161 Provides an interactive interface to browse the
163 index files (backup image catalogues) and select which tapes to recover files from. It can also run
165 and a restore program (e.g.
166 \fBtar\fR) to actually recover the files.
173 tape, searching for requested backups.
175 is suitable for everything from interactive restores of single files to a full restore of all partitions on a failed disk.
182 tape restoration, similar to
183 \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.
190 format label onto a tape. All
192 tapes must be labeled with
197 will not write to an unlabeled tape (see TAPE MANAGEMENT below).
202 Verify the correct tape is mounted and all file systems on all backup client systems are ready to be backed up. Often run by
206 to generate a mail warning that backups might fail unless corrective action is taken.
211 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.
216 Take care of tape changer control operations like loading particular tapes, ejecting tapes and scanning the tape storage slots.
223 backup tapes for errors.
228 Delete a tape from the
235 Report the status of a running or completed
241 Display a chart of hosts and file systems backed up every run.
246 Generate utilization plots of
248 runs for performance tuning.
255 summary E\-mail report.
260 Generate table of content files for
269 knows about is consistent in the database.
274 Look up parameters in the
281 Generate a tapetype definition.
286 Wrapper program from aespipe (data encryption utility)
291 Reference encryption program for Amanda symmetric data encryption
295 There are three user\-editable files that control the behavior of
299 \fBamanda.conf\fR, the main configuration file. It contains parameters to customize
301 for the site. Refer to the
302 \fBamanda.conf\fR(5), manpage for details on
304 configuration parameters.
308 file, which lists hosts and disk partitions to back up.
312 file, which lists tapes that are currently active. These files are described in more detail in the following sections.
314 All files are stored in individual configuration directories under
315 \fI/usr/local/etc/amanda/\fR. A site will often have more than one configuration. For example, it might have a
317 configuration for everyday backups and an
319 configuration for infrequent full archival backups. The configuration files would be stored under directories
320 \fI/usr/local/etc/amanda/normal/\fR
322 \fI/usr/local/etc/amanda/archive/\fR, respectively. Part of the job of an
324 administrator is to create, populate and maintain these directories.
326 All log and database files generated by
328 go in corresponding directories somewhere. The exact location is controlled by entries in
329 \fBamanda.conf\fR. A typical location would be under
330 \fI/var/adm/amanda\fR. For the above example, the files might go in
331 \fI/var/adm/amanda/normal/\fR
333 \fI/var/adm/amanda/archive/\fR.
335 As log files are no longer needed (no longer contain relevant information),
337 cycles them out in various ways, depending on the type of file.
339 Detailed information about
341 runs are stored in files named
342 \fBamdump.\fR\fINN\fR
345 is a sequence number, with 1 being the most recent file.
347 rotates these files each run, keeping roughly the last
349 (see below) worth of them.
353 to generate the mail summary is named
354 \fBlog.\fR\fIYYYYMMDD.NN\fR
357 is the datestamp of the start of the
361 is a sequence number started at 0. At the end of each
363 run, log files for runs whose tapes have been reused are renamed into a subdirectory of the main log directory (see the
365 parameter below) named
366 \fBoldlog\fR. It is up to the
368 administrator to remove them from this directory when desired.
370 Index (backup image catalogue) files older than the full dump matching the oldest backup image for a given client and disk are removed by
372 at the end of each run.
377 file determines which disks will be backed up by
378 \fIAmanda\fR. The file usually contains one line per disk:
382 \fIhostname diskname\fR [\fIdiskdevice\fR] \fIdumptype\fR [\fIspindle\fR [\fIinterface\fR] ]
387 \fIhostname diskname\fR
390 Lines starting with # are ignored, as are blank lines. The fields have the following meanings:
394 The name of the host to be backed up. If
396 refers to a PC share, this is the host
400 program on to back up the share.
405 The name of the disk (a label). In most case, you set your
409 and you don't set the
411 If you want multiple entries with the same
412 \fBdiskdevice\fR, you must set a different
414 for each entry. It's the
416 that you use on the commandline for any
418 command. Look at the example/disklist file for example.
423 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
426 \fIsd0a\fR, or a mount point such as
429 It may also refer to a PC share by starting the name with two (forward) slashes, e.g.
430 \fI//some\-pc/home\fR. In this case, the
432 option in the associated
435 \fBGNUTAR\fR. It is the combination of the double slash disk name and
439 that triggers the use of Samba.
449 \fIDumptype\fRs specify backup related parameters, such as whether to compress the backups, whether to record backup results in
450 \fI/etc/dumpdates\fR, the disk's relative priority, etc.
456 \fB\-1\fR. A number used to balance backup load on a host.
458 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.
464 \fIlocal\fR. The name of a network interface definition in the
466 file, used to balance network load.
470 \fBdumptype\fR, it is possible to define one in\-line, enclosing
472 options within curly braces, one per line, just like a
475 \fBamanda.conf\fR. Since pre\-existing
476 \fBdumptype\fRs are valid option names, this syntax may be used to customize
477 \fBdumptype\fRs for particular disks.
481 follow the left curly bracket.
487 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:
491 \fIhostname diskname\fR [ \fIdiskdevice\fR ] {
494 } [ \fIspindle\fR [ \fIinterface\fR ] ]
497 .SH "TAPE MANAGEMENT"
501 file contains the list of tapes in active use. This file is maintained entirely by
503 and should not be created or edited during normal operation. It contains lines of the form:
513 is the date the tape was written,
515 is a label for the tape as written by
521 whether the tape may be reused, etc (see the
529 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
531 option) than there are runs in the backup cycle (see the
533 option) to prevent overwriting a backup image that would be needed to do a full recovery.
536 The normal value for the
538 parameter, or for what a tape changer returns, is a full path name to a non\-rewinding tape device, such as
544 or whatever conventions the operating system uses.
546 provides additional application level drivers that support non\-traditional tape\-simulations or features. To access a specific output driver, set
548 (or configure your changer to return) a string of the form
549 \fIdriver\fR:\fIdriver\-info\fR
552 is one of the supported drivers and
554 is optional additional information needed by the driver.
556 The supported drivers are:
560 This is the default driver. The
562 is the tape device name. Entering
570 is really a short hand for
574 tapedev tape:/dev/rmt/0mn
581 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
583 checks for and allows through regardless of what you have set in
586 field is not used and may be left blank:
597 value from the associated
599 is used to limit the amount of data written. When the limit is reached, the driver will simulate end of tape.
602 .nr an-no-space-flag 1
606 This driver should only be used for debugging and testing, and probably only with the
616 \fII\fRnexpensive (?)
617 \fIT\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.
621 field describes the devices to use. Curly braces indicate multiple replacements in the string. For instance:
626 tapedev rait:/dev/rmt/tps0d{4,5,6}n
630 would use the following devices:
632 \fI/dev/rmt/tps0d4n\fR
633 \fI/dev/rmt/tps0d5n\fR
634 \fI/dev/rmt/tps0d6n\fR
639 This driver emulates a tape device with a set of files in a directory. The
641 field must be the name of an existing directory. The driver will test for a subdirectory of that named
645 until it is present. When present, the driver uses two files in the
647 subdirectory for each tape file. One contains the actual data. The other contains record length information.
649 The driver uses a file named
653 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.
657 value from the associated
659 is used to limit the amount of data written. When the limit is reached, the driver will simulate end of tape.
661 One way to use this driver with a real device such as a CD\-writer is to create a directory for the
663 device and one or more other directories for the actual data. Create a symlink named
667 directory to one of the data directories. Set the
669 length to whatever the medium will hold.
675 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.
677 To read the CD, mount it and create the
686 processes on the tape server host run as the
689 \fBamanda.conf\fR. When they connect to a backup client, they do so with an
690 \fIAmanda\fR\-specific protocol. They do not, for instance, use
696 On the client side, the
698 daemon validates the connection using one of several methods, depending on how it was compiled and on options it is passed:
705 \fBrsh\fR, it can use
706 \fB.rhosts\fR\-style authentication and a
713 This is essentially the same as
715 authentication except a different file, with almost the same format, is used. This is the default mechanism built into
731 is ommitted, it defaults to the user running
732 \fBamandad\fR, i.e. the user listed in the
740 is a list of the service the client is authorized to execute:
749 is a shortcut for "noop selfcheck sendsize sendbackup"
755 may use the Kerberos authentication system. Further information is in the
757 file that comes with an
763 needs a file on the Samba server (which may or may not also be the tape server) named
764 \fI/etc/amandapass\fR
765 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
766 \fIAmanda\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:
770 //some\-pc/home normalpw
771 //another\-pc/disk otheruser%otherpw
774 With clear text passwords, this file should obviously be tightly protected. It only needs to be readable by the
775 \fIAmanda\fR\-user on the Samba server.
777 You can find further information in the
779 file that comes with an
783 .SH "HOST & DISK EXPRESSION"
785 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.
787 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.
800 word separator for a host
805 word separator for a disk
820 match exactly one character except the separator
825 match zero or more characters except the separator
830 match zero or more characters including the separator
992 .SH "DATESTAMP EXPRESSION"
996 expression is a range expression where we only match the prefix. Leading ^ is removed. Trailing $ forces an exact match.
1009 match all dates beginning with 20001212, 20001213 or 20001214
1019 match all dates between 20001212 and 20001224
1024 match all dates that start with 2000121 (20001210\-20001219)
1029 match all dates that start with 2 (20000101\-29991231)
1034 match all dates between 20000101\-20101231
1044 .SH "CONFIGURATION OVERWRITE"
1046 Most command allow to overwrite any configuration parameter on the command line with the \-o option.
1052 eg. \-o DUMPTYPE:no\-compress:compress="server fast"
1054 eg. \-o TAPETYPE:HP\-DAT:length=2000m
1056 eg. \-o INTERFACE:local:use="2000 kbps"
1063 Stefan G. Weichinger,
1064 <sgw@amanda.org>, maintainer of the
1065 \fIAmanda\fR\-documentation: XML\-conversion, major update
1070 \fBamanda.conf\fR(5),
1071 \fBamanda\-client.conf\fR(5),
1077 \fBamfetchdump\fR(8)
1082 \fBamoverview\fR(8),
1090 \fBamtapetype\fR(8),
1093 \fBamverifyrun\fR(8)
projects / debian / amanda / blob