11 \fB\\$1\fP \\$2 \fI\\$3\fP \\$4 \fI\\$5\fP \\$6 "\fI\\$7\fP" \\$8
15 amanda \- Advanced Maryland Automatic Network Disk Archiver
125 Amanda is the "Advanced Maryland Automatic Network Disk Archiver".
126 This manual page gives an overview of the Amanda commands and
127 configuration files for quick reference.
129 Here are all the Amanda commands.
130 Each one has its own manual page.
131 See them for all the gory details.
134 Take care of automatic Amanda backups.
135 This is normally executed by
137 on a computer called the
139 and requests backups of file systems located on
143 backs up all disks in the
145 file (discussed below) to tape or, if there is a problem, to a special
148 After all backups are done,
150 sends mail reporting failures and successes.
153 Flush backups from the holding disk to tape.
157 has reported it could not write backups to tape for some reason.
158 When this happens, backups stay in the holding disk.
161 after the tape problem is corrected
162 to write backups from the holding disk to tape.
165 Clean up after an interrupted
167 This command is only needed if
169 was unable to complete for some reason, usually because the
170 tape server host crashed while
175 Provides an interactive interface to browse the Amanda index files
176 (backup image catalogues)
177 and select which tapes to recover files from.
180 and a restore program (e.g.\&
182 to actually recover the files.
185 Read an Amanda tape, searching for requested backups.
187 is suitable for everything from interactive restores of single files
188 to a full restore of all partitions on a failed disk.
191 Write an Amanda format label onto a tape.
192 All Amanda tapes must be labeled with
197 will not write to an unlabeled tape (see TAPE MANAGEMENT below).
200 Verify the correct tape is mounted
201 and all file systems on all backup client systems
202 are ready to be backed up.
207 to generate a mail warning that backups might fail
208 unless corrective action is taken.
211 Take care of administrative tasks like finding out which
212 tapes are needed to restore a filesystem,
213 forcing hosts to do full backups of selected disks
214 and looking at schedule balance information.
217 Take care of tape changer control operations like loading particular tapes,
219 and scanning the tape storage slots.
222 Check Amanda backup tapes for errors.
225 Delete a tape from the Amanda databases.
228 Report the status of a running or completed
232 Display a chart of hosts and file systems backed up every run.
235 Generate utilization plots of Amanda runs for performance tuning.
238 Generate an Amanda summary E-mail report.
241 Generate table of content files for Amanda tapes.
244 Verify every tape Amanda knows about is consistent in the database.
247 Look up parameters in the Amanda configuration file.
249 There are three user\-editable files that control the behavior of Amanda.
252 the main configuration file.
253 It contains parameters to customize Amanda for the site.
256 file, which lists hosts and disk partitions to back up.
259 file, which lists tapes that are currently active.
260 These files are described in more detail in the following sections.
262 All files are stored in individual configuration
263 directories under @CONFIG_DIR@.
264 A site will often have more than
266 For example, it might have a
268 configuration for everyday backups and an
270 configuration for infrequent full archival backups.
271 The configuration files would be stored under directories
272 @CONFIG_DIR@/normal/ and
273 @CONFIG_DIR@/archive/, respectively.
274 Part of the job of an Amanda administrator is to create,
275 populate and maintain these directories.
277 All log and database files generated by Amanda go in corresponding
278 directories somewhere.
279 The exact location is controlled by entries in
281 A typical location would be under /var/adm/amanda.
282 For the above example, the files might go in
283 /var/adm/amanda/normal/ and /var/adm/amanda/archive/.
285 As log files are no longer needed (no longer contain relevant information),
286 Amanda cycles them out in various ways, depending on the type of file.
288 Detailed information about
290 runs are stored in files named
294 is a sequence number, with 1 being the most recent file.
296 rotates these files each run, keeping roughly the last
303 to generate the mail summary is named
307 is the datestamp of the start of the
311 is a sequence number started at 0.
315 log files for runs whose tapes have been reused are renamed
316 into a subdirectory of the main log directory (see the
321 It is up to the Amanda administrator to remove them from this
322 directory when desired.
324 Index (backup image catalogue) files older than the full dump
325 matching the oldest backup image for a given client and disk
328 at the end of each run.
329 .SH CONFIG FILE PARAMETERS
331 \fB\\$1\fP\ \fI"\\$2"\fP
334 \fB\\$1\fP\ \fI\\$2\fP
336 There are a number of configuration parameters that control the
337 behavior of the Amanda programs.
338 All have default values,
339 so you need not specify the parameter in
341 if the default is suitable.
343 Lines starting with # are ignored, as are blank lines.
344 Comments may be placed on a line with a directive by starting
345 the comment with a #.
346 The remainder of the line is ignored.
348 Keywords are case insensitive, i.e.\&
352 are treated the same.
354 Integer arguments may have one of the following (case insensitive) suffixes,
355 some of which have a multiplier effect:
359 Some number of bytes.
362 Some number of bytes per second.
364 .B "k kb kbyte kbytes kilobyte kilobytes"
365 Some number of kilobytes (bytes*1024).
368 Some number of kilobytes per second (bytes*1024).
370 .B "m mb meg mbyte mbytes megabyte megabytes"
371 Some number of megabytes (bytes*1024*1024).
374 Some number of megabytes per second (bytes*1024*1024).
376 .B "g gb gbyte gbytes gigabyte gigabytes"
377 Some number of gigabytes (bytes*1024*1024*1024).
380 Some number of tapes.
386 Some number of weeks (days*7).
391 may be used in most places where an integer is expected
392 to mean an infinite amount.
394 Boolean arguments may have any of the values
401 to indicate a true state, or
408 to indicate a false state.
409 If no argument is given,
416 .IR @DEFAULT_CONFIG@ .
417 A descriptive name for the configuration.
418 This string appears in the Subject line of mail reports.
419 Each Amanda configuration should have a different string to keep
420 mail reports distinct.
425 A space separated list of recipients for mail reports.
430 The number of days in the backup cycle.
431 Each disk will get a full backup at least this often.
432 Setting this to zero tries to do a full backup each run.
434 Note that this parameter may also be set in a specific
437 This value sets the default for all
447 .IR "same as dumpcycle" .
448 The number of amdump runs in
451 A value of 0 means the same value as
453 A value of -1 means guess the number of runs from the
456 which is the number of tapes used in the last
464 The mininum number of tapes in the active tape cycle.
465 You can have more tapes in your active tape cycle.
466 It means that you must write at least
472 is not in the active tape cycle.
474 Amanda will accept any tape for writting if it is not in the last
478 This must be at least one larger than the
479 number of Amanda runs done during a dump cycle
483 times the number of tapes used per run
491 one Amanda run is done every day (Sunday through Saturday),
497 must be at least 15 (14 days * one run/day * one tape/run + one tape).
499 In practice, there should be several extra tapes
500 to allow for schedule adjustments or disaster recovery.
505 The login name Amanda uses to run the backups.
506 The backup client hosts must allow access
507 from the tape server host as this user via
511 depending on how the Amanda software was built.
514 Printer to use when doing tape labels.
522 .IR @DEFAULT_TAPE_DEVICE@ .
523 The path name of the non-rewinding tape device.
524 Non-rewinding tape device names often have an 'n' in the name,
527 however this is operating system specific and you should consult
528 that documentation for detailed naming information.
530 If a tape changer is configured
533 option), this option might not be used.
537 output driver is selected
540 section later for more information),
543 will run normally but all images will be thrown away.
544 This should only be used for debugging and testing,
545 and probably only with the
550 .BS rawtapedev string
552 .IR @DEFAULT_RAW_TAPE_DEVICE@ .
553 The path name of the raw tape device.
554 This is only used if Amanda is compiled for Linux machines with floppy tapes
555 and is needed for QIC volume table operations.
560 The name of the tape changer.
561 If a tape changer is not configured, this option is not used
562 and should be commented out of the configuration file.
564 If a tape changer is configured, choose one of the changer scripts
569 .BS changerdev string
571 .IR @DEFAULT_CHANGER_DEVICE@ .
572 A tape changer configuration parameter.
573 Usage depends on the particular changer defined with the
577 .BS changerfile string
579 .IR /usr/adm/amanda/log/changer\-status .
580 A tape changer configuration parameter.
581 Usage depends on the particular changer defined with the
588 The maximum number of tapes used in a single run.
589 If a tape changer is not configured, this option is not used
590 and should be commented out of the configuration file.
592 If a tape changer is configured, this may be set larger than one to
593 let Amanda write to more than one tape.
595 Note that this is an upper bound on the number of tapes,
596 and Amanda may use less.
598 Also note that as of this release, Amanda does not support true tape overflow.
599 When it reaches the end of one tape,
600 the backup image Amanda was processing starts over again on the next tape.
604 .IR runtapes * tape_length .
605 Maximum number of bytes the planner will schedule for a run.
607 .BN taperalgo [first|firstfit|largest|largestfit|smallest|last]
610 The algorithm use to choose which dump image to send to the taper.
617 The first dump image that will fit on the current tape.
620 The largest dump image.
623 The largest dump image that will fit on the current tape.
626 The smallest dump image.
635 The tape label constraint regular expression.
639 and used by this configuration must match the regular expression.
640 If multiple configurations are run from the same tape server host,
641 it is helpful to set their labels to different strings
642 (for example, "DAILY[0\-9][0\-9]*" vs.\& "ARCHIVE[0\-9][0\-9]*")
643 to avoid overwriting each other's tapes.
648 The type of tape drive associated with
652 This refers to one of the defined
654 in the config file (see below),
655 which specify various tape parameters,
661 of the tape media and device.
666 Maximum amount of time that
668 will wait for each client host.
673 Amount of idle time per disk on a given client that a
677 will wait before it fails with a data timeout error.
682 Amount of time per disk on a given client that the
686 will wait to get the dump size estimates.
687 For instance, with the default of 300 seconds and four disks on client A,
689 will wait up to 20 minutes for that machine.
690 A negative value will be interpreted as a total amount of time to wait
691 per client instead of per disk.
696 The maximum network bandwidth allocated to Amanda, in Kbytes per second.
704 The maximum number of backups that Amanda will attempt to run in parallel.
705 Amanda will stay within the constraints of network bandwidth and
706 holding disk space available, so it doesn't hurt to set
707 this number a bit high.
708 Some contention can occur with larger numbers
709 of backups, but this effect is relatively small on most systems.
714 The priority order of each dumper:
722 b: smallest bandwidth
731 The maximum number of backups from a single host that Amanda will
732 attempt to run in parallel.
737 Note that this parameter may also be set in a specific
740 This value sets the default for all
751 The minimum savings required to trigger an automatic
752 bump from one incremental level to the next.
753 If Amanda determines that the next higher backup level
754 will be this much smaller than the current level,
755 it will do the next level.
763 The bump size multiplier.
766 by this factor for each level.
767 This prevents active filesystems from
768 bumping too much by making it harder to bump to the next level.
769 For example, with the default
773 set to 2.0, the bump threshold will be 10 Mbytes for level one, 20
774 Mbytes for level two, 40 Mbytes for level three, and so on.
779 To insure redundancy in the dumps, Amanda keeps filesystems at the
780 same incremental level for at least
782 days, even if the other bump threshold criteria are met.
787 The file name for the
789 file holding client hosts, disks and other client dumping information.
793 .IR /usr/adm/amanda/curinfo .
794 The file or directory name for the historical information database.
795 If Amanda was configured to use DBM databases, this is the base file
797 If it was configured to use text formated databases (the default),
798 this is the base directory and within here will be a directory per
799 client, then a directory per disk, then a text file of data.
803 .IR /usr/adm/amanda .
804 The directory for the
812 .IR /usr/adm/amanda/index .
813 The directory where index files (backup image catalogues) are stored.
815 only generated for filesystems whose
824 The file name for the active
827 Amanda maintains this file with information about the active set of tapes.
832 The number of buffers used by the
839 is read from the network or disk before it is written to tape.
840 Each buffer is a little larger than 32 KBytes and is held in
841 a shared memory region.
846 The amount of holding-disk space that should not be used for full
847 backups if no tape is available.
848 By default, when there is no tape to write to,
849 degraded mode (incremental) backups will be performed to the holding disk.
850 If full backups should also be allowed in this case,
851 the amount of holding disk space reserved for incrementals should be lowered.
856 Whether an amdump run will flush the dump already on holding disk to tape.
858 .BN amrecover_do_fsf bool
861 Amrecover will call amrestore with the -f flag for faster positioning of the tape.
863 .BN amrecover_check_label bool
866 Amrecover will call amrestore with the -l flag to check the label.
868 .BS amrecover_changer string
870 Amrecover will use the changer if you use 'settape <STRING>' and that string
871 is the same as the amrecover_changer setting.
873 .BS columnspec string
874 Defines the width of columns
878 is a comma (',') separated list of triples.
880 of three parts which are separated by a equal sign ('=') and a colon
881 (':') (see the example).
882 These three parts specify:
885 the name of the column, which may be:
889 Compress (compression ratio)
890 Disk (client disk name)
891 DumpRate (dump rate in KBytes/sec)
892 DumpTime (total dump time in hours:minutes)
893 HostName (client host name)
895 OrigKB (original image size in KBytes)
896 OutKB (output image size in KBytes)
897 TapeRate (tape writing rate in KBytes/sec)
898 TapeTime (total tape time in hours:minutes)
902 the amount of space to display before the column (used to get whitespace
905 the width of the column itself.
906 If set to a negative value,
907 the width will be calculated on demand to fit the largest entry in
915 columnspec "Disk=1:18,HostName=0:10,OutKB=1:7"
918 The above will display the disk information in 18 characters
919 and put one space before it.
920 The hostname column will be 10 characters wide with
921 no space to the left.
922 The output KBytes column is seven characters wide
923 with one space before it.
926 .BS includefile string
929 The name of an amanda configuration file to include within
931 Useful for sharing dumptypes, tapetypes and
932 interface definitions among several configurations.
933 .SH "HOLDINGDISK SECTION"
936 file may define one or more holding disks used as buffers to hold
937 backup images before they are written to tape.
942 holdingdisk \fIname\fP {
943 \fIholdingdisk\-option\fP \fIholdingdisk\-value\fP
950 is a logical name for this holding disk.
952 The options and values are:
958 A comment string describing this holding disk.
963 The path to this holding area.
968 Amount of space that can be used in this holding disk area.
969 If the value is zero, all available space on the file system is used.
970 If the value is negative,
971 Amanda will use all available space minus that value.
976 Holding disk chunk size.
977 Dumps larger than the specified size will be stored in multiple
979 The size of each chunk will not exceed the
981 However, even though dump images are split in the
982 holding disk, they are concatenated as they are written to tape, so
983 each dump image still corresponds to a single continuous tape section.
985 If 0 is specified, Amanda will create holding disk chunks as large as
986 ((INT_MAX/1024)-64) Kbytes.
988 Each holding disk chunk includes a 32 Kbyte header, so the minimum
989 chunk size is 64 Kbytes (but that would be really silly).
991 Operating systems that are limited to a maximum file size of 2 Gbytes
992 actually cannot handle files that large.
993 They must be at least one byte less than 2 Gbytes.
994 Since Amanda works with 32 Kbyte blocks, and
995 to handle the final read at the end of the chunk, the chunk size
996 should be at least 64 Kbytes (2 * 32 Kbytes) smaller than the maximum
997 file size, e.g.\& 2047 Mbytes.
998 .SH "DUMPTYPE SECTION"
1001 file may define multiple sets of backup options and
1002 refer to them by name from the
1005 For instance, one set of options might be defined for file systems
1006 that can benefit from high compression,
1007 another set that does not compress well,
1008 another set for file systems that should always get a full backup
1011 A set of backup options are entered in a
1013 section, which looks like this:
1017 define dumptype \fIname\fP {
1018 \fIdumptype\-option\fP \fIdumptype\-value\fP
1025 is the name of this set of backup options.
1026 It is referenced from the
1030 Some of the options in a
1032 section are the same as those in the main part of
1034 The main option value is used to set the default for all
1037 For instance, setting
1039 to 50 in the main part of the config file causes all following
1041 sections to start with that value,
1042 but the value may be changed on a section by section basis.
1043 Changes to variables in the main part of the config file must be
1044 done before (earlier in the file) any
1048 The dumptype options and values are:
1054 Type of authorization to perform between tape server and backup client hosts.
1057 to use Kerberos\-IV authorization.
1062 A comment string describing this set of backup options.
1064 \fBcomprate\fP \fIfloat\fP [, \fIfloat\fP ]
1068 The expected full and incremental compression factor for dumps.
1069 It is only used if Amanda does not have any history information on
1070 compression rates for a filesystem, so should not usually need to
1072 However, it may be useful for the first time a
1073 very large filesystem that compresses very little is backed up.
1075 .BS "compress [client|server]" string
1078 If Amanda does compression of the backup images,
1079 it can do so either on the backup client host before it crosses the network
1080 or on the tape server host as it goes from the
1081 network into the holding disk or to tape.
1082 Which place to do compression (if at all) depends on how well the
1083 dump image usually compresses, the speed and load on the client or
1084 server, network capacity, holding disk capacity,
1085 availability of tape hardware compression, etc.
1087 For either type of compression, Amanda also allows the selection
1088 of two styles of compression.
1090 is the best compression available, often at the expense of CPU overhead.
1092 is often not as good a compression as
1094 but usually less CPU overhead.
1098 options line may be one of:
1104 compress [client] fast
1105 compress [client] best
1106 compress server fast
1107 compress server best
1112 Note that some tape devices do compression and this option has nothing
1113 to do with whether that is used.
1114 If hardware compression is used (usually via a particular tape device name
1118 Amanda (software) compression should be disabled.
1123 The number of days in the backup cycle.
1124 Each disk using this set of options
1125 will get a full backup at least this often.
1126 Setting this to zero tries to do a full backup each run.
1128 .P1 exclude [ list|file ][[optional][ append ][ "string" ]+]
1131 There is two exclude list
1139 is a gnutar exclude expression. With
1143 is a file name on the client containing gnutar exclude expression.
1145 All exclude expression are concatenated in one file and passed to gnutar as a
1146 .B \-\-exclude\-from
1153 are appended to the current value of the list, without it, the
1161 then amcheck will not complain if the file doesn't exist or is not readable.
1165 If the file name is relative,
1166 the disk name being backed up is prepended.
1167 So if this is entered:
1170 exclude list ".amanda.excludes"
1173 the actual file use would be
1174 .I /var/.amanda.excludes
1177 .I /usr/local/.amanda.excludes
1182 .BS holdingdisk boolean
1185 Whether a holding disk should be used for these backups or whether
1186 they should go directly to tape.
1187 If the holding disk is a portion of another file system that Amanda
1188 is backing up, that file system should refer to a dumptype with
1192 to avoid backing up the holding disk into itself.
1197 Whether disks associated with this backup type should be backed up or not.
1198 This option is useful when the
1200 file is shared among several configurations,
1201 some of which should not back up all the listed file systems.
1203 .P1 include [ list|file ][[optional][ append ][ "string" ]+]
1207 There is two include list
1215 is a glob expression. With
1219 is a file name on the client containing glob expression.
1221 All include expression are expanded by amanda and concatenated in one file and passed to gnutar as a
1223 argument. They must start with "./" and containing no other "/".
1229 are appended to the current value of the list, without it, the
1237 then amcheck will not complain if the file doesn't exist or is not readable.
1241 If the file name is relative,
1242 the disk name being backed up is prepended.
1247 Whether an index (catalogue) of the backup should be generated and
1250 These catalogues are used by the
1254 .BS kencrypt boolean
1257 Whether the backup image should be encrypted by Kerberos as it is sent
1258 across the network from the backup client host to the tape server host.
1263 The maximum number of backups from a single host that Amanda will
1264 attempt to run in parallel.
1265 See also the main section
1269 .BS maxpromoteday int
1272 The Maximum number of day for a promotion, set it 0 if you don't want
1273 promotion, set it to 1 or 2 if your disk get overpromoted.
1278 When there is no tape to write to, Amanda will do incremental backups
1279 in priority order to the holding disk.
1284 or a number of your choice.
1289 The type of backup to perform.
1292 for the native operating system backup program, and
1294 to use GNU tar or to do Samba PC backups.
1299 Whether to ask the backup program to update its
1303 .IR @GNUTAR_LISTED_INCREMENTAL_DIRX@
1304 for GNUTAR) of time stamps.
1305 This is normally enabled for daily backups and turned off
1306 for periodic archival runs.
1308 .BS skip\-full boolean
1315 has scheduled a full backup, these disks will be skipped, and
1316 full backups should be run off-line on these days.
1317 It was reported that
1318 Amanda only schedules level 1 incrementals in this configuration; this
1321 .BS skip\-incr boolean
1328 has scheduled an incremental backup, these disks will be skipped.
1333 Backups will not start until after this time of day.
1334 The value should be hh*100+mm, e.g.\& 6:30PM (18:30) would be entered as
1340 Strategy to use when planning what level of backup to run next.
1346 The standard Amanda schedule.
1349 Never do full backups, only level 1 incrementals.
1352 Never do incremental backups, only full dumps.
1355 Never do backups (useful when sharing the
1360 Only do incremental dumps.
1361 `amadmin force' should be used to tell
1362 Amanda that a full dump has been performed off-line, so that it resets
1364 It is similar to skip-full, but with incronly
1365 full dumps may be scheduled manually.
1366 Unfortunately, it appears that Amanda
1367 will perform full backups with this configuration, which is probably a
1373 entries are predefined by Amanda:
1377 define dumptype no-compress {
1380 define dumptype compress-fast {
1381 compress client fast
1383 define dumptype compress-best {
1384 compress client best
1386 define dumptype srvcompress {
1387 compress server fast
1389 define dumptype bsd-auth {
1392 define dumptype krb4-auth {
1395 define dumptype no-record {
1398 define dumptype no-hold {
1401 define dumptype no-full {
1407 In addition to options in a
1409 section, one or more other
1411 names may be entered, which make this
1413 inherit options from other
1416 For instance, two sections might be the same except for the
1422 define dumptype normal {
1423 comment "Normal backup, no compression, do indexing"
1428 define dumptype testing {
1429 comment "Test backup, no compression, do indexing, no recording"
1445 This provides an easy place to make changes that will affect
1448 .SH "TAPETYPE SECTION"
1451 file may define multiple types of tape media and devices.
1452 The information is entered in a
1454 section, which looks like this in the config file:
1458 define tapetype \fIname\fP {
1459 \fItapetype\-option\fP \fItapetype\-value\fP
1466 is the name of this type of tape medium/device.
1467 It is referenced from the
1469 option in the main part of the config file.
1471 The tapetype options and values are:
1476 A comment string describing this set of tape information.
1481 How large a file mark (tape mark) is, measured in bytes.
1482 If the size is only known in some linear measurement (e.g.\& inches),
1483 convert it to bytes using the device density.
1488 How much data will fit on a tape.
1490 Note that this value is only used by Amanda to schedule which backups
1492 Once the backups start, Amanda will continue to write to a tape until
1493 it gets an error, regardless of what value is entered for
1497 section later for exceptions).
1502 How much data will be written in each tape record.
1503 The minimum blocksize value is 32 KBytes.
1504 The maximum blocksize value is @MAXTAPEBLOCKSIZE@ KBytes.
1505 The maximum is set during configure with --with-maxtapeblocksize.
1507 .BS file-pad boolean
1510 If true, every record, including the last one in the
1511 file, will have the same length.
1512 This matches the way Amanda wrote tapes prior to the availability
1514 It may also be useful on devices that only support a fixed blocksize.
1516 Note that the last record on the tape probably includes trailing
1517 null byte padding, which will be passed back to
1520 or the restore program.
1521 Most programs just ignore this (although possibly with a warning).
1523 If this parameter is false, the last record in a file may be shorter
1524 than the block size.
1525 The file will contain the same amount of data the dump program generated,
1526 without trailing null byte padding.
1527 When read, the same amount of data that was written will be returned.
1532 How fast the drive will accept data, in bytes per second.
1533 This parameter is not currently used by Amanda.
1535 .BS lbl-templ string
1536 A PostScript template file used by
1539 Several sample files are provided with the Amanda sources in the
1544 man page for more information.
1546 In addition to options, another
1548 name may be entered, which makes this
1550 inherit options from another
1552 For instance, the only difference between a DLT4000 tape drive using
1553 Compact\-III tapes and one using Compact\-IV tapes is the length of
1555 So they could be entered as:
1559 define tapetype DLT4000\-III {
1560 comment "DLT4000 tape drives with Compact\-III tapes"
1561 length 12500 mbytes # 10 Gig tapes with some compression
1562 filemark 2000 kbytes
1565 define tapetype DLT4000\-IV {
1567 comment "DLT4000 tape drives with Compact\-IV tapes"
1568 length 25000 mbytes # 20 Gig tapes with some compression
1572 .SH "INTERFACE SECTION"
1575 file may define multiple types of network interfaces.
1576 The information is entered in an
1578 section, which looks like this:
1582 define interface \fIname\fP {
1583 \fIinterface\-option\fP \fIinterface\-value\fP
1590 is the name of this type of network interface.
1591 It is referenced from the
1595 Note that these sections define network interface characteristics,
1596 not the actual interface that will be used.
1597 Nor do they impose limits on the bandwidth that will actually be
1599 Amanda computes the estimated bandwidth each file system backup will take
1600 based on the estimated size and time,
1601 then compares that plus any other running
1602 backups with the limit as another of the criteria when deciding whether
1603 to start the backup.
1604 Once a backup starts, Amanda will use as much of the network as it can
1605 leaving throttling up to the operating system and network hardware.
1607 The interface options and values are:
1612 A comment string describing this set of network information.
1617 The speed of the interface in Kbytes per second.
1619 In addition to options, another
1621 name may be entered, which makes this
1623 inherit options from another
1625 At the moment, this is of little use.
1629 file determines which disks will be backed up by Amanda.
1630 The file usually contains one line per disk:
1633 .I hostname diskname
1646 .B hostname diskname
1649 Lines starting with # are ignored, as are blank lines.
1650 The fields have the following meanings:
1653 The name of the host to be backed up.
1656 refers to a PC share, this is the host Amanda will
1659 program on to back up the share.
1662 The name of the disk (a label).
1663 In most case, you set your
1667 and you don't set the
1669 If you want multiple entry with the same
1671 you must set a different
1673 for each entry. It's the
1675 that you use on command line for any amanda command.
1676 Look at the example/disklist file for example.
1679 Default: same as diskname.
1680 The name of the disk device to be backed up.
1681 It may be a full device name,
1682 a device name without the
1686 or a mount point such as
1689 It may also refer to a PC share by starting the name with two (forward)
1691 .IR //some-pc/home .
1694 option in the associated
1698 It is the combination of the double slash disk name and
1702 that triggers the use of Samba.
1711 specify backup related parameters,
1712 such as whether to compress the backups,
1713 whether to record backup results in
1714 .IR /etc/dumpdates ,
1715 the disk's relative priority,
1721 A number used to balance backup load on a host.
1722 Amanda will not run multiple backups at the same time
1723 on the same spindle, unless the spindle number is -1,
1724 which means there is no spindle restriction.
1729 The name of a network interface definition in the
1731 file, used to balance network load.
1735 it is possible to define one in-line, enclosing
1737 options within curly braces, one per line, just like a
1743 are valid option names, this syntax may be used to customize
1745 for particular disks.
1749 follow the left curly bracket.
1755 is used for most disks, but use of the holding disk needs to be disabled
1756 for the file system that holds it, this would work instead of defining
1760 \fIhostname diskname\fP [ \fIdiskdevice\fP ] {
1763 } [ \fIspindle\fP [ \fIinterface\fP ] ]
1767 .SH "TAPE MANAGEMENT"
1770 file contains the list of tapes in active use.
1771 This file is maintained entirely by Amanda and should not be created
1772 or edited during normal operation.
1773 It contains lines of the form:
1776 .I YYYYMMDD label flags
1781 is the date the tape was written,
1783 is a label for the tape as written by
1787 tell Amanda whether the tape may be reused, etc (see
1796 will refuse to write to an unlabeled tape,
1797 or to a labeled tape that is considered active.
1798 There must be more tapes in active rotation
1802 than there are runs in the backup cycle
1806 to prevent overwriting a backup image that would be needed to
1808 .SH "OUTPUT DRIVERS"
1809 The normal value for the
1812 or for what a tape changer returns,
1813 is a full path name to a non-rewinding tape device,
1820 or whatever conventions the operating system uses.
1821 Amanda provides additional application level drivers that
1822 support non-tradition tape simulatation or features.
1823 To access a specific output driver, set
1825 (or configure your changer to return)
1826 a string of the form
1827 .I driver\fR:\fIdriver-info
1830 is one of the supported drivers and
1832 is optional additional information needed by the driver.
1834 The supported drivers are:
1837 This is the default driver.
1840 is the tape device name.
1843 is really a short hand for
1844 .IR tape:/dev/rmt/0mn .
1847 This driver throws away anything written to it and returns EOF
1848 for any reads except a special case is made for reading a label,
1849 in which case a "fake" value is returned that Amanda checks for
1850 and allows through regardless of what you have set in
1854 field is not used and may be left blank:
1862 value from the associated
1864 is used to limit the amount of data written.
1865 When the limit is reached, the driver will simulate end of tape.
1867 NOTE: this driver should only be used for debugging and testing,
1868 and probably only with the
1877 \fII\fRnexpensive (?)
1879 Reads and writes tapes mounted on multiple drives by spreading
1880 the data across N-1 drives and using the last drive for a checksum.
1881 See docs/RAIT for more information.
1885 field describes the devices to use.
1886 Curly braces indicate multiple replacements in the string.
1890 .BS tapedev rait:/dev/rmt/tps0d{4,5,6}n
1893 would use the following devices:
1904 This driver emulates a tape device with a set of files in a directory.
1907 field must be the name of an existing directory.
1908 The driver will test for a subdirectory of that named
1912 until it is present.
1913 When present, the driver uses two files in the
1915 subdirectory for each tape file.
1916 One contains the actual data.
1917 The other contains record length information.
1919 The driver uses a file named
1923 device directory to hold driver status information,
1924 such as tape position.
1925 If not present, the driver will create it as though the device is rewound.
1929 value from the associated
1931 is used to limit the amount of data written.
1932 When the limit is reached, the driver will simulate end of tape.
1934 One way to use this driver with a real device such as a CD is to
1935 create a directory for the
1937 device and one or more other directories
1938 for the actual data.
1939 Create a symlink named
1943 directory to one of the data directories.
1946 length to whatever the medium will hold.
1948 When Amanda fills the
1951 remove the symlink and (optionally) create a new symlink to another
1953 Use a CD writer software package to burn the image from the first data area.
1956 mount it and create the
1962 Amanda processes on the tape server host run as the
1966 When they connect to a backup client, they do so with an Amanda-specific
1968 They do not, for instance, use
1974 On the client side, the
1976 daemon validates the connection using one of several methods,
1977 depending on how it was compiled and on options it is passed:
1980 Even though Amanda does not use
1984 authentication and a
1988 This is essentially the same as
1990 authentication except a different file, with almost the same format, is used.
1991 This is the default mechanism built into Amanda.
2006 is ommitted, it defaults to the user running
2008 i.e. the user listed in the
2014 Amanda may use the Kerberos authentication system.
2015 Further information is in the
2017 file that comes with an Amanda distribution.
2020 Amanda needs a file on the Samba server (which may
2021 or may not also be the tape server) named
2023 with share names, (clear text) passwords and (optional) domain names,
2024 in that order, one per line, whitespace separated.
2025 By default, the user used to connect to the PC is the same for all
2026 PC's and is compiled into Amanda.
2027 It may be changed on a host by host basis
2028 by listing it first in the password field followed
2029 by a percent sign and then the password.
2033 //some-pc/home normalpw
2034 //another-pc/disk otheruser%otherpw
2037 With clear text passwords, this file should obviously be tightly protected.
2038 It only needs to be readable by the Amanda user on the Samba server.
2040 Further information is in the
2042 file that comes with an Amanda distribution.
2043 .SH HOST & DISK EXPRESSION
2044 All host and disk arguments to programs are special expression.
2045 The command apply to all disk that match your arguments.
2046 This section describe the matcher.
2048 The matcher match by word, each word is a glob expression, word
2049 are separated by the separator '.' for host and '/' for disk. You
2050 can anchor the expression at left with a '^'. You can
2051 anchor the expression at right with a '$'. The matcher
2052 is case insensitive for host but is case sensitive for disk. A match
2053 succeed if all word in your expression match contiguous word in
2057 . word separator for a host
2058 / word separator for a disk
2061 ? match exactly one character except the separator
2062 * match zero or more characters except the separator
2063 ** match zero or more characters including the separator
2070 EXPRESSION WILL MATCH WILL NOT MATCH
2077 ho*na hoina ho.aina.org
2080 ^hosta hosta foo.hosta.org
2083 /opt/ opt (disk) opt (host)
2084 .opt. opt (host) opt (disk)
2091 .SH DATESTAMP EXPRESSION
2094 expression is a range expression where we only match the prefix.
2095 Leading ^ is removed. Trailing $ force an exact match.
2098 20001212-14 match all dates beginning with 20001212, 20001213 or 20001214
2099 20001212-4 same as previous
2100 20001212-24 match all dates between 20001212 and 20001224
2101 2000121 match all dates that start with 2000121 (20001210-20001219)
2102 2 match all dates that start with 2 (20000101-29991231)
2103 2000-10 match all dates between 20000101-20101231
2104 200010$ match only 200010
2107 James da Silva <jds@cs.umd.edu>
2109 University of Maryland, College Park
projects / debian / amanda / blob