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
27 \fBamadmin\fR \fIconfig\fR \fIcommand\fR [\fIoptions\fR]
35 \fBamcheck\fR [\fIoptions\fR] \fIconfig\fR
43 \fBamcheckdb\fR \fIconfig\fR
51 \fBamcleanup\fR \fIconfig\fR
67 \fBamdd\fR [\fIoptions\fR]
73 \fBamdump\fR \fIconfig\fR
89 \fBamflush\fR [\-f] \fIconfig\fR
97 \fBamgetconf\fR [\fIconfig\fR] \fIparameter\fR
105 \fBamlabel\fR \fIconfig\fR \fIlabel\fR [\fIslot\fR\ \fIslot\fR]
113 \fBammt\fR [\fIoptions\fR]
119 \fBamoverview\fR \fIconfig\fR [\fIoptions\fR]
127 \fBamplot\fR [\fIoptions\fR] \fIamdump\-files\fR
135 \fBamrecover\fR [\fIconfig\fR] [\fIoptions\fR]
143 \fBamreport\fR [\fIconfig\fR] [\fIoptions\fR]
151 \fBamrestore\fR [\fIoptions\fR] \fItapedevice\fR [\fIhostname\fR\ [\fIdiskname\fR]]
159 \fBamfetchdump\fR [\fIoptions\fR] \fIconfig\fR [\fIhostname\fR\ [\fIdiskname\fR\ [\fIdate\fR\ [level]]]]
165 \fBamrmtape\fR [\fIoptions\fR] \fIconfig\fR \fIlabel\fR
173 \fBamstatus\fR \fIconfig\fR [\fIoptions\fR]
181 \fBamtape\fR \fIconfig\fR \fIcommand\fR [\fIoptions\fR]
189 \fBamtapetype\fR [\fIoptions\fR]
195 \fBamtoc\fR [\fIoptions\fR] \fIlogfile\fR
203 \fBamverify\fR \fIconfig\fR
211 \fBamverifyrun\fR \fIconfig\fR
218 \fBAmanda\fR is the "Advanced Maryland Automatic Network Disk Archiver"\&. This manual page gives an overview of the \fBAmanda\fR commands and configuration files for quick reference\&.
221 Here are all the \fBAmanda\fR commands\&. Each one has its own manual page\&. See them for all the gory details\&.
225 Take care of automatic \fBAmanda\fR backups\&. This is normally executed by \fBcron\fR on a computer called the \fBtape server host\fR and requests backups of file systems located on \fBbackup\fR \fBclients\fR\&. \fBAmdump\fR backs up all disks in the \fBdisklist\fR file (discussed below) to tape or, if there is a problem, to a special \fBholding\fR \fBdisk\fR\&. After all backups are done, \fBamdump\fR sends mail reporting failures and successes\&.
229 Flush backups from the holding disk to tape\&. \fBAmflush\fR is used after \fBamdump\fR has reported it could not write backups to tape for some reason\&. When this happens, backups stay in the holding disk\&. Run \fBamflush\fR after the tape problem is corrected to write backups from the holding disk to tape\&.
233 Clean up after an interrupted \fBamdump\fR\&. This command is only needed if \fBamdump\fR was unable to complete for some reason, usually because the tape server host crashed while \fBamdump\fR was running\&.
237 Provides an interactive interface to browse the \fBAmanda\fR index files (backup image catalogues) and select which tapes to recover files from\&. It can also run \fBamrestore\fR and a restore program (e\&.g\&. \fBtar\fR) to actually recover the files\&.
241 Read an \fBAmanda\fR tape, searching for requested backups\&. \fBAmrestore\fR is suitable for everything from interactive restores of single files to a full restore of all partitions on a failed disk\&.
245 Performs \fBAmanda\fR tape restoration, similar to \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\&.
249 Write an \fBAmanda\fR format label onto a tape\&. All \fBAmanda\fR tapes must be labeled with \fBamlabel\fR\&. \fBAmdump\fR and \fBamflush\fR will not write to an unlabeled tape (see TAPE MANAGEMENT below)\&.
253 Verify the correct tape is mounted and all file systems on all backup client systems are ready to be backed up\&. Often run by \fBcron\fR before \fBamdump\fR to generate a mail warning that backups might fail unless corrective action is taken\&.
257 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\&.
261 Take care of tape changer control operations like loading particular tapes, ejecting tapes and scanning the tape storage slots\&.
265 Check \fBAmanda\fR backup tapes for errors\&.
269 Delete a tape from the \fBAmanda\fR databases\&.
273 Report the status of a running or completed \fBamdump\fR\&.
277 Display a chart of hosts and file systems backed up every run\&.
281 Generate utilization plots of \fBAmanda\fR runs for performance tuning\&.
285 Generate an \fBAmanda\fR summary E\-mail report\&.
289 Generate table of content files for \fBAmanda\fR tapes\&.
293 Verify every tape \fBAmanda\fR knows about is consistent in the database\&.
297 Look up parameters in the \fBAmanda\fR configuration file\&.
301 Generate a tapetype definition\&.
305 Wrapper program from aespipe (data encryption utility)
309 Reference encryption program for Amanda symmetric data encryption
314 There are three user\-editable files that control the behavior of \fBAmanda\fR\&.
317 The first is \fBamanda\&.conf\fR, the main configuration file\&. It contains parameters to customize \fBAmanda\fR for the site\&. Refer to the \fBamanda\&.conf\fR(5), manpage for details on \fBAmanda\fR configuration parameters\&.
320 Second is the \fBdisklist\fR file, which lists hosts and disk partitions to back up\&.
323 Third is the \fBtapelist\fR file, which lists tapes that are currently active\&. These files are described in more detail in the following sections\&.
326 All files are stored in individual configuration directories under \fI/usr/local/etc/amanda/\fR\&. A site will often have more than one configuration\&. For example, it might have a \fBnormal\fR configuration for everyday backups and an \fBarchive\fR configuration for infrequent full archival backups\&. The configuration files would be stored under directories \fI/usr/local/etc/amanda/normal/\fR and \fI/usr/local/etc/amanda/archive/\fR, respectively\&. Part of the job of an \fBAmanda\fR administrator is to create, populate and maintain these directories\&.
329 All log and database files generated by \fBAmanda\fR go in corresponding directories somewhere\&. The exact location is controlled by entries in \fBamanda\&.conf\fR\&. A typical location would be under \fI/var/adm/amanda\fR\&. For the above example, the files might go in \fI/var/adm/amanda/normal/\fR and \fI/var/adm/amanda/archive/\fR\&.
332 As log files are no longer needed (no longer contain relevant information), \fBAmanda\fR cycles them out in various ways, depending on the type of file\&.
335 Detailed information about \fBamdump\fR runs are stored in files named \fBamdump\&.\fR\fBNN\fR where \fBNN\fR is a sequence number, with 1 being the most recent file\&. \fBAmdump\fR rotates these files each run, keeping roughly the last \fBtapecycle\fR (see below) worth of them\&.
338 The file used by \fBamreport\fR to generate the mail summary is named \fBlog\&.\fR\fBYYYYMMDD\&.NN\fR where \fBYYYYMMDD\fR is the datestamp of the start of the \fBamdump\fR run and \fBNN\fR is a sequence number started at 0\&. At the end of each \fBamdump\fR run, log files for runs whose tapes have been reused are renamed into a subdirectory of the main log directory (see the \fBlogdir\fR parameter below) named \fBoldlog\fR\&. It is up to the \fBAmanda\fR administrator to remove them from this directory when desired\&.
341 Index (backup image catalogue) files older than the full dump matching the oldest backup image for a given client and disk are removed by \fBamdump\fR at the end of each run\&.
346 The \fBdisklist\fR file determines which disks will be backed up by \fBAmanda\fR\&. The file usually contains one line per disk:
349 \fBhostname diskname\fR [\fBdiskdevice\fR] \fBdumptype\fR [\fBspindle\fR [\fBinterface\fR] ]
353 All pairs [ \fBhostname diskname\fR ] must be unique\&.
356 Lines starting with # are ignored, as are blank lines\&. The fields have the following meanings:
360 The name of the host to be backed up\&. If \fBdiskdevice\fR refers to a PC share, this is the host \fBAmanda\fR will run the Samba \fBsmbclient\fR program on to back up the share\&.
364 The name of the disk (a label)\&. In most case, you set your \fBdiskname\fR to the \fBdiskdevice\fR and you don't set the \fBdiskdevice\&.\fR If you want multiple entries with the same \fBdiskdevice\fR, you must set a different \fBdiskname\fR for each entry\&. It's the \fBdiskname\fR that you use on the commandline for any \fBAmanda\fR command\&. Look at the example/disklist file for example\&.
368 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 \fI/dev/\fR prefix, e\&.g\&. \fBsd0a\fR, or a mount point such as \fI/usr\fR\&.
370 It may also refer to a PC share by starting the name with two (forward) slashes, e\&.g\&. \fI//some\-pc/home\fR\&. In this case, the \fBprogram\fR option in the associated \fBdumptype\fR must be entered as \fBGNUTAR\fR\&. It is the combination of the double slash disk name and \fBprogram GNUTAR\fR in the \fBdumptype\fR that triggers the use of Samba\&.
374 Refers to a \fBdumptype\fR defined in the \fBamanda\&.conf\fR file\&. \fBDumptype\fRs specify backup related parameters, such as whether to compress the backups, whether to record backup results in \fI/etc/dumpdates\fR, the disk's relative priority, etc\&.
378 Default: \fB\-1\fR\&. A number used to balance backup load on a host\&. \fBAmanda\fR 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\&.
382 Default: \fBlocal\fR\&. The name of a network interface definition in the \fBamanda\&.conf\fR file, used to balance network load\&.
385 Instead of naming a \fBdumptype\fR, it is possible to define one in\-line, enclosing \fBdumptype\fR options within curly braces, one per line, just like a \fBdumptype\fR definition in \fBamanda\&.conf\fR\&. Since pre\-existing \fBdumptype\fRs are valid option names, this syntax may be used to customize \fBdumptype\fRs for particular disks\&.
388 A line break \fBmust\fR follow the left curly bracket\&.
391 For instance, if a \fBdumptype\fR named \fBnormal\fR 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:
394 \fBhostname diskname\fR [ \fBdiskdevice\fR ] {
397 } [ \fBspindle\fR [ \fBinterface\fR ] ]
400 .SH "TAPE MANAGEMENT"
403 The \fBtapelist\fR file contains the list of tapes in active use\&. This file is maintained entirely by \fBAmanda\fR and should not be created or edited during normal operation\&. It contains lines of the form:
413 Where \fBYYYYMMDD\fR is the date the tape was written, \fBlabel\fR is a label for the tape as written by \fBamlabel\fR and \fBflags\fR tell \fBAmanda\fR whether the tape may be reused, etc (see the \fBreuse\fR options of \fBamadmin\fR)\&.
416 \fBAmdump\fR and \fBamflush\fR 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 \fBtapecycle\fR option) than there are runs in the backup cycle (see the \fBdumpcycle\fR option) to prevent overwriting a backup image that would be needed to do a full recovery\&.
421 The normal value for the \fBtapedev\fR parameter, or for what a tape changer returns, is a full path name to a non\-rewinding tape device, such as \fI/dev/nst0\fR or \fI/dev/rmt/0mn\fR or \fI/dev/nst0\&.1\fR or whatever conventions the operating system uses\&. \fBAmanda\fR provides additional application level drivers that support non\-traditional tape\-simulations or features\&. To access a specific output driver, set \fBtapedev\fR (or configure your changer to return) a string of the form \fBdriver\fR:\fBdriver\-info\fR where \fBdriver\fR is one of the supported drivers and \fBdriver\-info\fR is optional additional information needed by the driver\&.
424 The supported drivers are:
428 This is the default driver\&. The \fBdriver\-info\fR is the tape device name\&. Entering
432 is really a short hand for
434 tapedev tape:/dev/rmt/0mn
440 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 \fBAmanda\fR checks for and allows through regardless of what you have set in \fBlabelstr\fR\&. The \fBdriver\-info\fR field is not used and may be left blank:
448 The \fBlength\fR value from the associated \fBtapetype\fR is used to limit the amount of data written\&. When the limit is reached, the driver will simulate end of tape\&.
452 This driver should only be used for debugging and testing,
453 and probably only with the
461 \fBR\fRedundant \fBA\fRrray of \fBI\fRnexpensive (?) \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\&.
463 The \fBdriver\-info\fR field describes the devices to use\&. Curly braces indicate multiple replacements in the string\&. For instance:
467 tapedev rait:/dev/rmt/tps0d{4,5,6}n
471 would use the following devices:
473 \fI/dev/rmt/tps0d4n\fR \fI/dev/rmt/tps0d5n\fR \fI/dev/rmt/tps0d6n\fR
477 This driver emulates a tape device with a set of files in a directory\&. The \fBdriver\-info\fR field must be the name of an existing directory\&. The driver will test for a subdirectory of that named \fBdata\fR and return \fBoffline\fR until it is present\&. When present, the driver uses two files in the \fBdata\fR subdirectory for each tape file\&. One contains the actual data\&. The other contains record length information\&.
479 The driver uses a file named \fBstatus\fR in the \fBfile\fR 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\&.
481 The \fBlength\fR value from the associated \fBtapetype\fR is used to limit the amount of data written\&. When the limit is reached, the driver will simulate end of tape\&.
483 One way to use this driver with a real device such as a CD\-writer is to create a directory for the \fBfile\fR device and one or more other directories for the actual data\&. Create a symlink named \fBdata\fR in the \fBfile\fR directory to one of the data directories\&. Set the \fBtapetype\fR length to whatever the medium will hold\&.
485 When \fBAmanda\fR fills the \fBfile\fR 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\&.
487 To read the CD, mount it and create the \fBdata\fR symlink in the \fBfile\fR device directory\&.
492 \fBAmanda\fR processes on the tape server host run as the \fBdumpuser\fR user listed in \fBamanda\&.conf\fR\&. When they connect to a backup client, they do so with an \fBAmanda\fR\-specific protocol\&. They do not, for instance, use \fBrsh\fR or \fBssh\fR directly\&.
495 On the client side, the \fBamandad\fR daemon validates the connection using one of several methods, depending on how it was compiled and on options it is passed:
499 Even though \fBAmanda\fR does not use \fBrsh\fR, it can use \&.rhosts\-style authentication and a \&.rhosts file\&.
503 This is essentially the same as \&.rhosts authentication except a different file, with almost the same format, is used\&. This is the default mechanism built into \fBAmanda\fR\&.
505 The format of the \fI\&.amandahosts\fR file is:
507 \fBhostname\fR [ \fBusername\fR ]
509 If \fBusername\fR is ommitted, it defaults to the user running \fBamandad\fR, i\&.e\&. the user listed in the \fBinetd\fR or \fBxinetd\fR configuration file\&.
513 \fBAmanda\fR may use the Kerberos authentication system\&. Further information is in the \fBdocs/KERBEROS\fR file that comes with an \fBAmanda\fR distribution\&.
515 For Samba access, \fBAmanda\fR needs a file on the Samba server (which may or may not also be the tape server) named \fI/etc/amandapass\fR 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 \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:
519 //some\-pc/home normalpw
520 //another\-pc/disk otheruser%otherpw.fi
521 With clear text passwords, this file should obviously be tightly protected\&. It only needs to be readable by the \fBAmanda\fR\-user on the Samba server\&.
523 You can find further information in the \fBdocs/SAMBA\fR file that comes with an \fBAmanda\fR distribution\&.
525 .SH "HOST & DISK EXPRESSION"
528 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\&.
531 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\&.
535 \&. word separator for a host
536 / word separator for a disk
539 ? match exactly one character except the separator
540 * match zero or more characters except the separator
541 ** match zero or more characters including the separator
550 EXPRESSION WILL MATCH WILL NOT MATCH
552 hoSTA\&.dOMAIna\&.ORG
557 ho*na hoina ho\&.aina\&.org
560 ^hosta hosta foo\&.hosta\&.org
563 /opt/ opt (disk) opt (host)
564 \&.opt\&. opt (host) opt (disk)
572 .SH "DATESTAMP EXPRESSION"
575 A \fBdatestamp\fR expression is a range expression where we only match the prefix\&. Leading ^ is removed\&. Trailing $ forces an exact match\&.
576 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
583 James da Silva, <jds@amanda\&.org> : Original text
586 Stefan G\&. Weichinger, <sgw@amanda\&.org>, maintainer of the \fBAmanda\fR\-documentation: XML\-conversion, major update
591 \fBamadmin\fR(8), \fBamanda\&.conf\fR(5), \fBamcheck\fR(8), \fBamcheckdb\fR(8), \fBamcleanup\fR(8), \fBamdd\fR(8), \fBamdump\fR(8), \fBamfetchdump\fR(8) \fBamflush\fR(8), \fBamgetconf\fR(8), \fBamlabel\fR(8), \fBammt\fR(8), \fBamoverview\fR(8), \fBamplot\fR(8), \fBamrecover\fR(8), \fBamreport\fR(8), \fBamrestore\fR(8), \fBamrmtape\fR(8), \fBamstatus\fR(8), \fBamtape\fR(8), \fBamtapetype\fR(8), \fBamtoc\fR(8), \fBamverify\fR(8), \fBamverifyrun\fR(8)
projects / debian / amanda / blob