3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
8 .TH "AMANDA" "8" "05/14/2008" "" ""
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 \fBamcheckdump\fR [\fIoptions\fR] \fIconfig\fR
105 \fBamserverconfig\fR [\fIoptions\fR] \fIconfig\fR
109 \fBamaddclient\fR \fIconfig\fR [\fIoptions\fR]
115 is the "Advanced Maryland Automatic Network Disk Archiver"\. This manual page gives an overview of the
117 commands and configuration files for quick reference\.
121 commands\. Each one has its own manual page\. See them for all the gory details\.
125 Take care of automatic
127 backups\. This is normally executed by
129 on a computer called the
130 \fItape server host\fR
131 and requests backups of file systems located on
135 backs up all disks in the
137 file (discussed below) to tape or, if there is a problem, to a special
139 \fIdisk\fR\. After all backups are done,
141 sends mail reporting failures and successes\.
146 Flush backups from the holding disk to tape\.
150 has reported it could not write backups to tape for some reason\. When this happens, backups stay in the holding disk\. Run
152 after the tape problem is corrected to write backups from the holding disk to tape\.
157 Clean up after an interrupted
158 \fBamdump\fR\. This command is only needed if
160 was unable to complete for some reason, usually because the tape server host crashed while
167 Provides an interactive interface to browse the
169 index files (backup image catalogues) and select which tapes to recover files from\. It can also run
171 and a restore program (e\.g\.
172 \fBtar\fR) to actually recover the files\.
179 tape, searching for requested backups\.
181 is suitable for everything from interactive restores of single files to a full restore of all partitions on a failed disk\.
188 tape restoration, similar to
189 \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\.
196 format label onto a tape\. All
198 tapes must be labeled with
203 will not write to an unlabeled tape (see TAPE MANAGEMENT below)\.
208 Verify the correct tape is mounted and all file systems on all backup client systems are ready to be backed up\. Often run by
212 to generate a mail warning that backups might fail unless corrective action is taken\.
217 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\.
222 Take care of tape changer control operations like loading particular tapes, ejecting tapes and scanning the tape storage slots\.
227 Check the results of an
234 Program to setup initial
241 Program to add client to an existing
248 Delete a tape from the
255 Report the status of a running or completed
261 Display a chart of hosts and file systems backed up every run\.
266 Generate utilization plots of
268 runs for performance tuning\.
275 summary E\-mail report\.
280 Generate table of content files for
289 knows about is consistent in the database\.
294 Look up parameters in the
301 Generate a tapetype definition\.
306 Wrapper program from aespipe (data encryption utility)
311 Reference encryption program for Amanda symmetric data encryption
315 There are three user\-editable files that control the behavior of
319 \fBamanda\.conf\fR, the main configuration file\. It contains parameters to customize
321 for the site\. Refer to the
322 \fBamanda.conf\fR(5), manpage for details on
324 configuration parameters\.
328 file, which lists hosts and disk partitions to back up\.
332 file, which lists tapes that are currently active\. These files are described in more detail in the following sections\.
334 All files are stored in individual configuration directories under
335 \fI/usr/local/etc/amanda/\fR\. A site will often have more than one configuration\. For example, it might have a
337 configuration for everyday backups and an
339 configuration for infrequent full archival backups\. The configuration files would be stored under directories
340 \fI/usr/local/etc/amanda/normal/\fR
342 \fI/usr/local/etc/amanda/archive/\fR, respectively\. Part of the job of an
344 administrator is to create, populate and maintain these directories\.
346 All log and database files generated by
348 go in corresponding directories somewhere\. The exact location is controlled by entries in
349 \fBamanda\.conf\fR\. A typical location would be under
350 \fI/var/adm/amanda\fR\. For the above example, the files might go in
351 \fI/var/adm/amanda/normal/\fR
353 \fI/var/adm/amanda/archive/\fR\.
355 As log files are no longer needed (no longer contain relevant information),
357 cycles them out in various ways, depending on the type of file\.
359 Detailed information about
361 runs are stored in files named
362 \fBamdump\.\fR\fINN\fR
365 is a sequence number, with 1 being the most recent file\.
367 rotates these files each run, keeping roughly the last
369 (see below) worth of them\.
373 to generate the mail summary is named
374 \fBlog\.\fR\fIYYYYMMDD\.NN\fR
377 is the datestamp of the start of the
381 is a sequence number started at 0\. At the end of each
383 run, log files for runs whose tapes have been reused are renamed into a subdirectory of the main log directory (see the
385 parameter below) named
386 \fBoldlog\fR\. It is up to the
388 administrator to remove them from this directory when desired\.
390 Index (backup image catalogue) files older than the full dump matching the oldest backup image for a given client and disk are removed by
392 at the end of each run\.
397 file determines which disks will be backed up by
398 \fIAmanda\fR\. The file usually contains one line per disk:
402 \fIhostname diskname\fR [\fIdiskdevice\fR] \fIdumptype\fR [\fIspindle\fR [\fIinterface\fR] ]
407 \fIhostname diskname\fR
410 Lines starting with # are ignored, as are blank lines\. The fields have the following meanings:
414 The name of the host to be backed up\. If
416 refers to a PC share, this is the host
420 program on to back up the share\.
425 The name of the disk (a label)\. In most case, you set your
429 and you don\'t set the
431 If you want multiple entries with the same
432 \fBdiskdevice\fR, you must set a different
434 for each entry\. It\'s the
436 that you use on the commandline for any
438 command\. Look at the example/disklist file for example\.
443 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
446 \fIsd0a\fR, or a mount point such as
449 It may also refer to a PC share by starting the name with two (forward) slashes, e\.g\.
450 \fI//some\-pc/home\fR\. In this case, the
452 option in the associated
455 \fBGNUTAR\fR\. It is the combination of the double slash disk name and
459 that triggers the use of Samba\.
469 \fIDumptype\fRs specify backup related parameters, such as whether to compress the backups, whether to record backup results in
470 \fI/etc/dumpdates\fR, the disk\'s relative priority, etc\.
476 \fB\-1\fR\. A number used to balance backup load on a host\.
478 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\.
484 \fIlocal\fR\. The name of a network interface definition in the
486 file, used to balance network load\.
490 \fBdumptype\fR, it is possible to define one in\-line, enclosing
492 options within curly braces, one per line, just like a
495 \fBamanda\.conf\fR\. Since pre\-existing
496 \fBdumptype\fRs are valid option names, this syntax may be used to customize
497 \fBdumptype\fRs for particular disks\.
501 follow the left curly bracket\.
507 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:
511 \fIhostname diskname\fR [ \fIdiskdevice\fR ] {
514 } [ \fIspindle\fR [ \fIinterface\fR ] ]
517 .SH "TAPE MANAGEMENT"
521 file contains the list of tapes in active use\. This file is maintained entirely by
523 and should not be created or edited during normal operation\. It contains lines of the form:
533 is the date the tape was written,
535 is a label for the tape as written by
541 whether the tape may be reused, etc (see the
549 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
551 option) than there are runs in the backup cycle (see the
553 option) to prevent overwriting a backup image that would be needed to do a full recovery\.
556 The normal value for the
558 parameter, or for what a tape changer returns, is a full path name to a non\-rewinding tape device, such as
564 or whatever conventions the operating system uses\.
566 provides additional application level drivers that support non\-traditional tape\-simulations or features\. To access a specific output driver, set
568 (or configure your changer to return) a string of the form
569 \fIdriver\fR:\fIdriver\-info\fR
572 is one of the supported drivers and
574 is optional additional information needed by the driver\.
576 The supported drivers are:
580 This is the default driver\. The
582 is the tape device name\. Entering
590 is really a short hand for
594 tapedev tape:/dev/rmt/0mn
601 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
603 checks for and allows through regardless of what you have set in
606 field is not used and may be left blank:
617 value from the associated
619 is used to limit the amount of data written\. When the limit is reached, the driver will simulate end of tape\.
622 .nr an-no-space-flag 1
626 This driver should only be used for debugging and testing, and probably only with the
636 \fII\fRnexpensive (?)
637 \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\.
641 field describes the devices to use\. Curly braces indicate multiple replacements in the string\. For instance:
646 tapedev rait:/dev/rmt/tps0d{4,5,6}n
650 would use the following devices:
652 \fI/dev/rmt/tps0d4n\fR
653 \fI/dev/rmt/tps0d5n\fR
654 \fI/dev/rmt/tps0d6n\fR
659 This driver emulates a tape device with a set of files in a directory\. The
661 field must be the name of an existing directory\. The driver will test for a subdirectory of that named
665 until it is present\. When present, the driver uses two files in the
667 subdirectory for each tape file\. One contains the actual data\. The other contains record length information\.
669 The driver uses a file named
673 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\.
677 value from the associated
679 is used to limit the amount of data written\. When the limit is reached, the driver will simulate end of tape\.
681 One way to use this driver with a real device such as a CD\-writer is to create a directory for the
683 device and one or more other directories for the actual data\. Create a symlink named
687 directory to one of the data directories\. Set the
689 length to whatever the medium will hold\.
695 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\.
697 To read the CD, mount it and create the
706 processes on the tape server host run as the
709 \fBamanda\.conf\fR\. When they connect to a backup client, they do so with an
710 \fIAmanda\fR\-specific protocol\. They do not, for instance, use
716 On the client side, the
718 daemon validates the connection using one of several methods, depending on how it was compiled and on options it is passed:
725 \fBrsh\fR, it can use
726 \fB\.rhosts\fR\-style authentication and a
733 This is essentially the same as
735 authentication except a different file, with almost the same format, is used\. This is the default mechanism built into
751 is ommitted, it defaults to the user running
752 \fBamandad\fR, i\.e\. the user listed in the
760 is a list of the service the client is authorized to execute:
769 is a shortcut for "noop selfcheck sendsize sendbackup"
775 may use the Kerberos authentication system\. Further information is in the
777 file that comes with an
783 needs a file on the Samba server (which may or may not also be the tape server) named
784 \fI/etc/amandapass\fR
785 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
786 \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:
790 //some\-pc/home normalpw
791 //another\-pc/disk otheruser%otherpw
794 With clear text passwords, this file should obviously be tightly protected\. It only needs to be readable by the
795 \fIAmanda\fR\-user on the Samba server\.
797 You can find further information in the
799 file that comes with an
803 .SH "HOST & DISK EXPRESSION"
805 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\.
807 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\.
820 word separator for a host
825 word separator for a disk
840 match exactly one character except the separator
845 match zero or more characters except the separator
850 match zero or more characters including the separator
1011 .SH "DATESTAMP EXPRESSION"
1015 expression is a range expression where we only match the prefix\. Leading ^ is removed\. Trailing $ forces an exact match\.
1028 match all dates beginning with 20001212, 20001213 or 20001214
1038 match all dates between 20001212 and 20001224
1043 match all dates that start with 2000121 (20001210\-20001219)
1048 match all dates that start with 2 (20000101\-29991231)
1053 match all dates between 20000101\-20101231
1062 .SH "DUMP SPECIFICATIONS"
1064 A dump specification selects one or more dumps\. It has the form
1065 \fI[host][:disk][@datestamp]\fR, where each component is a pattern as described above\. If a component is missing, it is treated as a wildcard\. The characters \':\', \'@\', and \'\e\' may be escaped within any component by preceding them with a \'\e\'\.
1084 all dumps of client17
1089 All dumps on with datestamps matching 20080615
1094 All dumps of /var/www on host webserver
1097 webserver:/var/www@200806150317
1099 The dump of webserver with datestamp 200806150317
1104 All dumps of /var/www on any host
1108 .SH "CONFIGURATION OVERRIDE"
1110 Most commands allow the override of specific configuration options on the command line, using the
1112 option\. This option has the form
1113 \-o\fIname\fR=\fIvalue\fR\. An optional space is allowed after the
1114 \-o\. Each configuration option should be specified in a separate command\-line option\.
1118 is simply the name of the option, e\.g\.,
1122 amdump \-oruntapes=2
1126 For options in a named section of the configuration,
1129 \fISECTION\fR:\fIsection_name\fR:\fIname\fR, where
1131 is one of TAPETYPE, DUMPTYPE, HOLDINGDISK, or INTERFACE, and
1133 is the name of the tapetype, dumptype, holdingdisk, or interface\. Examples:
1137 amdump \-o TAPETYPE:HP\-DAT:length=2000m
1138 amdump \-o DUMPTYPE:no\-compress:compress="server fast"
1139 amdump \-o HOLDINGDISK:hd1:use="\-100 mb"
1140 amdump \-o INTERFACE:local:use="2000 kbps"
1144 Note that configuration overrides are not effective for tape changers, which supply a tapedev based on their own configuration\. In order to override
1145 \fItapedev\fR, you must also disable any changer:
1149 amdump \-otapedev=/dev/nst1 \-otpchanger=\'\'
1159 Stefan G\. Weichinger,
1160 <sgw@amanda\.org>, maintainer of the
1161 \fIAmanda\fR\-documentation: XML\-conversion, major update
1166 \fBamanda.conf\fR(5),
1167 \fBamanda-client.conf\fR(5),
1173 \fBamfetchdump\fR(8)
1178 \fBamoverview\fR(8),
1186 \fBamtapetype\fR(8),
1188 \fBamcheckdump\fR(8),
1189 \fBamserverconfig\fR(8),
1190 \fBamaddclient\fR(8),
1191 \fI\%http://wiki.zmanda.com\fR
projects / debian / amanda / blob