1AMANDA.CONF(5) AMANDA.CONF(5)
2
6 amanda.conf - Main configuration file for Amanda, the Advanced Maryland
7 Automatic Network Disk Archiver
8
10 amanda.conf is the main configuration file for Amanda. This manpage
11 lists the relevant sections and parameters of this file for quick
12 reference.
13 The file <CONFIG_DIR>/<config>/amanda.conf is loaded.
15
17 There are a number of configuration parameters that control the
18 behavior of the Amanda programs. All have default values, so you need
19 not specify the parameter in amanda.conf if the default is suitable.
20 Lines starting with # are ignored, as are blank lines. Comments may be
22 placed on a line with a directive by starting the comment with a #. The
23 remainder of the line is ignored.
24 Keywords are case insensitive, i.e. mailto and MailTo are treated the
26 same.
27 Integer arguments may have one of the following (case insensitive)
29 suffixes, some of which have a multiplier effect:
30 POSSIBLE SUFFIXES
32 b byte bytes
33 Some number of bytes.
34 bps
36 Some number of bytes per second.
37 k kb kbyte kbytes kilobyte kilobytes
39 Some number of kilobytes (bytes*1024).
40 kps kbps
42 Some number of kilobytes per second (bytes*1024).
43 m mb meg mbyte mbytes megabyte megabytes
45 Some number of megabytes (bytes*1024*1024).
46 mps mbps
48 Some number of megabytes per second (bytes*1024*1024).
49 g gb gbyte gbytes gigabyte gigabytes
51 Some number of gigabytes (bytes*1024*1024*1024).
52 tape tapes
54 Some number of tapes.
55 day days
57 Some number of days.
58 week weeks
60 Some number of weeks (days*7).
61 Note
63 The value inf may be used in most places where an integer is
64 expected to mean an infinite amount.
65 Boolean arguments may have any of the values y, yes, t, true or on
67 to indicate a true state, or n, no, f, false or off to indicate a
68 false state. If no argument is given, true is assumed.
69 PARAMETERS
71 org string
72 Default: daily. A descriptive name for the configuration. This
73 string appears in the Subject line of mail reports. Each Amanda
74 configuration should have a different string to keep mail reports
75 distinct.
76 mailto string
78 Default: operators. A space separated list of recipients for mail
79 reports.
80 dumpcycle int
82 Default: 10 days. The number of days in the backup cycle. Each disk
83 will get a full backup at least this often. Setting this to zero
84 tries to do a full backup each run.
85 Note
87 This parameter may also be set in a specific dumptype (see below).
88 This value sets the default for all dumptypes so must appear in
89 amanda.conf before any dumptypes are defined.
90 runspercycle int
92 Default: same as dumpcycle. The number of amdump runs in dumpcycle
93 days. A value of 0 means the same value as dumpcycle. A value of -1
94 means guess the number of runs from the tapelist file, which is the
95 number of tapes used in the last dumpcycle days / runtapes.
96 tapecycle int
98 Default: 15 tapes. Typically tapes are used by Amanda in an ordered
99 rotation. The tapecycle parameter defines the size of that
100 rotation. The number of tapes in rotation must be larger than the
101 number of tapes required for a complete dump cycle (see the
102 dumpcycle parameter).
103 This is calculated by multiplying the number of amdump runs per
105 dump cycle (runspercycle parameter) times the number of tapes used
106 per run (runtapes parameter). Typically two to four times this
107 calculated number of tapes are in rotation. While Amanda is always
108 willing to use a new tape in its rotation, it refuses to reuse a
109 tape until at least 'tapecycle -1' number of other tapes have been
110 used.
111 It is considered good administrative practice to set the tapecycle
113 parameter slightly lower than the actual number of tapes in
114 rotation. This allows the administrator to more easily cope with
115 damaged or misplaced tapes or schedule adjustments that call for
116 slight adjustments in the rotation order.
117 usetimestamps bool
119 Default: No. By default, Amanda can only track at most one run per
120 calendar day. When this option is enabled, however, Amanda can
121 track as many runs as you care to make.
122 WARNING: This option is not backward-compatible. Do not enable it
125 if you intend to downgrade your server installation to Amanda
126 community edition 2.5.0
127 label_new_tapes string
129 Default: not set. When set, this directive will cause Amanda to
130 automatically write an Amanda tape label to any blank tape she
131 encounters. This option is DANGEROUS because when set, Amanda will
132 ERASE any non-Amanda tapes you may have, and may also ERASE any
133 near-failing tapes. Use with caution.
134 When using this directive, specify the template for new tape
136 labels. The template should contain some number of contiguous '%'
137 characters, which will be replaced with a generated number. Be sure
138 to specify enough '%' characters that you do not run out of tape
139 labels. Example: label_new_tapes "DailySet1-%%%"
140 dumpuser string
142 Default: amanda. The login name Amanda uses to run the backups. The
143 backup client hosts must allow access from the tape server host as
144 this user via .rhosts or .amandahosts, depending on how the Amanda
145 software was built.
146 printer string
148 Printer to use when doing tape labels. See the lbl-templ tapetype
149 option.
150 tapedev string
152 Default: null:. The path name of the non-rewinding tape device.
153 Non-rewinding tape device names often have an 'n' in the name, e.g.
154 /dev/rmt/0mn, however this is operating system specific and you
155 should consult that documentation for detailed naming information.
156 If a tape changer is configured (see the tpchanger option), this
158 option might not be used.
159 If the null output driver is selected (see the section OUTPUT
161 DRIVERS in the amanda(8) manpage for more information), programs
162 such as amdump will run normally but all images will be thrown
163 away. This should only be used for debugging and testing, and
164 probably only with the record option set to no.
165 rawtapedev string
167 Default: null:. The path name of the raw tape device. This is only
168 used if Amanda is compiled for Linux machines with floppy tapes and
169 is needed for QIC volume table operations.
170 tpchanger string
172 Default: none. The name of the tape changer. If a tape changer is
173 not configured, this option is not used and should be commented out
174 of the configuration file.
175 If a tape changer is configured, choose one of the changer scripts
177 (e.g. chg-scsi) and enter that here.
178 changerdev string
180 Default: /dev/null. A tape changer configuration parameter. Usage
181 depends on the particular changer defined with the tpchanger
182 option.
183 changerfile string
185 Default: /usr/adm/amanda/log/changer-status. A tape changer
186 configuration parameter. Usage depends on the particular changer
187 defined with the tpchanger option.
188 runtapes int
190 Default: 1. The maximum number of tapes used in a single run. If a
191 tape changer is not configured, this option is not used and should
192 be commented out of the configuration file.
193 If a tape changer is configured, this may be set larger than one to
195 let Amanda write to more than one tape.
196 Note that this is an upper bound on the number of tapes, and Amanda
198 may use less.
199 Also note that as of this release, Amanda does not support true
201 tape overflow. When it reaches the end of one tape, the backup
202 image Amanda was processing starts over again on the next tape.
203 maxdumpsize int
205 Default: runtapes*tape_length. Maximum number of bytes the planner
206 will schedule for a run.
207 taperalgo [first|firstfit|largest|largestfit|smallest|last]
209 Default: first. The algorithm used to choose which dump image to
210 send to the taper.
211 first
213 First in, first out.
214 firstfit
216 The first dump image that will fit on the current tape.
217 largest
219 The largest dump image.
220 largestfit
222 The largest dump image that will fit on the current tape.
223 smallest
225 The smallest dump image.
226 last
228 Last in, first out.
229 labelstr string
231 Default: .*. The tape label constraint regular expression. All tape
232 labels generated (see amlabel(8)) and used by this configuration
233 must match the regular expression. If multiple configurations are
234 run from the same tape server host, it is helpful to set their
235 labels to different strings (for example, "DAILY[0-9][0-9]*" vs.
236 "ARCHIVE[0-9][0-9]*") to avoid overwriting each other's tapes.
237 tapetype string
239 Default: EXABYTE. The type of tape drive associated with tapedev or
240 tpchanger. This refers to one of the defined tapetypes in the
241 config file (see below), which specify various tape parameters,
242 like the length, filemark size, and speed of the tape media and
243 device.
244 First character of a tapetype string must be an alphabetic
246 character
247 ctimeout int
249 Default: 30 seconds. Maximum amount of time that amcheck will wait
250 for each client host.
251 dtimeout int
253 Default: 1800 seconds. Amount of idle time per disk on a given
254 client that a dumper running from within amdump will wait before it
255 fails with a data timeout error.
256 etimeout int
258 Default: 300 seconds. Amount of time per disk on a given client
259 that the planner step of amdump will wait to get the dump size
260 estimates. For instance, with the default of 300 seconds and four
261 disks on client A, planner will wait up to 20 minutes for that
262 machine. A negative value will be interpreted as a total amount of
263 time to wait per client instead of per disk.
264 netusage int
266 Default: 300 Kbps. The maximum network bandwidth allocated to
267 Amanda, in Kbytes per second. See also the interface section.
268 inparallel int
270 Default: 10. The maximum number of backups that Amanda will attempt
271 to run in parallel. Amanda will stay within the constraints of
272 network bandwidth and holding disk space available, so it doesn't
273 hurt to set this number a bit high. Some contention can occur with
274 larger numbers of backups, but this effect is relatively small on
275 most systems.
276 displayunit "k|m|g|t"
278 Default: "k". The unit used to print many numbers, k=kilo, m=mega,
279 g=giga, t=tera.
280 dumporder string
282 Default: tttTTTTTTT. The priority order of each dumper:
283 s: smallest size
285 S: largest size
286 t: smallest time
287 T: largest time
288 b: smallest bandwidth
289 B: largest bandwidth
290 maxdumps int
292 Default: 1. The maximum number of backups from a single host that
293 Amanda will attempt to run in parallel. See also the inparallel
294 option.
295 Note that this parameter may also be set in a specific dumptype
297 (see below). This value sets the default for all dumptypes so must
298 appear in amanda.conf before any dumptypes are defined.
299 bumpsize int
301 Default: 10 Mbytes. The minimum savings required to trigger an
302 automatic bump from one incremental level to the next, expressed as
303 size. If Amanda determines that the next higher backup level will
304 be this much smaller than the current level, it will do the next
305 level. The value of this parameter is used only if the parameter
306 bumppercent is set to 0.
307 The global setting of this parameter can be overwritten inside of a
309 dumptype-definition.
310 See also the options bumppercent, bumpmult and bumpdays.
312 bumppercent int
314 Default: 0 percent. The minimum savings required to trigger an
315 automatic bump from one incremental level to the next, expressed as
316 percentage of the current size of the DLE (size of current level
317 0). If Amanda determines that the next higher backup level will be
318 this much smaller than the current level, it will do the next
319 level.
320 If this parameter is set to 0, the value of the parameter bumpsize
322 is used to trigger bumping.
323 The global setting of this parameter can be overwritten inside of a
325 dumptype-definition.
326 See also the options bumpsize, bumpmult and bumpdays.
328 bumpmult float
330 Default: 1.5. The bump size multiplier. Amanda multiplies bumpsize
331 by this factor for each level. This prevents active filesystems
332 from bumping too much by making it harder to bump to the next
333 level. For example, with the default bumpsize and bumpmult set to
334 2.0, the bump threshold will be 10 Mbytes for level one, 20 Mbytes
335 for level two, 40 Mbytes for level three, and so on.
336 The global setting of this parameter can be overwritten inside of a
338 dumptype-definition.
339 bumpdays int
341 Default: 2 days. To insure redundancy in the dumps, Amanda keeps
342 filesystems at the same incremental level for at least bumpdays
343 days, even if the other bump threshold criteria are met.
344 The global setting of this parameter can be overwritten inside of a
346 dumptype-definition.
347 diskfile string
349 Default: disklist. The file name for the disklist file holding
350 client hosts, disks and other client dumping information.
351 infofile string
353 Default: /usr/adm/amanda/curinfo. The file or directory name for
354 the historical information database. If Amanda was configured to
355 use DBM databases, this is the base file name for them. If it was
356 configured to use text formated databases (the default), this is
357 the base directory and within here will be a directory per client,
358 then a directory per disk, then a text file of data.
359 logdir string
361 Default: /usr/adm/amanda. The directory for the amdump and log
362 files.
363 indexdir string
365 Default /usr/adm/amanda/index. The directory where index files
366 (backup image catalogues) are stored. Index files are only
367 generated for filesystems whose dumptype has the index option
368 enabled.
369 tapelist string
371 Default: tapelist. The file name for the active tapelist file.
372 Amanda maintains this file with information about the active set of
373 tapes.
374 tapebufs int
376 Default: 20. The number of buffers used by the taper process run by
377 amdump and amflush to hold data as it is read from the network or
378 disk before it is written to tape. Each buffer is a little larger
379 than 32 KBytes and is held in a shared memory region.
380 reserve number
382 Default: 100. The part of holding-disk space that should be
383 reserved for incremental backups if no tape is available, expressed
384 as a percentage of the available holding-disk space (0-100). By
385 default, when there is no tape to write to, degraded mode
386 (incremental) backups will be performed to the holding disk. If
387 full backups should also be allowed in this case, the amount of
388 holding disk space reserved for incrementals should be lowered.
389 autoflush bool
391 Default: off. Whether an amdump run will flush the dumps from
392 holding disk to tape.
393 amrecover_do_fsf bool
395 Default: on. Amrecover will call amrestore with the -f flag for
396 faster positioning of the tape.
397 amrecover_check_label bool
399 Default: on. Amrecover will call amrestore with the -l flag to
400 check the label.
401 amrecover_changer string
403 Default: ''. Amrecover will use the changer if you use 'settape
404 <string>' and that string is the same as the amrecover_changer
405 setting.
406 columnspec string
408 Defines the width of columns amreport should use. String is a
409 comma (',') separated list of triples. Each triple consists of
410 three parts which are separated by a equal sign ('=') and a colon
411 (':') (see the example). These three parts specify:
412 1. the name of the column, which may be:
413 Compress (compression ratio)
415 Disk (client disk name)
416 DumpRate (dump rate in KBytes/sec)
417 DumpTime (total dump time in hours:minutes)
418 HostName (client host name)
419 Level (dump level)
420 OrigKB (original image size in KBytes)
421 OutKB (output image size in KBytes)
422 TapeRate (tape writing rate in KBytes/sec)
423 TapeTime (total tape time in hours:minutes)
424 2. the amount of space to display before the column (used to get
426 whitespace between columns).
427 3. the width of the column itself. If set to a negative value,
429 the width will be calculated on demand to fit the largest entry
430 in this column.
431 Here is an example:
433 columnspec "Disk=1:18,HostName=0:10,OutKB=1:7"
435 The above will display the disk information in 18 characters and
437 put one space before it. The hostname column will be 10 characters
438 wide with no space to the left. The output KBytes column is seven
439 characters wide with one space before it.
440 includefile string
442 Default: none. The name of an Amanda configuration file to include
443 within the current file. Useful for sharing dumptypes, tapetypes
444 and interface definitions among several configurations.
445
447 The amanda.conf file may define one or more holding disks used as
448 buffers to hold backup images before they are written to tape. The
449 syntax is:
450 holdingdisk name {
452 holdingdisk-option holdingdisk-value
453 ...
454 }
455 Name is a logical name for this holding disk.
457 The options and values are:
459 comment string
461 Default: none. A comment string describing this holding disk.
462 directory disk
464 Default: /dumps/amanda. The path to this holding area.
465 use int
467 Default: 0 Gb. Amount of space that can be used in this holding
468 disk area. If the value is zero, all available space on the file
469 system is used. If the value is negative, Amanda will use all
470 available space minus that value.
471 chunksize int
473 Default: 1 Gb. Holding disk chunk size. Dumps larger than the
474 specified size will be stored in multiple holding disk files. The
475 size of each chunk will not exceed the specified value. However,
476 even though dump images are split in the holding disk, they are
477 concatenated as they are written to tape, so each dump image still
478 corresponds to a single continuous tape section.
479 If 0 is specified, Amanda will create holding disk chunks as large
481 as ((INT_MAX/1024)-64) Kbytes.
482 Each holding disk chunk includes a 32 Kbyte header, so the minimum
484 chunk size is 64 Kbytes (but that would be really silly).
485 Operating systems that are limited to a maximum file size of 2
487 Gbytes actually cannot handle files that large. They must be at
488 least one byte less than 2 Gbytes. Since Amanda works with 32 Kbyte
489 blocks, and to handle the final read at the end of the chunk, the
490 chunk size should be at least 64 Kbytes (2 * 32 Kbytes) smaller
491 than the maximum file size, e.g. 2047 Mbytes.
492
494 The amanda.conf file may define multiple sets of backup options and
495 refer to them by name from the disklist file. For instance, one set of
496 options might be defined for file systems that can benefit from high
497 compression, another set that does not compress well, another set for
498 file systems that should always get a full backup and so on.
499 A set of backup options are entered in a dumptype section, which looks
501 like this:
502 define dumptype name {
504 dumptype-option dumptype-value
505 ...
506 }
507 Name is the name of this set of backup options. It is referenced from
509 the disklist file.
510 Some of the options in a dumptype section are the same as those in the
512 main part of amanda.conf. The main option value is used to set the
513 default for all dumptype sections. For instance, setting dumpcycle to
514 50 in the main part of the config file causes all following dumptype
515 sections to start with that value, but the value may be changed on a
516 section by section basis. Changes to variables in the main part of the
517 config file must be done before (earlier in the file) any dumptypes are
518 defined.
519 The dumptype options and values are:
521 auth string
523 Default: bsd. Type of authorization to perform between tape server
524 and backup client hosts.
525 bsd, bsd authorization with udp initial connection and one tcp
527 connection by data stream.
528 bsdtcp, bsd authorization but use only one tcp connection.
530 bsdudp, like bsd, but will use only one tcp connection for all data
532 stream.
533 krb4 to use Kerberos-IV authorization.
535 krb5 to use Kerberos-V authorization.
537 rsh to use rsh authorization.
539 ssh to use OpenSSH authorization.
541 amandad_path string
543 Default: $libexec/amandad. Specify the amandad path of the client,
544 only use with rsh/ssh authentification.
545 client_username string
547 Default: CLIENT_LOGIN. Specify the username to connect on the
548 client, only use with rsh/ssh authentification.
549 bumpsize int
551 Default: 10 Mbytes. The minimum savings required to trigger an
552 automatic bump from one incremental level to the next, expressed as
553 size. If Amanda determines that the next higher backup level will
554 be this much smaller than the current level, it will do the next
555 level. The value of this parameter is used only if the parameter
556 bumppercent is set to 0.
557 See also the options bumppercent, bumpmult and bumpdays.
559 bumppercent int
561 Default: 0 percent. The minimum savings required to trigger an
562 automatic bump from one incremental level to the next, expressed as
563 percentage of the current size of the DLE (size of current level
564 0). If Amanda determines that the next higher backup level will be
565 this much smaller than the current level, it will do the next
566 level.
567 If this parameter is set to 0, the value of the parameter bumpsize
569 is used to trigger bumping.
570 See also the options bumpsize, bumpmult and bumpdays.
572 bumpmult float
574 Default: 1.5. The bump size multiplier. Amanda multiplies bumpsize
575 by this factor for each level. This prevents active filesystems
576 from bumping too much by making it harder to bump to the next
577 level. For example, with the default bumpsize and bumpmult set to
578 2.0, the bump threshold will be 10 Mbytes for level one, 20 Mbytes
579 for level two, 40 Mbytes for level three, and so on.
580 bumpdays int
582 Default: 2 days. To insure redundancy in the dumps, Amanda keeps
583 filesystems at the same incremental level for at least bumpdays
584 days, even if the other bump threshold criteria are met.
585 comment string
587 Default: none. A comment string describing this set of backup
588 options.
589 comprate float [, float ]
591 Default: 0.50, 0.50. The expected full and incremental compression
592 factor for dumps. It is only used if Amanda does not have any
593 history information on compression rates for a filesystem, so
594 should not usually need to be set. However, it may be useful for
595 the first time a very large filesystem that compresses very little
596 is backed up.
597 compress [client|server] string
599 Default: client fast. If Amanda does compression of the backup
600 images, it can do so either on the backup client host before it
601 crosses the network or on the tape server host as it goes from the
602 network into the holding disk or to tape. Which place to do
603 compression (if at all) depends on how well the dump image usually
604 compresses, the speed and load on the client or server, network
605 capacity, holding disk capacity, availability of tape hardware
606 compression, etc.
607 For either type of compression, Amanda also allows the selection of
609 three styles of compression. Best is the best compression
610 available, often at the expense of CPU overhead. Fast is often not
611 as good a compression as best, but usually less CPU overhead. Or to
612 specify Custom to use your own compression method. (See dumptype
613 custom-compress in example/amanda.conf for reference)
614 So the compress options line may be one of:
616 compress none
618 compress client fast
620 compress client best
622 compress client custom
624 Specify client_custom_compress "PROG"
625 PROG must not contain white space and it must accept -d for
627 uncompress.
628 compress server fast
630 compress server best
632 compress server custom
634 Specify server_custom_compress "PROG"
635 PROG must not contain white space and it must accept -d for
637 uncompress.
638 Note that some tape devices do compression and this option has
640 nothing to do with whether that is used. If hardware
641 compression is used (usually via a particular tape device name
642 or mt option), Amanda (software) compression should be
643 disabled.
644 dumpcycle int
646 Default: 10 days. The number of days in the backup cycle. Each disk
647 using this set of options will get a full backup at least this of
648 ten. Setting this to zero tries to do a full backup each run.
649 encrypt [none|client|server]
651 Default: none. To encrypt backup images, it can do so either on the
652 backup client host before it crosses the network or on the tape
653 server host as it goes from the network into the holding disk or to
654 tape.
655 So the encrypt options line may be one of:
657 encrypt none
659 encrypt client
661 Specify client_encrypt "PROG"
662 PROG must not contain white space.
664 Specify client_decrypt_option "decryption-parameter"
666 Default: "-d"
667 decryption-parameter must not contain white space.
669 (See dumptype server-encrypt-fast in example/amanda.conf
671 for reference)
672 encrypt server
674 Specify server_encrypt "PROG"
675 PROG must not contain white space.
677 Specify server_decrypt_option "decryption-parameter"
679 Default: "-d"
680 decryption-parameter must not contain white space.
682 (See dumptype client-encrypt-nocomp in example/amanda.conf
684 for reference)
685 Note that current logic assumes compression then encryption
687 during backup(thus decrypt then uncompress during restore). So
688 specifying client-encryption AND server-compression is not
689 supported. amcrypt which is a wrapper of aespipe is provided
690 as a reference symmetric encryption program.
691 estimate client|calcsize|server
693 Default: client. Determine the way Amanda does it's estimate.
694 client
696 Use the same program as the dumping program, this is the
697 most accurate way to do estimates, but it can take a long
698 time.
699 calcsize
701 Use a faster program to do estimates, but the result is
702 less accurate.
703 server
705 Use only statistics from the previous run to give an
706 estimate, it takes only a few seconds but the result is not
707 accurate if your disk usage changes from day to day.
708 exclude [ list|file ][[optional][ append ][ string ]+]
710 Default: file. There are two exclude lists, exclude file and
711 exclude list. With exclude file , the string is a GNU-tar exclude
712 expression. With exclude list , the string is a file name on the
713 client containing GNU-tar exclude expressions. The path to the
714 specified exclude list file, if present (see description of
715 'optional' below), must be readable by the Amanda user.
716 All exclude expressions are concatenated in one file and passed to
718 GNU-tar as an --exclude-from argument.
719 Exclude expressions must always be specified as relative to the
721 head directory of the DLE.
722 With the append keyword, the string is appended to the current
724 list, without it, the string overwrites the list.
725 If optional is specified for exclude list, then amcheck will not
727 complain if the file doesn't exist or is not readable.
728 For exclude list, if the file name is relative, the disk name being
730 backed up is prepended. So if this is entered:
731 exclude list ".amanda.excludes"
733 the actual file used would be /var/.amanda.excludes for a backup of
734 /var, /usr/local/.amanda.excludes for a backup of /usr/local, and
735 so on.
736 holdingdisk [ never|auto|required ]
738 Default: auto. Whether a holding disk should be used for these
739 backups or whether they should go directly to tape. If the holding
740 disk is a portion of another file system that Amanda is backing up,
741 that file system should refer to a dumptype with holdingdisk set to
742 never to avoid backing up the holding disk into itself.
743 never|no|false|off
745 Never use a holdingdisk, the dump will always go directly
746 to tape. There will be no dump if you have a tape error.
747 auto|yes|true|on
749 Use the holding disk, unless there is a problem with the
750 holding disk, the dump won't fit there or the medium
751 doesn't require spooling (e.g., VFS device)
752 required
754 Always dump to holdingdisk, never directly to tape. There
755 will be no dump if it doesn't fit on holdingdisk
756 ignore boolean
758 Default: no. Whether disks associated with this backup type should
759 be backed up or not. This option is useful when the disklist file
760 is shared among several configurations, some of which should not
761 back up all the listed file systems.
762 include [ list|file ][[optional][ append ][ string ]+]
764 Default: file ".". There are two include lists, include file and
765 include list. With include file , the string is a glob expression.
766 With include list , the string is a file name on the client
767 containing glob expressions.
768 All include expressions are expanded by Amanda, concatenated in one
770 file and passed to GNU-tar as a --files-from argument. They must
771 start with "./" and contain no other "/".
772 Include expressions must always be specified as relative to the
774 head directory of the DLE.
775 Note
777 For globbing to work at all, even the limited single level, the top
778 level directory of the DLE must be readable by the Amanda user.
779 With the append keyword, the string is appended to the current
781 list, without it, the string overwrites the list.
782 If optional is specified for include list, then amcheck will not
784 complain if the file doesn't exist or is not readable.
785 For include list, If the file name is relative, the disk name being
787 backed up is prepended.
788 index boolean
790 Default: no. Whether an index (catalogue) of the backup should be
791 generated and saved in indexdir. These catalogues are used by the
792 amrecover utility.
793 kencrypt boolean
795 Default: no. Whether the backup image should be encrypted by
796 Kerberos as it is sent across the network from the backup client
797 host to the tape server host.
798 maxdumps int
800 Default: 1. The maximum number of backups from a single host that
801 Amanda will attempt to run in parallel. See also the main section
802 parameter inparallel.
803 maxpromoteday int
805 Default: 10000. The maximum number of day for a promotion, set it 0
806 if you don't want promotion, set it to 1 or 2 if your disks get
807 overpromoted.
808 priority string
810 Default: medium. When there is no tape to write to, Amanda will do
811 incremental backups in priority order to the holding disk. The
812 priority may be high (2), medium (1), low (0) or a number of your
813 choice.
814 program string
816 Default: DUMP. The type of backup to perform. Valid values are DUMP
817 for the native operating system backup program, and GNUTAR to use
818 GNU-tar or to do PC backups using Samba.
819 record boolean
821 Default: yes. Whether to ask the backup program to update its
822 database (e.g. /etc/dumpdates for DUMP or
823 /usr/local/var/amanda/gnutar-lists for GNUTAR) of time stamps. This
824 is normally enabled for daily backups and turned off for periodic
825 archival runs.
826 skip-full boolean
828 Default: no. If true and planner has scheduled a full backup, these
829 disks will be skipped, and full backups should be run off-line on
830 these days. It was reported that Amanda only schedules level 1
831 incrementals in this configuration; this is probably a bug.
832 skip-incr boolean
834 Default: no. If true and planner has scheduled an incremental
835 backup, these disks will be skipped.
836 starttime int
838 Default: none. Backups will not start until after this time of day.
839 The value should be hh*100+mm, e.g. 6:30PM (18:30) would be entered
840 as 1830.
841 strategy string
843 Default: standard. Strategy to use when planning what level of
844 backup to run next. Values are:
845 standard
847 The standard Amanda schedule.
848 nofull
850 Never do full backups, only level 1 incrementals.
851 noinc
853 Never do incremental backups, only full dumps.
854 skip
856 Never do backups (useful when sharing the disklist file).
857 incronly
859 Only do incremental dumps. amadmin force should be used to
860 tell Amanda that a full dump has been performed off-line,
861 so that it resets to level 1. It is similar to skip-full,
862 but with incronly full dumps may be scheduled manually.
863 Unfortunately, it appears that Amanda will perform full
864 backups with this configuration, which is probably a bug.
865 tape_splitsize int
867 Default: none. Split dump file on tape into pieces of a specified
868 size. This allows dumps to be spread across multiple tapes, and can
869 potentially make more efficient use of tape space. Note that if
870 this value is too large (more than half the size of the average
871 dump being split), substantial tape space can be wasted. If too
872 small, large dumps will be split into innumerable tiny dumpfiles,
873 adding to restoration complexity. A good rule of thumb, usually, is
874 1/10 of the size of your tape.
875 split_diskbuffer string
877 Default: none. When dumping a split dump in PORT-WRITE mode
878 (usually meaning "no holding disk"), buffer the split chunks to a
879 file in the directory specified by this option.
880 fallback_splitsize int
882 Default: 10M. When dumping a split dump in PORT-WRITE mode, if no
883 split_diskbuffer is specified (or if we somehow fail to use our
884 split_diskbuffer), we must buffer split chunks in memory. This
885 specifies the maximum size split chunks can be in this scenario,
886 and thus the maximum amount of memory consumed for in-memory
887 splitting. The size of this buffer can be changed from its (very
888 conservative) default to a value reflecting the amount of memory
889 that each taper process on the dump server may reasonably consume.
890 The following dumptype entries are predefined by Amanda:
892 define dumptype no-compress {
894 compress none
895 }
896 define dumptype compress-fast {
897 compress client fast
898 }
899 define dumptype compress-best {
900 compress client best
901 }
902 define dumptype srvcompress {
903 compress server fast
904 }
905 define dumptype bsd-auth {
906 auth bsd
907 }
908 define dumptype krb4-auth {
909 auth krb4
910 }
911 define dumptype no-record {
912 record no
913 }
914 define dumptype no-hold {
915 holdingdisk no
916 }
917 define dumptype no-full {
918 skip-full yes
919 }
920 In addition to options in a dumptype section, one or more other
922 dumptype names may be entered, which make this dumptype inherit options
923 from other previously defined dumptypes. For instance, two sections
924 might be the same except for the record option:
925 define dumptype normal {
927 comment "Normal backup, no compression, do indexing"
928 no-compress
929 index yes
930 maxdumps 2
931 }
932 define dumptype testing {
933 comment "Test backup, no compression, do indexing, no recording"
934 normal
935 record no
936 }
937 Amanda provides a dumptype named global in the sample amanda.conf file
939 that all dumptypes should reference. This provides an easy place to
940 make changes that will affect every dumptype.
941
943 The amanda.conf file may define multiple types of tape media and
944 devices. The information is entered in a tapetype section, which looks
945 like this in the config file:
946 define tapetype name {
948 tapetype-option tapetype-value
949 ...
950 }
951 Name is the name of this type of tape medium/device. It is referenced
953 from the tapetype option in the main part of the config file.
954 The tapetype options and values are:
956 comment string
958 Default: none. A comment string describing this set of tape
959 information.
960 filemark int
962 Default: 1 kbytes. How large a file mark (tape mark) is, measured
963 in kbytes. If the size is only known in some linear measurement
964 (e.g. inches), convert it to kbytes using the device density.
965 length int
967 Default: 2000 kbytes. How much data will fit on a tape.
968 Note that this value is only used by Amanda to schedule which
970 backups will be run. Once the backups start, Amanda will continue
971 to write to a tape until it gets an error, regardless of what value
972 is entered for length (but see the section OUTPUT DRIVERS in the
973 amanda(8) manpage for exceptions).
974 blocksize int
976 Default: 32 kbytes. How much data will be written in each tape
977 record expressed in KiloBytes. The tape record size (= blocksize)
978 can not be reduced below the default 32 KBytes. The parameter
979 blocksize can only be raised if Amanda was compiled with the
980 configure option --with-maxtapeblocksize=N set with "N" greater
981 than 32 during configure.
982 file-pad boolean
984 Default: true. If true, every record, including the last one in the
985 file, will have the same length. This matches the way Amanda wrote
986 tapes prior to the availability of this parameter. It may also be
987 useful on devices that only support a fixed blocksize.
988 Note that the last record on the tape probably includes trailing
990 null byte padding, which will be passed back to gzip, compress or
991 the restore program. Most programs just ignore this (although
992 possibly with a warning).
993 If this parameter is false, the last record in a file may be
995 shorter than the block size. The file will contain the same amount
996 of data the dump program generated, without trailing null byte
997 padding. When read, the same amount of data that was written will
998 be returned.
999 speed int
1001 Default: 200 bps. How fast the drive will accept data, in bytes per
1002 second. This parameter is NOT currently used by Amanda.
1003 lbl-templ string
1005 A PostScript template file used by amreport to generate labels.
1006 Several sample files are provided with the Amanda sources in the
1007 example directory. See the amreport(8) man page for more
1008 information.
1009 In addition to options, another tapetype name may be entered, which
1011 makes this tapetype inherit options from another tapetype. For
1012 instance, the only difference between a DLT4000 tape drive using
1013 Compact-III tapes and one using Compact-IV tapes is the length of the
1014 tape. So they could be entered as:
1015 define tapetype DLT4000-III {
1017 comment "DLT4000 tape drives with Compact-III tapes"
1018 length 12500 mbytes # 10 Gig tapes with some compression
1019 filemark 2000 kbytes
1020 speed 1536 kps
1021 }
1022 define tapetype DLT4000-IV {
1023 DLT4000-III
1024 comment "DLT4000 tape drives with Compact-IV tapes"
1025 length 25000 mbytes # 20 Gig tapes with some compression
1026 }
1027
1030 The amanda.conf file may define multiple types of network interfaces.
1031 The information is entered in an interface section, which looks like
1032 this:
1033 define interface name {
1035 interface-option interface-value
1036 ...
1037 }
1038 name is the name of this type of network interface. It is referenced
1040 from the disklist file.
1041 Note that these sections define network interface characteristics, not
1043 the actual interface that will be used. Nor do they impose limits on
1044 the bandwidth that will actually be taken up by Amanda. Amanda
1045 computes the estimated bandwidth each file system backup will take
1046 based on the estimated size and time, then compares that plus any other
1047 running backups with the limit as another of the criteria when deciding
1048 whether to start the backup. Once a backup starts, Amanda will use as
1049 much of the network as it can leaving throttling up to the operating
1050 system and network hardware.
1051 The interface options and values are:
1053 comment string
1055 Default: none. A comment string describing this set of network
1056 information.
1057 use int
1059 Default: 300 Kbps. The speed of the interface in Kbytes per second.
1060 In addition to options, another interface name may be entered, which
1062 makes this interface inherit options from another interface. At the
1063 moment, this is of little use.
1064
1066 James da Silva, <jds@amanda.org>: Original text
1067 Stefan G. Weichinger, <sgw@amanda.org>, maintainer of the
1069 Amanda-documentation: XML-conversion, major update, splitting
1070
1072 amanda(8), amanda-client.conf(5), amcrypt(8), aespipe(1),
1073 02/07/2007 AMANDA.CONF(5)