ecaf1caa6d025e1594a91cb65769393e964835eb
[debian/amanda] / docs / amanda.conf.5.txt
1
2                            amanda.conf
3 Prev  Chapter 35. The AMANDA Manual Pages.  Next
4
5 -------------------------------------------------------------------------------
6
7 Name
8
9 amanda.conf \14 Main configuration file for AMANDA, the Advanced Maryland
10 Automatic Network Disk Archiver
11
12 DESCRIPTION
13
14 amanda.conf is the main configuration file for AMANDA. This manpage lists the
15 relevant sections and parameters of this file for quick reference.
16
17 PARAMETERS
18
19 There are a number of configuration parameters that control the behavior of the
20 AMANDA programs. All have default values, so you need not specify the parameter
21 in amanda.conf if the default is suitable.
22 Lines starting with # are ignored, as are blank lines. Comments may be placed
23 on a line with a directive by starting the comment with a #. The remainder of
24 the line is ignored.
25 Keywords are case insensitive, i.e. mailto and MailTo are treated the same.
26 Integer arguments may have one of the following (case insensitive) suffixes,
27 some of which have a multiplier effect:
28
29 POSSIBLE SUFFIXES
30
31
32
33   b byte bytes
34       Some number of bytes.
35
36   bps
37       Some number of bytes per second.
38
39   k kb kbyte kbytes kilobyte kilobytes
40       Some number of kilobytes (bytes*1024).
41
42   kps kbps
43       Some number of kilobytes per second (bytes*1024).
44
45   m mb meg mbyte mbytes megabyte megabytes
46       Some number of megabytes (bytes*1024*1024).
47
48   mps mbps
49       Some number of megabytes per second (bytes*1024*1024).
50
51   g gb gbyte gbytes gigabyte gigabytes
52       Some number of gigabytes (bytes*1024*1024*1024).
53
54   tape tapes
55       Some number of tapes.
56
57   day days
58       Some number of days.
59
60   week weeks
61       Some number of weeks (days*7).
62
63       Note
64
65       The value inf may be used in most places where an integer is expected to
66       mean an infinite amount.
67       Boolean arguments may have any of the values y, yes, t, true or on to
68       indicate a true state, or n, no, f, false or off to indicate a false
69       state. If no argument is given, true is assumed.
70
71
72 PARAMETERS
73
74
75
76   org string
77       Default: daily. A descriptive name for the configuration. This string
78       appears in the Subject line of mail reports. Each AMANDA configuration
79       should have a different string to keep mail reports distinct.
80
81   mailto string
82       Default: operators. A space separated list of recipients for mail
83       reports.
84
85   dumpcycle int
86       Default: 10 days. The number of days in the backup cycle. Each disk will
87       get a full backup at least this often. Setting this to zero tries to do a
88       full backup each run.
89
90       Note
91
92       This parameter may also be set in a specific dumptype (see below). This
93       value sets the default for all dumptypes so must appear in amanda.conf
94       before any dumptypes are defined.
95
96   runspercycle int
97       Default: same as dumpcycle. The number of amdump runs in dumpcycle days.
98       A value of 0 means the same value as dumpcycle. A value of -1 means guess
99       the number of runs from the tapelist file, which is the number of tapes
100       used in the last dumpcycle days / runtapes.
101
102   tapecycle int
103       Default: 15 tapes. Typically tapes are used by AMANDA in an ordered
104       rotation. The tapecycle parameter defines the size of that rotation. The
105       number of tapes in rotation must be larger than the number of tapes
106       required for a complete dump cycle (see the dumpcycle parameter).
107       This is calculated by multiplying the number of amdump runs per dump
108       cycle (runspercycle parameter) times the number of tapes used per run
109       (runtapes parameter). Typically two to four times this calculated number
110       of tapes are in rotation. While AMANDA is always willing to use a new
111       tape in its rotation, it refuses to reuse a tape until at least
112       'tapecycle -1' number of other tapes have been used.
113       It is considered good administrative practice to set the tapecycle
114       parameter slightly lower than the actual number of tapes in rotation.
115       This allows the administrator to more easily cope with damaged or
116       misplaced tapes or schedule adjustments that call for slight adjustments
117       in the rotation order.
118
119   dumpuser string
120       Default: amanda. The login name AMANDA uses to run the backups. The
121       backup client hosts must allow access from the tape server host as this
122       user via .rhosts or .amandahosts, depending on how the AMANDA software
123       was built.
124
125   printer string
126       Printer to use when doing tape labels. See the lbl-templ tapetype option.
127
128   tapedev string
129       Default: /dev/nst0. The path name of the non-rewinding tape device. Non-
130       rewinding tape device names often have an 'n' in the name, e.g. /dev/rmt/
131       0mn, however this is operating system specific and you should consult
132       that documentation for detailed naming information.
133       If a tape changer is configured (see the tpchanger option), this option
134       might not be used.
135       If the null output driver is selected (see the section OUTPUT DRIVERS in
136       the amanda(8) manpage for more information), programs such as amdump will
137       run normally but all images will be thrown away. This should only be used
138       for debugging and testing, and probably only with the record option set
139       to no.
140
141   rawtapedev string
142       Default: /dev/null. The path name of the raw tape device. This is only
143       used if AMANDA is compiled for Linux machines with floppy tapes and is
144       needed for QIC volume table operations.
145
146   tpchanger string
147       Default: none. The name of the tape changer. If a tape changer is not
148       configured, this option is not used and should be commented out of the
149       configuration file.
150       If a tape changer is configured, choose one of the changer scripts (e.g.
151       chg-scsi) and enter that here.
152
153   changerdev string
154       Default: /dev/null. A tape changer configuration parameter. Usage depends
155       on the particular changer defined with the tpchanger option.
156
157   changerfile string
158       Default: /usr/adm/amanda/log/changer-status. A tape changer configuration
159       parameter. Usage depends on the particular changer defined with the
160       tpchanger option.
161
162   runtapes int
163       Default: 1. The maximum number of tapes used in a single run. If a tape
164       changer is not configured, this option is not used and should be
165       commented out of the configuration file.
166       If a tape changer is configured, this may be set larger than one to let
167       AMANDA write to more than one tape.
168       Note that this is an upper bound on the number of tapes, and AMANDA may
169       use less.
170       Also note that as of this release, AMANDA does not support true tape
171       overflow. When it reaches the end of one tape, the backup image AMANDA
172       was processing starts over again on the next tape.
173
174   maxdumpsize int
175       Default: runtapes*tape_length. Maximum number of bytes the planner will
176       schedule for a run.
177
178   taperalgo [first|firstfit|largest|largestfit|smallest|last]
179       Default: first. The algorithm used to choose which dump image to send to
180       the taper.
181
182
183         first
184             First in, first out.
185
186         firstfit
187             The first dump image that will fit on the current tape.
188
189         largest
190             The largest dump image.
191
192         largestfit
193             The largest dump image that will fit on the current tape.
194
195         smallest
196             The smallest dump image.
197
198         last
199             Last in, first out.
200
201
202   labelstr string
203       Default: .*. The tape label constraint regular expression. All tape
204       labels generated (see amlabel(8)) and used by this configuration must
205       match the regular expression. If multiple configurations are run from the
206       same tape server host, it is helpful to set their labels to different
207       strings (for example, "DAILY[0-9][0-9]*" vs. "ARCHIVE[0-9][0-9]*") to
208       avoid overwriting each other's tapes.
209
210   tapetype string
211       Default: EXABYTE. The type of tape drive associated with tapedev or
212       tpchanger. This refers to one of the defined tapetypes in the config file
213       (see below), which specify various tape parameters, like the length,
214       filemark size, and speed of the tape media and device.
215
216   ctimeout int
217       Default: 30 seconds. Maximum amount of time that amcheck will wait for
218       each client host.
219
220   dtimeout int
221       Default: 1800 seconds. Amount of idle time per disk on a given client
222       that a dumper running from within amdump will wait before it fails with a
223       data timeout error.
224
225   etimeout int
226       Default: 300 seconds. Amount of time per disk on a given client that the
227       planner step of amdump will wait to get the dump size estimates. For
228       instance, with the default of 300 seconds and four disks on client A,
229       planner will wait up to 20 minutes for that machine. A negative value
230       will be interpreted as a total amount of time to wait per client instead
231       of per disk.
232
233   netusage int
234       Default: 300 Kbps. The maximum network bandwidth allocated to AMANDA, in
235       Kbytes per second. See also the interface section.
236
237   inparallel int
238       Default: 10. The maximum number of backups that AMANDA will attempt to
239       run in parallel. AMANDA will stay within the constraints of network
240       bandwidth and holding disk space available, so it doesn't hurt to set
241       this number a bit high. Some contention can occur with larger numbers of
242       backups, but this effect is relatively small on most systems.
243
244   displayunit "k|m|g|t"
245       Default: "k". The unit used to print many numbers, k=kilo, m=mega,
246       g=giga, t=tera.
247
248   dumporder string
249       Default: tttTTTTTTT. The priority order of each dumper:
250
251       * s: smallest size
252       * S: largest size
253       * t: smallest time
254       * T: largest time
255       * b: smallest bandwidth
256       * B: largest bandwidth
257
258
259   maxdumps int
260       Default: 1. The maximum number of backups from a single host that AMANDA
261       will attempt to run in parallel. See also the inparallel option.
262       Note that this parameter may also be set in a specific dumptype (see
263       below). This value sets the default for all dumptypes so must appear in
264       amanda.conf before any dumptypes are defined.
265
266   bumpsize int
267       Default: 10 Mbytes. The minimum savings required to trigger an automatic
268       bump from one incremental level to the next, expressed as size. If AMANDA
269       determines that the next higher backup level will be this much smaller
270       than the current level, it will do the next level. The value of this
271       parameter is used only if the parameter bumppercent is set to 0.
272       The global setting of this parameter can be overwritten inside of a
273       dumptype-definition.
274       See also the options bumppercent, bumpmult and bumpdays.
275
276   bumppercent int
277       Default: 0 percent. The minimum savings required to trigger an automatic
278       bump from one incremental level to the next, expressed as percentage of
279       the current size of the DLE (size of current level 0). If AMANDA
280       determines that the next higher backup level will be this much smaller
281       than the current level, it will do the next level.
282       If this parameter is set to 0, the value of the parameter bumpsize is
283       used to trigger bumping.
284       The global setting of this parameter can be overwritten inside of a
285       dumptype-definition.
286       See also the options bumpsize, bumpmult and bumpdays.
287
288   bumpmult float
289       Default: 1.5. The bump size multiplier. AMANDA multiplies bumpsize by
290       this factor for each level. This prevents active filesystems from bumping
291       too much by making it harder to bump to the next level. For example, with
292       the default bumpsize and bumpmult set to 2.0, the bump threshold will be
293       10 Mbytes for level one, 20 Mbytes for level two, 40 Mbytes for level
294       three, and so on.
295       The global setting of this parameter can be overwritten inside of a
296       dumptype-definition.
297
298   bumpdays int
299       Default: 2 days. To insure redundancy in the dumps, AMANDA keeps
300       filesystems at the same incremental level for at least bumpdays days,
301       even if the other bump threshold criteria are met.
302       The global setting of this parameter can be overwritten inside of a
303       dumptype-definition.
304
305   diskfile string
306       Default: disklist. The file name for the disklist file holding client
307       hosts, disks and other client dumping information.
308
309   infofile string
310       Default: /usr/adm/amanda/curinfo. The file or directory name for the
311       historical information database. If AMANDA was configured to use DBM
312       databases, this is the base file name for them. If it was configured to
313       use text formated databases (the default), this is the base directory and
314       within here will be a directory per client, then a directory per disk,
315       then a text file of data.
316
317   logdir string
318       Default: /usr/adm/amanda. The directory for the amdump and log files.
319
320   indexdir string
321       Default /usr/adm/amanda/index. The directory where index files (backup
322       image catalogues) are stored. Index files are only generated for
323       filesystems whose dumptype has the index option enabled.
324
325   tapelist string
326       Default: tapelist. The file name for the active tapelist file. AMANDA
327       maintains this file with information about the active set of tapes.
328
329   tapebufs int
330       Default: 20. The number of buffers used by the taper process run by
331       amdump and amflush to hold data as it is read from the network or disk
332       before it is written to tape. Each buffer is a little larger than 32
333       KBytes and is held in a shared memory region.
334
335   reserve number
336       Default: 100. The part of holding-disk space that should be reserved for
337       incremental backups if no tape is available, expressed as a percentage of
338       the available holding-disk space (0-100). By default, when there is no
339       tape to write to, degraded mode (incremental) backups will be performed
340       to the holding disk. If full backups should also be allowed in this case,
341       the amount of holding disk space reserved for incrementals should be
342       lowered.
343
344   autoflush bool
345       Default: off. Whether an amdump run will flush the dump already on
346       holding disk to tape.
347
348   amrecover_do_fsf bool
349       Default: off. Amrecover will call amrestore with the -f flag for faster
350       positioning of the tape.
351
352   amrecover_check_label bool
353       Default: off. Amrecover will call amrestore with the -l flag to check the
354       label.
355
356   amrecover_changer string
357       Default: ''. Amrecover will use the changer if you use 'settape <string>'
358       and that string is the same as the amrecover_changer setting.
359
360   columnspec string
361       Defines the width of columns amreport should use. String is a comma (',')
362       separated list of triples. Each triple consists of three parts which are
363       separated by a equal sign ('=') and a colon (':') (see the example).
364       These three parts specify:
365
366       * the name of the column, which may be:
367
368         o Compress (compression ratio)
369         o Disk (client disk name)
370         o DumpRate (dump rate in KBytes/sec)
371         o DumpTime (total dump time in hours:minutes)
372         o HostName (client host name)
373         o Level (dump level)
374         o OrigKB (original image size in KBytes)
375         o OutKB (output image size in KBytes)
376         o TapeRate (tape writing rate in KBytes/sec)
377         o TapeTime (total tape time in hours:minutes)
378
379       * the amount of space to display before the column (used to get
380         whitespace between columns).
381       * the width of the column itself. If set to a negative value, the width
382         will be calculated on demand to fit the largest entry in this column.
383
384       Here is an example:
385
386         columnspec "Disk=1:18,HostName=0:10,OutKB=1:7"
387
388       The above will display the disk information in 18 characters and put one
389       space before it. The hostname column will be 10 characters wide with no
390       space to the left. The output KBytes column is seven characters wide with
391       one space before it.
392
393   includefile string
394       Default: none. The name of an AMANDA configuration file to include within
395       the current file. Useful for sharing dumptypes, tapetypes and interface
396       definitions among several configurations.
397
398
399 HOLDINGDISK SECTION
400
401 The amanda.conf file may define one or more holding disks used as buffers to
402 hold backup images before they are written to tape. The syntax is:
403
404   holdingdisk name {
405       holdingdisk-option holdingdisk-value
406       ...
407   }
408
409 Name is a logical name for this holding disk.
410 The options and values are:
411
412
413   comment string
414       Default: none. A comment string describing this holding disk.
415
416   directory disk
417       Default: /dumps/amanda. The path to this holding area.
418
419   use int
420       Default: 0 Gb. Amount of space that can be used in this holding disk
421       area. If the value is zero, all available space on the file system is
422       used. If the value is negative, AMANDA will use all available space minus
423       that value.
424
425   chunksize int
426       Default: 1 Gb. Holding disk chunk size. Dumps larger than the specified
427       size will be stored in multiple holding disk files. The size of each
428       chunk will not exceed the specified value. However, even though dump
429       images are split in the holding disk, they are concatenated as they are
430       written to tape, so each dump image still corresponds to a single
431       continuous tape section.
432       If 0 is specified, AMANDA will create holding disk chunks as large as (
433       (INT_MAX/1024)-64) Kbytes.
434       Each holding disk chunk includes a 32 Kbyte header, so the minimum chunk
435       size is 64 Kbytes (but that would be really silly).
436       Operating systems that are limited to a maximum file size of 2 Gbytes
437       actually cannot handle files that large. They must be at least one byte
438       less than 2 Gbytes. Since AMANDA works with 32 Kbyte blocks, and to
439       handle the final read at the end of the chunk, the chunk size should be
440       at least 64 Kbytes (2 * 32 Kbytes) smaller than the maximum file size,
441       e.g. 2047 Mbytes.
442
443
444 DUMPTYPE SECTION
445
446 The amanda.conf file may define multiple sets of backup options and refer to
447 them by name from the disklist file. For instance, one set of options might be
448 defined for file systems that can benefit from high compression, another set
449 that does not compress well, another set for file systems that should always
450 get a full backup and so on.
451 A set of backup options are entered in a dumptype section, which looks like
452 this:
453
454   define dumptype name {
455       dumptype-option dumptype-value
456       ...
457   }
458
459 Name is the name of this set of backup options. It is referenced from the
460 disklist file.
461 Some of the options in a dumptype section are the same as those in the main
462 part of amanda.conf. The main option value is used to set the default for all
463 dumptype sections. For instance, setting dumpcycle to 50 in the main part of
464 the config file causes all following dumptype sections to start with that
465 value, but the value may be changed on a section by section basis. Changes to
466 variables in the main part of the config file must be done before (earlier in
467 the file) any dumptypes are defined.
468 The dumptype options and values are:
469
470
471   auth string
472       Default: bsd. Type of authorization to perform between tape server and
473       backup client hosts. May be krb4 to use Kerberos-IV authorization.
474
475   bumpsize int
476       Default: 10 Mbytes. The minimum savings required to trigger an automatic
477       bump from one incremental level to the next, expressed as size. If AMANDA
478       determines that the next higher backup level will be this much smaller
479       than the current level, it will do the next level. The value of this
480       parameter is used only if the parameter bumppercent is set to 0.
481       See also the options bumppercent, bumpmult and bumpdays.
482
483   bumppercent int
484       Default: 0 percent. The minimum savings required to trigger an automatic
485       bump from one incremental level to the next, expressed as percentage of
486       the current size of the DLE (size of current level 0). If AMANDA
487       determines that the next higher backup level will be this much smaller
488       than the current level, it will do the next level.
489       If this parameter is set to 0, the value of the parameter bumpsize is
490       used to trigger bumping.
491       See also the options bumpsize, bumpmult and bumpdays.
492
493   bumpmult float
494       Default: 1.5. The bump size multiplier. AMANDA multiplies bumpsize by
495       this factor for each level. This prevents active filesystems from bumping
496       too much by making it harder to bump to the next level. For example, with
497       the default bumpsize and bumpmult set to 2.0, the bump threshold will be
498       10 Mbytes for level one, 20 Mbytes for level two, 40 Mbytes for level
499       three, and so on.
500
501   bumpdays int
502       Default: 2 days. To insure redundancy in the dumps, AMANDA keeps
503       filesystems at the same incremental level for at least bumpdays days,
504       even if the other bump threshold criteria are met.
505
506   comment string
507       Default: none. A comment string describing this set of backup options.
508
509   comprate float [, float ]
510       Default: 0.50, 0.50. The expected full and incremental compression factor
511       for dumps. It is only used if AMANDA does not have any history
512       information on compression rates for a filesystem, so should not usually
513       need to be set. However, it may be useful for the first time a very large
514       filesystem that compresses very little is backed up.
515
516   compress [client|server] string
517       Default: client fast. If AMANDA does compression of the backup images, it
518       can do so either on the backup client host before it crosses the network
519       or on the tape server host as it goes from the network into the holding
520       disk or to tape. Which place to do compression (if at all) depends on how
521       well the dump image usually compresses, the speed and load on the client
522       or server, network capacity, holding disk capacity, availability of tape
523       hardware compression, etc.
524       For either type of compression, AMANDA also allows the selection of two
525       styles of compression. Best is the best compression available, often at
526       the expense of CPU overhead. Fast is often not as good a compression as
527       best, but usually less CPU overhead.
528       So the compress options line may be one of:
529
530       * compress none
531       * compress [client] fast
532       * compress [client] best
533       * compress server fast
534       * compress server best
535
536       Note that some tape devices do compression and this option has nothing to
537       do with whether that is used. If hardware compression is used (usually
538       via a particular tape device name or mt option), AMANDA (software)
539       compression should be disabled.
540
541   dumpcycle int
542       Default: 10 days. The number of days in the backup cycle. Each disk using
543       this set of options will get a full backup at least this often. Setting
544       this to zero tries to do a full backup each run.
545
546   estimate client|calcsize|server
547       Default: client. Determine the way AMANDA does it's estimate.
548
549       * client:
550         Use the same program as the dumping program, this is the most accurate
551         way to do estimates, but it can take a long time.
552       * calcsize:
553         Use a faster program to do estimates, but the result is less accurate.
554       * server:
555         Use only statistics from the previous run to give an estimate, it takes
556         only a few seconds but the result is not accurate if your disk usage
557         changes from day to day.
558
559
560   exclude [ list|file ][[optional][ append ][ string ]+]
561       Default: file. There are two exclude lists, exclude file and exclude
562       list. With exclude file , the string is a GNU-tar exclude expression.
563       With exclude list , the string is a file name on the client containing
564       GNU-tar exclude expressions.
565       All exclude expressions are concatenated in one file and passed to GNU-
566       tar as an --exclude-from argument.
567       With the append keyword, the string is appended to the current list,
568       without it, the string overwrites the list.
569       If optional is specified for exclude list, then amcheck will not complain
570       if the file doesn't exist or is not readable.
571       For exclude list, if the file name is relative, the disk name being
572       backed up is prepended. So if this is entered:
573
574             exclude list ".amanda.excludes"
575
576       the actual file used would be /var/.amanda.excludes for a backup of /var,
577       /usr/local/.amanda.excludes for a backup of /usr/local, and so on.
578
579   holdingdisk boolean
580       Default: yes. Whether a holding disk should be used for these backups or
581       whether they should go directly to tape. If the holding disk is a portion
582       of another file system that AMANDA is backing up, that file system should
583       refer to a dumptype with holdingdisk set to no to avoid backing up the
584       holding disk into itself.
585
586   ignore boolean
587       Default: no. Whether disks associated with this backup type should be
588       backed up or not. This option is useful when the disklist file is shared
589       among several configurations, some of which should not back up all the
590       listed file systems.
591
592   include [ list|file ][[optional][ append ][ string ]+]
593       Default: file ".". There are two include lists, include file and include
594       list. With include file , the string is a glob expression. With include
595       list , the string is a file name on the client containing glob
596       expressions.
597       All include expressions are expanded by AMANDA, concatenated in one file
598       and passed to GNU-tar as a --files-from argument. They must start with
599       "./" and contain no other "/".
600       With the append keyword, the string is appended to the current list,
601       without it, the string overwrites the list.
602       If optional is specified for include list, then amcheck will not complain
603       if the file doesn't exist or is not readable.
604       For include list, If the file name is relative, the disk name being
605       backed up is prepended.
606
607   index boolean
608       Default: no. Whether an index (catalogue) of the backup should be
609       generated and saved in indexdir. These catalogues are used by the
610       amrecover utility.
611
612   kencrypt boolean
613       Default: no. Whether the backup image should be encrypted by Kerberos as
614       it is sent across the network from the backup client host to the tape
615       server host.
616
617   maxdumps int
618       Default: 1. The maximum number of backups from a single host that AMANDA
619       will attempt to run in parallel. See also the main section parameter
620       inparallel.
621
622   maxpromoteday int
623       Default: 10000. The maximum number of day for a promotion, set it 0 if
624       you don't want promotion, set it to 1 or 2 if your disks get
625       overpromoted.
626
627   priority string
628       Default: medium. When there is no tape to write to, AMANDA will do
629       incremental backups in priority order to the holding disk. The priority
630       may be high (2), medium (1), low (0) or a number of your choice.
631
632   program string
633       Default: DUMP. The type of backup to perform. Valid values are DUMP for
634       the native operating system backup program, and GNUTAR to use GNU-tar or
635       to do PC backups using Samba.
636
637   record boolean
638       Default: yes. Whether to ask the backup program to update its database
639       (e.g. /etc/dumpdates for DUMP or /usr/local/var/amanda/gnutar-lists for
640       GNUTAR) of time stamps. This is normally enabled for daily backups and
641       turned off for periodic archival runs.
642
643   skip-full boolean
644       Default: no. If true and planner has scheduled a full backup, these disks
645       will be skipped, and full backups should be run off-line on these days.
646       It was reported that AMANDA only schedules level 1 incrementals in this
647       configuration; this is probably a bug.
648
649   skip-incr boolean
650       Default: no. If true and planner has scheduled an incremental backup,
651       these disks will be skipped.
652
653   starttime int
654       Default: none. Backups will not start until after this time of day. The
655       value should be hh*100+mm, e.g. 6:30PM (18:30) would be entered as 1830.
656
657   strategy string
658       Default: standard. Strategy to use when planning what level of backup to
659       run next. Values are:
660
661
662         standard
663             The standard AMANDA schedule.
664
665         nofull
666             Never do full backups, only level 1 incrementals.
667
668         noinc
669             Never do incremental backups, only full dumps.
670
671         skip
672             Never do backups (useful when sharing the disklist file).
673
674         incronly
675             Only do incremental dumps. amadmin force should be used to tell
676             AMANDA that a full dump has been performed off-line, so that it
677             resets to level 1. It is similar to skip-full, but with incronly
678             full dumps may be scheduled manually. Unfortunately, it appears
679             that AMANDA will perform full backups with this configuration,
680             which is probably a bug.
681
682
683 The following dumptype entries are predefined by AMANDA:
684
685   define dumptype no-compress {
686       compress none
687   }
688   define dumptype compress-fast {
689       compress client fast
690   }
691   define dumptype compress-best {
692       compress client best
693   }
694   define dumptype srvcompress {
695       compress server fast
696   }
697   define dumptype bsd-auth {
698       auth bsd
699   }
700   define dumptype krb4-auth {
701       auth krb4
702   }
703   define dumptype no-record {
704       record no
705   }
706   define dumptype no-hold {
707       holdingdisk no
708   }
709   define dumptype no-full {
710       skip-full yes
711   }
712
713 In addition to options in a dumptype section, one or more other dumptype names
714 may be entered, which make this dumptype inherit options from other previously
715 defined dumptypes. For instance, two sections might be the same except for the
716 record option:
717
718   define dumptype normal {
719       comment "Normal backup, no compression, do indexing"
720       no-compress
721       index yes
722       maxdumps 2
723   }
724   define dumptype testing {
725       comment "Test backup, no compression, do indexing, no recording"
726       normal
727       record no
728   }
729
730 AMANDA provides a dumptype named global in the sample amanda.conf file that all
731 dumptypes should reference. This provides an easy place to make changes that
732 will affect every dumptype.
733
734 TAPETYPE SECTION
735
736 The amanda.conf file may define multiple types of tape media and devices. The
737 information is entered in a tapetype section, which looks like this in the
738 config file:
739
740   define tapetype name {
741       tapetype-option tapetype-value
742       ...
743   }
744
745 Name is the name of this type of tape medium/device. It is referenced from the
746 tapetype option in the main part of the config file.
747 The tapetype options and values are:
748
749
750   comment string
751       Default: none. A comment string describing this set of tape information.
752
753   filemark int
754       Default: 1000 bytes. How large a file mark (tape mark) is, measured in
755       bytes. If the size is only known in some linear measurement (e.g.
756       inches), convert it to bytes using the device density.
757
758   length int
759       Default: 2000 kbytes. How much data will fit on a tape.
760       Note that this value is only used by AMANDA to schedule which backups
761       will be run. Once the backups start, AMANDA will continue to write to a
762       tape until it gets an error, regardless of what value is entered for
763       length (but see the section OUTPUT DRIVERS in the amanda(8) manpage for
764       exceptions).
765
766   blocksize int
767       Default: 32. How much data will be written in each tape record expressed
768       in KiloBytes. The tape record size (= blocksize) can not be reduced below
769       the default 32 KBytes. The parameter blocksize can only be raised if
770       AMANDA was compiled with the configure option --with-maxtapeblocksize=N
771       set with "N" greater than 32 during configure.
772
773   file-pad boolean
774       Default: true. If true, every record, including the last one in the file,
775       will have the same length. This matches the way AMANDA wrote tapes prior
776       to the availability of this parameter. It may also be useful on devices
777       that only support a fixed blocksize.
778       Note that the last record on the tape probably includes trailing null
779       byte padding, which will be passed back to gzip, compress or the restore
780       program. Most programs just ignore this (although possibly with a
781       warning).
782       If this parameter is false, the last record in a file may be shorter than
783       the block size. The file will contain the same amount of data the dump
784       program generated, without trailing null byte padding. When read, the
785       same amount of data that was written will be returned.
786
787   speed int
788       Default: 200 bps. How fast the drive will accept data, in bytes per
789       second. This parameter is NOT currently used by AMANDA.
790
791   lbl-templ string
792       A PostScript template file used by amreport to generate labels. Several
793       sample files are provided with the AMANDA sources in the example
794       directory. See the amreport(8) man page for more information.
795
796 In addition to options, another tapetype name may be entered, which makes this
797 tapetype inherit options from another tapetype. For instance, the only
798 difference between a DLT4000 tape drive using Compact-III tapes and one using
799 Compact-IV tapes is the length of the tape. So they could be entered as:
800
801   define tapetype DLT4000-III {
802       comment "DLT4000 tape drives with Compact-III tapes"
803       length 12500 mbytes         # 10 Gig tapes with some compression
804       filemark 2000 kbytes
805       speed 1536 kps
806   }
807   define tapetype DLT4000-IV {
808       DLT4000-III
809       comment "DLT4000 tape drives with Compact-IV tapes"
810       length 25000 mbytes         # 20 Gig tapes with some compression
811   }
812
813
814 INTERFACE SECTION
815
816 The amanda.conf file may define multiple types of network interfaces. The
817 information is entered in an interface section, which looks like this:
818
819   define interface name {
820       interface-option interface-value
821       ...
822   }
823
824 name is the name of this type of network interface. It is referenced from the
825 disklist file.
826 Note that these sections define network interface characteristics, not the
827 actual interface that will be used. Nor do they impose limits on the bandwidth
828 that will actually be taken up by AMANDA. AMANDA computes the estimated
829 bandwidth each file system backup will take based on the estimated size and
830 time, then compares that plus any other running backups with the limit as
831 another of the criteria when deciding whether to start the backup. Once a
832 backup starts, AMANDA will use as much of the network as it can leaving
833 throttling up to the operating system and network hardware.
834 The interface options and values are:
835
836
837   comment string
838       Default: none. A comment string describing this set of network
839       information.
840
841   use int
842       Default: 300 Kbps. The speed of the interface in Kbytes per second.
843
844 In addition to options, another interface name may be entered, which makes this
845 interface inherit options from another interface. At the moment, this is of
846 little use.
847
848 AUTHOR
849
850 James da Silva, <jds@amanda.org>: Original text
851 Stefan G. Weichinger, <sgw@amanda.org>, maintainer of the AMANDA-documentation:
852 XML-conversion, major update, splitting
853
854 SEE ALSO
855
856 amanda(8),
857 -------------------------------------------------------------------------------
858
859 Prev     Up      Next
860 amanda  Home  amcheck
861