1AMANDA.CONF(5) File formats and conventions AMANDA.CONF(5)
2
6 amanda.conf - Main configuration file for Amanda, the Advanced Maryland
7 Automatic Network Disk Archiver
8
10 amanda.conf(5) 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>/amanda.conf is loaded if it exists then the files
15 <CONFIG_DIR>/<config>/amanda.conf is loaded.
16
18 There are a number of configuration parameters that control the
19 behavior of the Amanda programs. All have default values, so you need
20 not specify the parameter in amanda.conf if the default is suitable.
21 COMMENTS
23 Lines starting with # are ignored, as are blank lines. Comments may be
24 placed on a line with a directive by starting the comment with a #. The
25 remainder of the line is ignored.
26 KEYWORDS AND IDENTIFIERS
28 Keywords are case insensitive, i.e. mailto and MailTo are treated the
29 same. Also, the characters '-' and '_' are interchangeable in all
30 predefined Amanda keywords: device_property and device-property have
31 the same meaning. This manpage uses the dashed versions, but the
32 underscored versions will be accepted for backward compatibility
33 Identifiers are names which are defined in the configuration itself,
35 such as dumptypes or interfaces. Identifiers are are case-insensitive,
36 but sensitive to '-' vs. '_'. Identifiers should be quoted in the
37 configuration file, although For historical reasons, the quotes are
38 optional.
39 Strings are always quoted with double quotes ("), and any double quotes
41 or backslashes within the string are escaped with a backslash:
42 tapelist "/path/to/tapelist"
44 property "escaped-string" "escaping: \\ (backslash) and \" (double-quote)"
45 To summarize, then:
47 # QUOTES CASE -/_
49 logdir "logs" # required sensitive sensitive
50 send-amreport-on strange # prohibited insensitive insensitive
51 tapetype "EXABYTE" # optional insensitive sensitive
52 define dumptype "dt" { # optional insensitive sensitive
54 "dumptype-common" # optional insensitive sensitive
55 strategy noinc # prohibited insensitive insensitive
56 }
57 VALUE SUFFIXES
59 Integer arguments may have one of the following (case insensitive)
60 suffixes, some of which have a multiplier effect:
61 b byte bytes
63 Some number of bytes.
64 bps
66 Some number of bytes per second.
67 k kb kbyte kbytes kilobyte kilobytes
69 Some number of kilobytes (bytes*1024).
70 kps kbps
72 Some number of kilobytes per second (bytes*1024).
73 It is the default multiplier for all size options.
75 m mb meg mbyte mbytes megabyte megabytes
77 Some number of megabytes (bytes*1024*1024).
78 mps mbps
80 Some number of megabytes per second (bytes*1024*1024).
81 g gb gbyte gbytes gigabyte gigabytes
83 Some number of gigabytes (bytes*1024*1024*1024).
84 t tb tbyte tbytes terabyte terabytes
86 Some number of terabytes (bytes*1024*1024*1024*1024).
87 tape tapes
89 Some number of tapes.
90 day days
92 Some number of days.
93 week weeks
95 Some number of weeks (days*7).
96 Note
98 The value inf may be used in most places where an integer is
99 expected to mean an infinite amount.
100 Boolean arguments may have any of the values 1, y, yes, t, true
102 or on to indicate a true state, or 0, n, no, f, false or off to
103 indicate a false state. If no argument is given, true is
104 assumed.
105 PARAMETER ORDER
107 In general, the order in which parameters occur in the configuration
108 file does not matter, with the exception of subsection inheritance. For
109 example, if dumptype "normal-encrypt" which inherits from dumptype
110 "normal", then "normal" must appear first in the configuration file.
111 STRINGS
113 Quoted strings in Amanda follow a common, C-like syntax. Printable
114 characters and whitespace are kept as-is, except that the backslash
115 character (\) is used as an escape character, and a double-quote ends
116 the string. The allowed escape sequences are
117 ESCAPE SEQUENCE BECOMES
119 \\ \
120 \" "
121 \n (newline)
122 \t (tab)
123 \r (carriage return)
124 \f (form-feed)
125 \1 - \7
126 \01 - \77
127 \001 - \377 (character specified in octal)
128 Illegally quoted strings are handled on a "best-effort" basis, which
129 may lead to unexpected results.
130 Examples:
132 finserver "/data/finance/XYZ Corp's \"real\" finances" finance-high eth0 -1
134 property "syspath" "C:\\WINDOWS\\SYSTEM"
135 SUBSECTIONS AND INHERITANCE
137 Amanda configuration files may include various subsections, each
138 defining a set of configuration directives. Each type of subsection is
139 described below. Note that all types of subsections can inherit from
140 other subsections of the same type by naming the "parent" section in
141 the "child" subsection. For example:
142 define dumptype global {
144 record yes
145 index yes
146 }
147 define dumptype nocomp {
149 global # inherit the parameters in dumptype 'global'
150 compress none
151 }
152 Note that multiple inheritance is also supported by simply naming
154 multiple parent sections in a child. Parents are implicitly expanded in
155 place in a child, and the last occurrence of each parameter takes
156 precedence. For example,
157 define tapetype par1 {
159 comment "Parent 1"
160 filemark 8k
161 speed 300bps
162 length 200M
163 }
164 define tapetype par2 {
165 comment "Parent 2"
166 filemark 16k
167 speed 400bps
168 }
169 define tapetype child {
170 par1
171 par2
172 filemark 32k
173 }
174 In this example, 'child' will have a filemark of 32k, a speed of
175 400bps, and a length of 200M.
176
178 amrecover-changer string
179 Default: not set. Amrecover will use the changer if you use
180 'settape <string>' and that string is the same as the
181 amrecover-changer setting.
182 amrecover-check-label bool
184 Deprecated; amrecover always checks the label, and does not invoke
185 amrestore.
186 Default: on. Amrecover will call amrestore with the -l flag to
188 check the label.
189 amrecover-do-fsf bool
191 Deprecated; amrecover always uses fsf, and does not invoke
192 amrestore.
193 Default: on. Amrecover will call amrestore with the -f flag for
195 faster positioning of the tape.
196 autoflush no|yes|all
198 Default: no. Whether an amdump run will flush the dumps from
199 holding disk to tape. With yes, only dump matching the command line
200 argument are flushed. With all, all dump are flushed.
201 autolabel string [any] [other-config] [non-amanda] [volume-error]
203 [empty]
204 Default: not set. When set, this directive will cause Amanda to
205 automatically write an Amanda tape label to most volume she
206 encounters. This option is DANGEROUS because when set, Amanda may
207 erase near-failing tapes or tapes accidentally loaded in the wrong
208 slot.
209 When using this directive, specify the template for new tape
211 labels. The template can contains many variables that are
212 substituted by their values:
213 $c : config name
215 $o : org configuration
216 $b : barcode of the volume
217 $s : slot number, can specify a minimun number of digit:
218 $3s to get '001'
219 $m : meta label
220 $r : storage name
221 The template can contain some number of contiguous '%' characters,
223 which will be replaced with a generated number (000-999), or some
224 number of contiguous '!', which will be replaced with a generated
225 letter sequence (AAA-ZZZ). Be sure to specify enough '%' or '!'
226 characters that you do not run out of tape labels. Example:
227 "DailySet1-%%%", "DailySet1-!!!", "$c-%%%", "$m-%%%", "$m-$b"
228 The generared label can be used only if it match the labelstr
230 setting. The volume will not be used if the generated label doesn't
231 match the labelstr setting.
232 Note that many devices cannot distinguish an empty tape from an
234 error condition, so it may is often necessary to include
235 volume-error as an autolabel condition.
236 any
238 equivalent to 'other-config non-amanda volume-error empty'
239 other-config
241 Label volumes with a valid Amanda label that do not match our
242 labelstr. Danger: this may erase volumes from other Amanda
243 configurations without warning!
244 non-amanda
246 Label volumes which do not start with data that resembles an
247 Amanda header. Danger: this may erase volumes from other backup
248 applications without warning!
249 volume-error
251 Label volumes where an error occurs while trying to read the
252 label. Danger: this may erase arbitrary volumes due to
253 transient errors.
254 empty
256 Label volumes where a read returns 0 bytes.
257 bumpdays int
259 Default: 2 days. To insure redundancy in the dumps, Amanda keeps
260 filesystems at the same incremental level for at least bumpdays
261 days, even if the other bump threshold criteria are met.
262 The global setting of this parameter can be overwritten inside of a
264 dumptype-definition.
265 bumpmult float
267 Default: 1.5. The bump size multiplier. Amanda multiplies bumpsize
268 by this factor for each level. This prevents active filesystems
269 from bumping too much by making it harder to bump to the next
270 level. For example, with the default bumpsize and bumpmult set to
271 2.0, the bump threshold will be 10 Mbytes for level one, 20 Mbytes
272 for level two, 40 Mbytes for level three, and so on.
273 The global setting of this parameter can be overwritten inside of a
275 dumptype-definition.
276 bumppercent int
278 Default: 0. The minimum savings required to trigger an automatic
279 bump from one incremental level to the next, expressed as
280 percentage of the current size of the DLE (size of current level
281 0). If Amanda determines that the next higher backup level will be
282 this much smaller than the current level, it will do the next
283 level.
284 If this parameter is set to 0, the value of the parameter bumpsize
286 is used to trigger bumping.
287 The global setting of this parameter can be overwritten inside of a
289 dumptype-definition.
290 See also the options bumpsize, bumpmult and bumpdays.
292 bumpsize int
294 Default: 10 Mbytes. The minimum savings required to trigger an
295 automatic bump from one incremental level to the next, expressed as
296 size. If Amanda determines that the next higher backup level will
297 be this much smaller than the current level, it will do the next
298 level. The value of this parameter is used only if the parameter
299 bumppercent is set to 0.
300 The default unit is Kbytes if it is not specified.
302 The global setting of this parameter can be overwritten inside of a
304 dumptype-definition.
305 See also the options bumppercent, bumpmult and bumpdays.
307 changerdev string
309 Default: "dev/null". A tape changer configuration parameter. Usage
310 depends on the particular changer defined with the tpchanger
311 option.
312 changerfile string
314 Default: "changer". This option is deprecated; use the changerfile
315 in the changer section. Only chg-multi use it. A file where the
316 changer store its state.
317 columnspec string
319 default:
320 "HostName=0:-12:12,Disk=1:-11:11,Level=1:-1:1,OrigKB=1:-7:0,OutKB=1:-7:0,Compress=1:-6:1,DumpTime=1:-7:7,Dumprate=1:-6:1,TapeTime=1:-6:6,TapeRate=1:-6:1"
321 Defines the width of columns amreport should use. String is a
323 comma (',') separated list of triples. Each triple consists of four
324 parts which are separated by a equal sign ('=') and a colon (':')
325 (see the example). These four parts specify:
326 1. the name of the column, which may be:
328 Compress (compression ratio)
330 Disk (client disk name)
331 DumpRate (dump rate in KBytes/sec)
332 DumpTime (total dump time in hours:minutes)
333 HostName (client host name)
334 Level (dump level)
335 OrigKB (original image size in KBytes)
336 OutKB (output image size in KBytes)
337 TapeRate (tape writing rate in KBytes/sec)
338 TapeTime (total tape time in hours:minutes)
339 2. the amount of space to display before the column (used to get
341 whitespace between columns).
342 3. the width of the column itself. If set to a negative value, the
344 width will be calculated on demand to fit the largest entry in
345 this column.
346 4. the precision of the column, number of digit after the decimal
348 point for number.
349 Parts may be omitted, and will adopt a default value; trailing
351 colons may also be omitted.
352 Here is an example:
354 columnspec "Disk=1:18,HostName=0:10,OrigKB=::2,OutKB=1:7"
356 The above will display the disk information in 18 characters and
358 put one space before it. The hostname column will be 10 characters
359 wide with no space to the left. The Original KBytes print 2 decimal
360 digit. The output KBytes column is seven characters wide with one
361 space before it.
362 command-file string
364 Default: command_file. A file where amanda store information about
365 running job.
366 See amanda-command-file(5).
368 compress-index boolean
370 Default: yes. Compress all index files, this is useful to save
371 space in the indexdir but require more processing.
372 The compression ratio is generaly above 20x, it is faster to read
374 compressed index files because there is 20 times less data to read
375 from disk.
376 Changing this setting will uncompress/compress all index files.
378 connect-tries int
380 Default: 3. How many times the server will try a connection.
381 ctimeout int
383 Default: 30 seconds. Maximum amount of time that amcheck will wait
384 for each client host.
385 debug-auth int
387 Default: 0. Debug level of the auth module
388 debug-chunker int
390 Default: 0. Debug level of the chunker process
391 debug-days int
393 Default: 3. The number of days the debug files are kept.
394 debug-driver int
396 Default: 0. Debug level of the driver process
397 debug-dumper int
399 Default: 0. Debug level of the dumper process
400 debug-event int
402 Default: 0. Debug level of the event module
403 debug-holding int
405 Default: 0. Debug level of the holdingdisk module
406 debug-planner int
408 Default: 0. Debug level of the planner process
409 debug-protocol int
411 Default: 0. Debug level of the protocol module
412 debug-recovery int
414 Default: 1. Debug level of all recovery process
415 debug-taper int
417 Default: 0. Debug level of the taper process
418 device-output-buffer-size int
420 Default: 1280k. Controls the amount of memory used by Amanda to
421 hold data as it is read from the network or disk before it is
422 written to the output device. Higher values may be useful on fast
423 tape drives and optical media.
424 The default unit is bytes if it is not specified.
426 device-property string string
428 These options can set various device properties. See amanda-
429 devices(7) for more information on device properties and their
430 syntax. Both strings are always quoted; the first string contains
431 the name of the property to set, and the second contains its value.
432 For example, to set a fixed block size of 128k, write:
433 device-property "BLOCK_SIZE" "128k"
434 diskfile string
436 Default: "disklist". The file name for the disklist file holding
437 client hosts, disks and other client dumping information.
438 displayunit "k|m|g|t"
440 Default: "k". The unit used to print many numbers, k=kilo, m=mega,
441 g=giga, t=tera.
442 dtimeout int
444 Default: 1800 seconds. Amount of idle time per disk on a given
445 client that a dumper running from within amdump will wait before it
446 fails with a data timeout error.
447 dumpcycle int
449 Default: 10 days. The number of days in the backup cycle. Each disk
450 will get a full backup at least this often. Setting this to zero
451 tries to do a full backup each run.
452 Note
454 This parameter may also be set in a specific dumptype (see
455 below). This value sets the default for all dumptypes so must
456 appear in amanda.conf before any dumptypes are defined.
457 dumporder string
459 Default: "tttTTTTTTT". The priority order of each dumper:
460 s: smallest size
462 S: largest size
463 t: smallest time
464 T: largest time
465 b: smallest bandwidth
466 B: largest bandwidth
467 dumpuser string
469 Default: "amanda". The login name Amanda uses to run the backups.
470 The backup client hosts must allow access from the tape server host
471 as this user via .rhosts or .amandahosts, depending on how the
472 Amanda software was built.
473 eject-volume bool
475 Default: no. Set to yes if you want the volume to be ejected after
476 Amanda wrote data to it. It works only with some changer and
477 device.
478 etimeout int
480 Default: 300 seconds. Amount of time per estimate on a given client
481 that the planner step of amdump will wait to get the dump size
482 estimates (note: Amanda runs up to 3 estimates for each DLE). For
483 instance, with the default of 300 seconds and four DLE's, each
484 estimating level 0 and level 1 on client A, planner will wait up to
485 40 minutes for that machine. A negative value will be interpreted
486 as a total amount of time to wait per client instead of per disk.
487 flush-threshold-dumped int
489 Default: 0. Amanda will not begin writing data to a new volume
490 until the amount of data on the holding disk is at least this
491 percentage of the volume size and the criterion for
492 flush-threshold-scheduled is also met. In other words, Amanda will
493 not begin until the amount of data on the holding disk is greater
494 than the tape length times this parameter. This parameter may be
495 larger than 100%, for example to keep more recent dumps on the
496 holding disk for faster recovery.
497 Needless to say, your holding disk must be big enough that this
499 criterion could be satisfied. If the holding disk cannot be used
500 for a particular dump (because, for example, there is no remaining
501 holding space) then Amanda will disregard the constraint specified
502 by this setting and start a new volume anyway. Once writing to a
503 volume has begun, this constraint is not applied unless and until a
504 new volume is needed.
505 The value of this parameter may not exceed than that of the
507 flush-threshold-scheduled parameter.
508 flush-threshold-scheduled int
510 Default: 0. Amanda will not begin writing data to a new volume
511 until the sum of the amount of data on the holding disk and the
512 estimated amount of data remaining to be dumped during this run is
513 at least this percentage of the volume size and the criterion for
514 flush-threshold-dumped is also met. In other words, Amanda will not
515 begin until the inequality h + s > t × d is satisfied, where h is
516 the amount of data on the holding disk, s is the total amount of
517 data scheduled for this run but not dumped yet, t is the capacity
518 of a volume, and d is this parameter, expressed as a percentage.
519 This parameter may be larger than 100%.
520 Needless to say, your holding disk must be big enough that this
522 criterion could be satisfied. If the holding disk cannot be used
523 for a particular dump (because, for example, there is no remaining
524 holding space) then Amanda will disregard the constraint specified
525 by this setting and start a new volume anyway. Once writing to a
526 volume has begun, this constraint is not applied unless and until a
527 new volume is needed.
528 The value of this parameter may not be less than that of the
530 flush-threshold-dumped or taperflush parameters.
531 includefile string
533 Default: no default. The name of an Amanda configuration file to
534 include within the current file. Useful for sharing dumptypes,
535 tapetypes and interface definitions among several configurations.
536 Relative pathnames are relative to the configuration directory.
537 indexdir string
539 Default "/usr/adm/amanda/index". The directory where index files
540 (backup image catalogues) are stored. Index files are only
541 generated for filesystems whose dumptype has the index option
542 enabled.
543 infofile string
545 Default: "/usr/adm/amanda/curinfo". The file or directory name for
546 the historical information database. If Amanda was configured to
547 use DBM databases, this is the base file name for them. If it was
548 configured to use text formatted databases (the default), this is
549 the base directory and within here will be a directory per client,
550 then a directory per disk, then a text file of data.
551 inparallel int
553 Default: 10. The maximum number of backups that Amanda will attempt
554 to run in parallel. Amanda will stay within the constraints of
555 network bandwidth and holding disk space available, so it doesn't
556 hurt to set this number a bit high. Some contention can occur with
557 larger numbers of backups, but this effect is relatively small on
558 most systems.
559 interactivity string
561 Default: not set. The interactivity module Amanda should use to
562 interact with the user. See amanda-interactivity(7) for a list of
563 modules.
564 labelstr string | MATCH-AUTOLABEL
566 Default: MATCH-AUTOLABEL. The tape label constraint regular
567 expression. All tape labels generated (see amlabel(8)) and used by
568 this configuration must match the regular expression. All autolabel
569 variable can be used. The keywork MATCH-AUTOLABEL use the autolabel
570 template as expression.
571 If multiple configurations are run from the same tape server host,
573 it is helpful to set their labels to different strings (for
574 example, "DAILY[0-9][0-9]*" vs. "ARCHIVE[0-9][0-9]*") to avoid
575 overwriting each other's tapes.
576 label-new-tapes string
578 Deprecated, use autolabel option with options volume-error empty to
579 get equivalent behavior.
580 Default: not set. When set, this directive will cause Amanda to
582 automatically write an Amanda tape label to any blank tape she
583 encounters.
584 logdir string
586 Default: "/usr/adm/amanda". The directory for the amdump and log
587 files.
588 mailer string
590 Default found by configure. A mail program that can send mail with
591 'MAILER -s "subject" user < message_file'.
592 mailto string
594 Default: none. A space separated list of recipients for mail
595 reports. If not specified, amdump will not send any mail.
596 maxdumps int
598 Default: 1. The maximum number of backups from a single host that
599 Amanda will attempt to run in parallel. See also the inparallel
600 option.
601 Note that this parameter may also be set in a specific dumptype
603 (see below). This value sets the default for all dumptypes so must
604 appear in amanda.conf before any dumptypes are defined.
605 maxdumpsize int
607 Default: runtapes*tape-length. Maximum number of bytes the planner
608 will schedule for a run.
609 The default unit is Kbytes if it is not specified.
611 max-dle-by-volume int
613 Default: 1000000000. The maximum number of dle written to a single
614 volume.
615 meta-autolabel string
617 Default: not set. When set and if the changer support meta-label,
618 this directive will cause Amanda to automatically add a meta-label
619 to a meta-volume.
620 A meta-volume is a containers that contains many volumes, eg. a
622 removable hard-disk for use with chg-disk, each hard disk have many
623 slots (volume). The meta-label is the label to put on the
624 meta-volume.
625 When using this directive, specify the template for new meta
627 labels. The template can contains many variables that are
628 substituted by their values:
629 $c : config name
631 $o : org configuration
632 $r : storage name
633 The template can contain some number of contiguous '%' characters,
635 which will be replaced with a generated number (000-999), or some
636 number of contiguous '!', which will be replaced with a generated
637 letter sequence (AAA-ZZZ). Be sure to specify enough '%' characters
638 that you do not run out of meta labels. Example: "DailySet1-%%%",
639 "DailySet1-!!!", "$o-%%%", "$o-!!!", "$c-!!!",
640 netusage int
642 Default: 80000 Kbps. The maximum network bandwidth allocated to
643 Amanda, in Kbytes per second. See also the interface section.
644 org string
646 Default: "daily". A descriptive name for the configuration. This
647 string appears in the Subject line of mail reports. Each Amanda
648 configuration should have a different string to keep mail reports
649 distinct.
650 printer string
652 Printer to use when doing tape labels. See the lbl-templ tapetype
653 option.
654 property [append] string string+
656 These options can set various properties, they can be used by third
657 party software to store information in the configuration file. Both
658 strings are quoted; the first string contains the name of the
659 property to set, and the others contains its values. append
660 keyword append the values to the list of values for that property.
661 recovery-limit [ string | same-host | server]
663 Default: none (no limitations). This parameter limits the hosts
664 that may do recoveries. Hosts are identified by their authenticated
665 peer name, as described in amanda-auth(7); if this is not available
666 and the recovery-limit parameter is present, recovery will be
667 denied. The arguments to the parameter are strings giving host
668 match expressions (see amanda-match(7)) or the special keywords
669 same-host or server. The same-host keyword requires an exact match
670 to the hostname of the DLE being recovered. The server keyword
671 require the connection come from the fqdn of the server. Specifying
672 no arguments at all will disable all recoveries from any host.
673 Note that match expressions can be constructed to be forgiving of
675 e.g., fully-qualified vs. unqualified hostnames, but same-host
676 requires an exact match.
677 The error messages that appear in amrecover are intentionally vague
679 to avoid information leakage. Consult the amindexd debug log for
680 more details on the reasons a recovery was rejected.
681 Recovery limits can be refined on a per-DLE basis using the
683 dumptype parameter of the same name. Note that the default value
684 will apply to any dumpfiles for disks which no longer appear in the
685 disklist; thus leaving the global parameter at its default value
686 but setting it for all DLEs is not sufficient to maintain secure
687 backups.
688 report-format [append] string+
690 Default: Not set. The formats amdump, amflush and amvault use when
691 invoking amreport.
692 report-next-media boolean
694 Default: True if max-dle-by-volume is not set, False if it is set.
695 If the reporter must print the list of media expected for the next
696 run.
697 report-use-media boolean
699 Default: True if max-dle-by-volume is not set, False if it is set.
700 If the reporter must print the list of media used in the run.
701 req-tries int
703 Default: 3. How many times the server will resend a REQ packet if
704 it doesn't get the ACK packet.
705 reserve int
707 Default: 100. The part of holding-disk space that should be
708 reserved for incremental backups if no tape is available, expressed
709 as a percentage of the available holding-disk space (0-100). By
710 default, when there is no tape to write to, degraded mode
711 (incremental) backups will be performed to the holding disk. If
712 full backups should also be allowed in this case, the amount of
713 holding disk space reserved for incrementals should be lowered.
714 reserved-tcp-port int,int
716 Default: --with-low-tcpportrange or 512,1023. Reserved tcp port
717 that will be used (bsdtcp). Range is inclusive.
718 reserved-udp-port int,int
720 Default: --with-udpportrange or 512,1023. Reserved udp port that
721 will be used (bsd, bsdudp). Range is inclusive.
722 runspercycle int
724 Default: same as dumpcycle. The number of amdump runs in dumpcycle
725 days. A value of 0 means the same value as dumpcycle. A value of -1
726 means guess the number of runs from the tapelist(5) file, which is
727 the number of tapes used in the last dumpcycle days / runtapes.
728 rest-api-port int
730 No default. The port number the rest server will listen to, it must
731 be an unused port.
732 runtapes int
734 Default: 1. The maximum number of tapes used in a single run. If a
735 tape changer is not configured, this option is not used and should
736 be commented out of the configuration file.
737 If a tape changer is configured, this may be set larger than one to
739 let Amanda write to more than one tape.
740 Note that this is an upper bound on the number of tapes, and Amanda
742 may use less.
743 send-amreport-on [ all | strange | error | never ]
745 Default: all. Specify which types of messages will trigger an email
746 from amreport. amreport is used by amdump and amflush.
747 all
749 Send an email on any message.
750 strange
752 Send an email on strange or error message. A strange message
753 occurs when the dump succeeded, but returned one or more errors
754 unknown to Amanda.
755 error
757 Send an email only on error messages.
758 never
760 Never send an email.
761 sort-index boolean
763 Default: no. Sort all index files, this make amrecover start faster
764 on big filesystem but it require more processing at backup time.
765 Changing this setting can sort all index files.
766 storage string+
768 Default: Same as the config name. The list of storages to use, the
769 dump will go to theses storages.
770 active-storage string+
772 Default: Same as the configured storage setting and the -ostorage=
773 command line setting. The list of storages where a dump can be put.
774 amdump keep the dump in holding disk if the storage is not also
775 listed in storage
776 tapebufs int
778 Default: 20. This option is deprecated; use the
779 device-output-buffer-size directive instead. tapebufs works the
780 same way, but the number specified is multiplied by the device
781 blocksize prior to use.
782 tapecycle int
784 Default: 15 tapes. Specifies the number of "active" volumes -
785 volumes that Amanda will not overwrite. While Amanda is always
786 willing to write to a new volume, it refuses to overwrite a volume
787 unless at least 'tapecycle -1' volumes have been written since.
788 It is considered good administrative practice to set the tapecycle
790 parameter slightly lower than the actual number of tapes in use.
791 This allows the administrator to more easily cope with damaged or
792 misplaced tapes or schedule adjustments that call for slight
793 adjustments in the rotation order.
794 Note: Amanda is commonly misconfigured with tapecycle equal to the
796 number of tapes per dumpcycle. In this misconfiguration, amanda may
797 erase a full dump before a new one is completed. Recovery is then
798 impossible. The tapecycle must be at least one tape larger than the
799 number of tapes per dumpcycle.
800 The number of tapes per dumpcycle is calculated by multiplying the
802 number of amdump runs per dump cycle runspercycle (the number of
803 amdump runs per dump cycle) and runtapes (the number of tapes used
804 per run). Typically tapecycle is set to two or four times the tapes
805 per dumpcycle.
806 tapedev string
808 Default: "null:". This parameter can either specify a device
809 (explicitly or by referencing a device definition - see amanda-
810 devices(7)) or a tape changer (explicitly or by referencing a
811 device definition - see amanda-changers(7)).
812 tapelist string
814 Default: "tapelist". The file name for the active tapelist(5).
815 Amanda maintains this file with information about the active set of
816 tapes.
817 taperalgo [ first | firstfit | largest | largestfit | smallest | last ]
819 Default: first. The algorithm used to choose which dump image to
820 send to the taper.
821 first
823 First in, first out.
824 firstfit
826 The first dump image that will fit on the current tape.
827 largest
829 The largest dump image.
830 largestfit
832 The largest dump image that will fit on the current tape.
833 smallest
835 The smallest dump image.
836 last
838 Last in, first out.
839 taperflush int
841 Default: 0. At the end of a run, Amanda will start a new tape to
842 flush remaining data if there is more data on the holding disk at
843 the end of a run than this setting allows; the amount is specified
844 as a percentage of the capacity of a single volume. In other words,
845 at the end of a run, Amanda will begin a new tape if the inequality
846 h > t × f is satisfied, where h is the amount of data remaining on
847 the holding disk from this or previous runs, t is the capacity of a
848 volume, and f is this parameter, expressed as a percentage. This
849 parameter may be greater than 100%.
850 The value of this parameter may not exceed that of the
852 flush-threshold-scheduled parameter.; autoflush must be set to
853 'yes' if taperflush is greater than 0.
854 taperscan string
856 Default: traditional. The taperscan module amanda should use to
857 find a tape to write to. See amanda-taperscan(7) for a list of
858 modules.
859 taper-parallel-write int
861 Default: 1. Amanda can write simultaneously up to that number of
862 volume at any given time. The changer must have as many drives.
863 tapetype string
865 Default: no default. The type of tape drive associated with tapedev
866 or tpchanger. This refers to one of the defined tapetypes in the
867 config file (see below), which specify various tape parameters,
868 like the length, filemark size, and speed of the tape media and
869 device.
870 tmpdir string
872 Default: none (system default). Set it to a directory with lots of
873 free space if sort in amindexd fail with 'No space left on device'.
874 tpchanger string
876 Default: not set. (deprecated) The tape changer to use. In most
877 cases, only one of tpchanger or tapedev is specified, although for
878 backward compatibility both may be specified if tpchanger gives the
879 name of an old changer script. See amanda-changers(7) for more
880 information on configuring changers.
881 unreserved-tcp-port int,int
883 Default: --with-tcpportrange or 1024,65535. Unreserved tcp port
884 that will be used (bsd, bsdudp). Range is inclusive.
885 usetimestamps bool
887 Default: Yes. Deprecated, the value is always Yes. This option
888 allows Amanda to track multiple runs per calendar day.
889 vault-storage string+
891 Default: not set. The list of storages to vault to.
892 After writing to the storages listed in the storage parameter,
894 amdump will automatically write all pending dumps to the vault
895 storage(s). (These dumps are queued for vaulting based on the vault
896 option specified in the definition section for the primary storage
897 and the dump-selection option specified on the vault storage.)
898 (amvault also uses the first storage in the vault-storage list as
900 its default destination storage.)
901
903 The amanda.conf file may define one or more holding disks used as
904 buffers to hold backup images before they are written to tape. The
905 syntax is:
906 define holdingdisk name {
907 holdingdisk-option holdingdisk-value
908 ...
909 }
910 The { must appear at the end of a line, and the } on its own line.
912 Name is a logical name for this holding disk.
914 The options and values are:
916 comment string
918 Default: not set. A comment string describing this holding disk.
919 chunksize int
921 Default: 1 Gb. Holding disk chunk size. Dumps larger than the
922 specified size will be stored in multiple holding disk files. The
923 size of each chunk will not exceed the specified value. However,
924 even though dump images are split in the holding disk, they are
925 concatenated as they are written to tape, so each dump image still
926 corresponds to a single continuous tape section.
927 The default unit is Kbytes if it is not specified.
929 If 0 is specified, Amanda will create holding disk chunks as large
931 as ((INT_MAX/1024)-64) Kbytes.
932 Each holding disk chunk includes a 32 Kbyte header, so the minimum
934 chunk size is 64 Kbytes (but that would be really silly).
935 Operating systems that are limited to a maximum file size of 2
937 Gbytes actually cannot handle files that large. They must be at
938 least one byte less than 2 Gbytes. Since Amanda works with 32 Kbyte
939 blocks, and to handle the final read at the end of the chunk, the
940 chunk size should be at least 64 Kbytes (2 * 32 Kbytes) smaller
941 than the maximum file size, e.g. 2047 Mbytes.
942 directory string
944 Default: "/dumps/amanda". The path to this holding area.
945 use int
947 Default: 0 Gb. Amount of space that can be used in this holding
948 disk area. If the value is zero, all available space on the file
949 system is used. If the value is negative, Amanda will use all
950 available space minus that value.
951 chunksize int
953 Default: 1 Gb. Holding disk chunk size. Dumps larger than the
954 specified size will be stored in multiple holding disk files. The
955 size of each chunk will not exceed the specified value. However,
956 even though dump images are split in the holding disk, they are
957 concatenated as they are written to tape, so each dump image still
958 corresponds to a single continuous tape section.
959 The default unit is Kbytes if it is not specified.
961 If 0 is specified, Amanda will create holding disk chunks as large
963 as ((INT_MAX/1024)-64) Kbytes.
964 Each holding disk chunk includes a 32 Kbyte header, so the minimum
966 chunk size is 64 Kbytes (but that would be really silly).
967 Operating systems that are limited to a maximum file size of 2
969 Gbytes actually cannot handle files that large. They must be at
970 least one byte less than 2 Gbytes. Since Amanda works with 32 Kbyte
971 blocks, and to handle the final read at the end of the chunk, the
972 chunk size should be at least 64 Kbytes (2 * 32 Kbytes) smaller
973 than the maximum file size, e.g. 2047 Mbytes.
974
976 The amanda.conf(5) file may define multiple sets of backup options and
977 refer to them by name from the disklist(5) file. For instance, one set
978 of options might be defined for file systems that can benefit from high
979 compression, another set that does not compress well, another set for
980 file systems that should always get a full backup and so on.
981 A set of backup options are entered in a dumptype section, which looks
983 like this:
984 define dumptype "name" {
985 dumptype-option dumptype-value
986 ...
987 }
988 The { must appear at the end of a line, and the } on its own line.
990 Name is the name of this set of backup options. It is referenced from
992 the disklist(5) file.
993 Some of the options in a dumptype section are the same as those in the
995 main part of amanda.conf(5). The main option value is used to set the
996 default for all dumptype sections. For instance, setting dumpcycle to
997 50 in the main part of the config file causes all following dumptype
998 sections to start with that value, but the value may be changed on a
999 section by section basis. Changes to variables in the main part of the
1000 config file must be done before (earlier in the file) any dumptypes are
1001 defined.
1002 The dumptype options and values are:
1004 allow-split bool
1006 Default: true. If true, then dumps with this dumptype can be split
1007 on the storage media. If false, then the dump will be written in a
1008 single file on the media. See "Dump Splitting Configuration" below.
1009 application string
1011 No default. Must be the name of an application if program is set to
1012 APPLICATION. See APPLICATION SECTION below.
1013 auth string
1015 Default: "bsdtcp". Type of authorization to perform between tape
1016 server and backup client hosts. See amanda-auth(7) for more detail.
1017 amandad-path string
1019 Default: "$libexec/amandad". Specify the amandad path of the
1020 client, only use with rsh/ssh authentification.
1021 bumpdays int
1023 Default: 2 days. To insure redundancy in the dumps, Amanda keeps
1024 filesystems at the same incremental level for at least bumpdays
1025 days, even if the other bump threshold criteria are met.
1026 bumpmult float
1028 Default: 1.5. The bump size multiplier. Amanda multiplies bumpsize
1029 by this factor for each level. This prevents active filesystems
1030 from bumping too much by making it harder to bump to the next
1031 level. For example, with the default bumpsize and bumpmult set to
1032 2.0, the bump threshold will be 10 Mbytes for level one, 20 Mbytes
1033 for level two, 40 Mbytes for level three, and so on.
1034 bumppercent int
1036 Default: 0. The minimum savings required to trigger an automatic
1037 bump from one incremental level to the next, expressed as
1038 percentage of the current size of the DLE (size of current level
1039 0). If Amanda determines that the next higher backup level will be
1040 this much smaller than the current level, it will do the next
1041 level.
1042 If this parameter is set to 0, the value of the parameter bumpsize
1044 is used to trigger bumping.
1045 See also the options bumpsize, bumpmult and bumpdays.
1047 bumpsize int
1049 Default: 10 Mbytes. The minimum savings required to trigger an
1050 automatic bump from one incremental level to the next, expressed as
1051 size. If Amanda determines that the next higher backup level will
1052 be this much smaller than the current level, it will do the next
1053 level. The value of this parameter is used only if the parameter
1054 bumppercent is set to 0.
1055 The default unit is Kbytes if it is not specified.
1057 See also the options bumppercent, bumpmult and bumpdays.
1059 client-port [ int | string ]
1061 Default: "amanda". Specifies the port to connect to on the client.
1062 It can be a service name or a numeric port number.
1063 client-custom-compress string
1065 Default: none. The program to use to perform
1066 compression/decompression on the client; used with "compress client
1067 custom". Must not contain whitespace. Must accept -d to uncompress.
1068 client-decrypt-option string
1070 Default: -d. The option that can be passed to client-encrypt to
1071 make it decrypt instead. Must not contain whitespace.
1072 client-encrypt string
1074 Default: none. The program to use to perform encryption/decryption
1075 on the client; used with "encrypt client". Must not contain
1076 whitespace.
1077 client-username string
1079 Default: CLIENT_LOGIN. Specify the username to connect on the
1080 client, only use with rsh/ssh authentification.
1081 comment string
1083 Default: not set. A comment string describing this set of backup
1084 options.
1085 comprate float [, float ]
1087 Default: 0.50, 0.50. The expected full and incremental compression
1088 factor for dumps. It is only used if Amanda does not have any
1089 history information on compression rates for a filesystem, so
1090 should not usually need to be set. However, it may be useful for
1091 the first time a very large filesystem that compresses very little
1092 is backed up.
1093 compress [ none | client | server ] [ best | fast | custom ]
1095 Default: client fast. If Amanda does compression of the backup
1096 images, it can do so either on the backup client host before it
1097 crosses the network or on the tape server host as it goes from the
1098 network into the holding disk or to tape. Which place to do
1099 compression (if at all) depends on how well the dump image usually
1100 compresses, the speed and load on the client or server, network
1101 capacity, holding disk capacity, availability of tape hardware
1102 compression, etc.
1103 For either type of compression, Amanda also allows the selection of
1105 three styles of compression. best is the best compression
1106 available, often at the expense of CPU overhead. fast is often not
1107 as good a compression as best, but usually less CPU overhead. Or to
1108 specify custom to use your own compression method. (See dumptype
1109 custom-compress in example/amanda.conf for reference)
1110 So the compress options line may be one of:
1112 compress none
1114 compress client fast
1116 compress client best
1118 compress client custom
1120 Specify client-custom-compress "PROG"
1121 PROG must not contain white space and it must accept -d for
1123 uncompress.
1124 compress server fast
1126 compress server best
1128 compress server custom
1130 Specify server-custom-compress "PROG"
1131 PROG must not contain white space and it must accept -d for
1133 uncompress.
1134 Note that some tape devices do compression and this option has
1136 nothing to do with whether that is used. If hardware compression is
1137 used (usually via a particular tape device name or mt option),
1138 Amanda (software) compression should be disabled.
1139 dumpcycle int
1141 Default: 10 days. The number of days in the backup cycle. Each disk
1142 using this set of options will get a full backup at least this of
1143 ten. Setting this to zero tries to do a full backup each run.
1144 dump-limit [ server | same-host ]*
1146 Default: server. Specify which host can initiate a backup of the
1147 dle. With server, the server can initiate a backup with the amdump
1148 command. With same-host, the client can initiate a backup with the
1149 amdump_client command.
1150 encrypt [ none | client | server ]
1152 Default: not set. To encrypt backup images, it can do so either on
1153 the backup client host before it crosses the network or on the tape
1154 server host as it goes from the network into the holding disk or to
1155 tape.
1156 So the encrypt options line may be one of:
1158 encrypt none
1160 encrypt client
1162 Specify client-encrypt "PROG"
1163 PROG must not contain white space.
1165 Specify client-decrypt-option "decryption-parameter" Default:
1167 "-d"
1168 decryption-parameter must not contain white space.
1170 (See dumptype client-encrypt-nocomp in example/amanda.conf for
1172 reference)
1173 encrypt server
1175 Specify server-encrypt "PROG"
1176 PROG must not contain white space.
1178 Specify server-decrypt-option "decryption-parameter" Default:
1180 "-d"
1181 decryption-parameter must not contain white space.
1183 (See dumptype server-encrypt-fast in example/amanda.conf for
1185 reference)
1186 Note that current logic assumes compression then encryption during
1188 backup(thus decrypt then uncompress during restore). So specifying
1189 client-encryption AND server-compression is not supported. amcrypt
1190 which is a wrapper of aespipe is provided as a reference symmetric
1191 encryption program.
1192 estimate [ client | calcsize | server ]+
1194 Default: client. Determine the way Amanda estimates the size of
1195 each DLE before beginning a backup. This is a list of acceptable
1196 estimate methods, and Amanda applies the first method supported by
1197 the application. The methods are:
1198 client
1200 Use the same program as the dumping program. This is the most
1201 accurate method to do estimates, but it can take a long time.
1202 calcsize
1204 Use a faster program to do estimates, but the result is less
1205 accurate.
1206 server
1208 Use only statistics from the previous few runs to give an
1209 estimate. This very quick, but the result is not accurate if
1210 your disk usage changes from day to day. If this method is
1211 specified, but the server does not have enough data to make an
1212 estimate, then the option is internally moved to the end of the
1213 list, thereby preferring 'client' or 'calcsize' in this case.
1214 exclude [ list | file ][[optional][append][ string ]+]
1216 Default: file. Exclude is the opposite of include and specifies
1217 files that will be excluded from the backup. The format of the
1218 exclude expressions depends on the application, and some
1219 applications do not support excluding files at all.
1220 There are two exclude parameters, exclude file and exclude list.
1222 With exclude file, the string is an exclude expression. With
1223 exclude list , the string is a file name on the client containing
1224 GNU-tar exclude expressions. The path to the specified exclude list
1225 file, if present (see description of 'optional' below), must be
1226 readable by the Amanda user.
1227 All exclude expressions are concatenated in one file and passed to
1229 the application as an --exclude-from argument.
1230 For GNU-tar, exclude expressions must always be specified as
1232 relative to the top-level directory of the DLE, and must start with
1233 "./". See the manpages for individual applications for more
1234 information on supported exclude expressions.
1235 With the append keyword, the string is appended to the current
1237 list, without it, the string overwrites the list.
1238 If optional is specified for exclude list, then amcheck will not
1240 complain if the file doesn't exist or is not readable.
1241 For exclude list, if the file name is relative, the disk name being
1243 backed up is prepended. So if this is entered:
1244 exclude list ".amanda.excludes"
1245 the actual file used would be /var/.amanda.excludes for a backup of
1246 /var, /usr/local/.amanda.excludes for a backup of /usr/local, and
1247 so on.
1248 fallback-splitsize int
1250 Deprecated. See "Dump Splitting Configuration" below.
1251 Default: 10M. This specifies the part size used when no
1253 split-diskbuffer is specified, or when it is too small or does not
1254 exist, and thus the maximum amount of memory consumed for in-memory
1255 splitting. The default unit is Kbytes if it is not specified.
1256 holdingdisk [ never | auto | required ]
1258 Default: auto. Whether a holding disk should be used for these
1259 backups or whether they should go directly to tape. If the holding
1260 disk is a portion of another file system that Amanda is backing up,
1261 that file system should refer to a dumptype with holdingdisk set to
1262 never to avoid backing up the holding disk into itself.
1263 never|no|false|off
1265 Never use a holdingdisk, the dump will always go directly to
1266 tape. There will be no dump if you have a tape error.
1267 auto|yes|true|on
1269 Use the holding disk, unless there is a problem with the
1270 holding disk, the dump won't fit there or the medium doesn't
1271 require spooling (e.g., VFS device)
1272 required
1274 Always dump to holdingdisk, never directly to tape. There will
1275 be no dump if it doesn't fit on holdingdisk
1276 ignore boolean
1278 Default: no. Whether disks associated with this backup type should
1279 be backed up or not. This option is useful when the disklist file
1280 is shared among several configurations, some of which should not
1281 back up all the listed file systems.
1282 include [ list | file ][[optional][append][ string ]+]
1284 Default: file ".". There are two include lists, include file and
1285 include list. With include file , the string is a glob expression.
1286 With include list , the string is a file name on the client
1287 containing glob expressions.
1288 All include expressions are expanded by Amanda, concatenated in one
1290 file and passed to GNU-tar as a --files-from argument. They must
1291 start with "./" and contain no other "/".
1292 Include expressions must always be specified as relative to the
1294 head directory of the DLE.
1295 Note
1297 For globbing to work at all, even the limited single level, the
1298 top level directory of the DLE must be readable by the Amanda
1299 user.
1300 With the append keyword, the string is appended to the current
1301 list, without it, the string overwrites the list.
1302 If optional is specified for include list, then amcheck will not
1304 complain if the file doesn't exist or is not readable.
1305 For include list, If the file name is relative, the disk name being
1307 backed up is prepended.
1308 index boolean
1310 Default: no. Whether an index (catalogue) of the backup should be
1311 generated and saved in indexdir. These catalogues are used by the
1312 amrecover utility.
1313 kencrypt boolean
1315 Default: no. Whether the backup image should be encrypted by
1316 Kerberos as it is sent across the network from the backup client
1317 host to the tape server host.
1318 maxdumps int
1320 Default: 1. The maximum number of backups from a single host that
1321 Amanda will attempt to run in parallel. See also the main section
1322 parameter inparallel.
1323 maxpromoteday int
1325 Default: 10000. The maximum number of day for a promotion, set it 0
1326 if you don't want promotion, set it to 1 or 2 if your disks get
1327 overpromoted.
1328 max-warnings int
1330 Default: 20. The maximum number of error lines in the report for a
1331 dle. A value of '0' means unlimited. This is useful to reduce the
1332 size of the log file and the size of the report. All errors are put
1333 in separate files if a dle have more errors.
1334 priority [ low | medium | high ]
1336 Default: medium. When there is no tape to write to, Amanda will do
1337 incremental backups in priority order to the holding disk. The
1338 priority may be high (2), medium (1), low (0) or a number of your
1339 choice.
1340 program [ "DUMP" | "GNUTAR" | "APPLICATION" ]
1342 Default: "DUMP". The type of backup to perform. Valid values are:
1343 "DUMP"
1345 The native operating system backup program.
1346 "GNUTAR"
1348 To use GNU-tar or to do PC backups using Samba.
1349 "APPLICATION"
1351 To use an application, see the application option.
1352 property [append] [ hidden | visible ] string string+
1354 These options can set various properties, they can be used by third
1355 party software to store information in the configuration file. Both
1356 strings are quoted; the first string contains the name of the
1357 property to set, and the others contains its values. append
1358 keyword append the values to the list of values for that property.
1359 With hidden (the default), the property are not put in the amanda
1361 dump header and in the log/debug files. With visible, they are put
1362 in the amanda dump header and in the log/debug files. Use hidden if
1363 the property must be kept secret.
1364 record boolean
1366 Default: yes. Whether to ask the backup program to update its
1367 database (e.g. /etc/dumpdates for DUMP or
1368 /usr/local/var/amanda/gnutar-lists for GNUTAR) of time stamps. This
1369 is normally enabled for daily backups and turned off for periodic
1370 archival runs.
1371 recovery-limit [ server | same-host | string ]*
1373 Default: global value. This parameter overrides the global
1374 recovery-limit parameter for DLEs of this dumptype.
1375 retry-dump int
1377 Default: 2. The number of times a backup is tried in case of
1378 failure.
1379 script string
1381 No default. Must be the name of a script. You can have many script.
1382 See SCRIPT SECTION below.
1383 server-custom-compress string
1385 Default: none. The program to use to perform
1386 compression/decompression on the server; used with "compress server
1387 custom". Must not contain whitespace. Must accept -d to uncompress.
1388 server-decrypt-option string
1390 Default: -d. The option that can be passed to server-encrypt to
1391 make it decrypt instead. Must not contain whitespace.
1392 server-encrypt string
1394 Default: none. The program to use to perform encryption/decryption
1395 on the server; used with "encrypt server". Must not contain
1396 whitespace.
1397 skip-full boolean
1399 Default: no. If true and planner has scheduled a full backup, these
1400 disks will be skipped, and full backups should be run off-line on
1401 these days. It was reported that Amanda only schedules level 1
1402 incrementals in this configuration; this is probably a bug.
1403 skip-incr boolean
1405 Default: no. If true and planner has scheduled an incremental
1406 backup, these disks will be skipped.
1407 split-diskbuffer string
1409 Deprecated. See "Dump Splitting Configuration" below. Default: not
1411 set. When dumping a split dump in PORT-WRITE mode (usually meaning
1412 "no holding disk"), buffer the split chunks to a file in the
1413 directory specified by this option.
1414 ssh-keys string
1416 Default: not set. The key file the ssh auth will use, it must be
1417 the private key. If this parameter is not specified, then the
1418 default ssh key will be used.
1419 starttime int
1421 Default: not set. Backup of these disks will not start until after
1422 this time of day. The value should be hh*100+mm, e.g. 6:30PM
1423 (18:30) would be entered as 1830.
1424 strategy [ standard | nofull | noinc | skip | incronly ]
1426 Default: standard. Strategy to use when planning what level of
1427 backup to run next. Values are:
1428 standard
1430 The standard Amanda schedule.
1431 nofull
1433 Never do full backups, only level 1 incrementals.
1434 noinc
1436 Never do incremental backups, only full dumps.
1437 skip
1439 Treat this DLE as if it doesn't exist (useful to disable DLEs
1440 when sharing the disklist file between multiple
1441 configurations). Skipped DLEs will not be checked or dumped,
1442 and will not be matched by disklist expressions.
1443 incronly
1445 Only do incremental dumps. amadmin force should be used to
1446 tell Amanda that a full dump has been performed off-line, so
1447 that it resets to level 1.
1448 tag [append] string*
1450 Default: no default. Specify the tags that match the dump-selection
1451 of a storage.
1452 tape-splitsize int
1454 Deprecated. See "Dump Splitting Configuration" below.
1455 Default: not set. Split dump file on tape into pieces of a
1457 specified size. The default unit is Kbytes if it is not specified.
1458 The following dumptype entries are predefined by Amanda:
1460 define dumptype "no-compress" {
1461 compress none
1462 }
1463 define dumptype "compress-fast" {
1464 compress client fast
1465 }
1466 define dumptype "compress-best" {
1467 compress client best
1468 }
1469 define dumptype "srvcompress" {
1470 compress server fast
1471 }
1472 define dumptype "bsd-auth" {
1473 auth "bsd"
1474 }
1475 define dumptype "bsdtcp-auth" {
1476 auth "bsdtcp"
1477 }
1478 define dumptype "no-record" {
1479 record no
1480 }
1481 define dumptype "no-hold" {
1482 holdingdisk no
1483 }
1484 define dumptype "no-full" {
1485 skip-full yes
1486 }
1487 In addition to options in a dumptype section, one or more other
1489 dumptype names may be supplied as identifiers, which make this dumptype
1490 inherit options from other previously defined dumptypes. For instance,
1491 two sections might be the same except for the record option:
1492 define dumptype "normal" {
1493 comment "Normal backup, no compression, do indexing"
1494 no-compress
1495 index yes
1496 maxdumps 2
1497 }
1498 define dumptype "testing" {
1499 comment "Test backup, no compression, do indexing, no recording"
1500 "normal"
1501 record no
1502 }
1503 Amanda provides a dumptype named global in the sample amanda.conf file
1505 that all dumptypes should reference. This provides an easy place to
1506 make changes that will affect every dumptype, although you must be
1507 careful that every dumptype explicitly inherits from the global
1508 dumptype - Amanda does not do so automatically.
1509
1511 The amanda.conf file may define multiple types of tape media and
1512 devices. The information is entered in a tapetype section, which looks
1513 like this in the config file:
1514 define tapetype "name" {
1515 tapetype-option tapetype-value
1516 ...
1517 }
1518 The { must appear at the end of a line, and the } on its own line.
1520 Name is the name of this type of tape medium/device. It is referenced
1522 from the tapetype option in the main part of the config file.
1523 The tapetype options and values are:
1525 blocksize int
1527 Default: 32 kbytes. How much data will be written in each tape
1528 record, expressed in kbytes. This is similar to the BLOCK_SIZE
1529 device property, but if the blocksize is not a multiple of 1024
1530 bytes, then this parameter cannot be used to specify it, and the
1531 property must be used instead.
1532 comment string
1534 Default: not set. A comment string describing this set of tape
1535 information.
1536 filemark int
1538 Default: 1 kbytes. How large a file mark (tape mark) is, measured
1539 in kbytes. If the size is only known in some linear measurement
1540 (e.g. inches), convert it to kbytes using the device density.
1541 lbl-templ string
1543 Default: not set. A PostScript template file used by amreport to
1544 generate labels. Several sample files are provided with the Amanda
1545 sources in the example directory. See the amreport(8) man page for
1546 more information.
1547 length int
1549 Default: 2000 kbytes. How much data will fit on a tape, expressed
1550 in kbytes.
1551 Note that this value is only used by Amanda to schedule which
1553 backups will be run. Once the backups start, Amanda will continue
1554 to write to a tape until it gets an error, regardless of what value
1555 is entered for length (but see amanda-devices(7) for exceptions).
1556 part-cache-dir string
1558 Default: none. The directory in which part-cache files can be
1559 written when caching on disk. See "Dump Splitting Configuration"
1560 below.
1561 part-cache-max-size int
1563 Default: none. The maximum part size to use when caching is in
1564 effect. This is used to limit the part size when disk or memory
1565 space for caching is constrained. This value must be greater than
1566 zero.
1567 part-cache-type [ none | disk | memory ]
1569 Default: none. When part caching is required, this parameter
1570 specifies the type of caching that will be used. The options
1571 include no caching (none), in which case a failed part will cause
1572 the entire dump to fail; on-disk caching (disk), for which
1573 part-cache-dir must be set properly; and in-memory caching
1574 (memory), which on most systems severely restrains the size of the
1575 part that can be written. See "Dump Splitting Configuration" below.
1576 part-size int
1578 If this is set to zero (default), then no splitting will take
1579 place, and the entire dump will fail, if end-of-medium is
1580 encountered before the dump is complete, unless the device property
1581 LEOM is true, and the device can detect EOM. See "Dump Splitting
1582 Configuration" below.
1583 readblocksize int
1585 Default: 32 kytes How much data will be read in each tape record.
1586 This can be used to override a device's block size for reads only.
1587 This may be useful, for example, in reading a tape written with a
1588 256k block size when Amanda is configured to use 128k blocks. This
1589 unusual feature is not supported by all operating systems and tape
1590 devices.
1591 The default unit is Kbytes if it is not specified.
1593 speed int
1595 Default: 200 bps. How fast the drive will accept data, in bytes per
1596 second. This parameter is NOT currently used by Amanda.
1597 In addition to options, another tapetype name may be supplied as an
1599 identifier, which makes this tapetype inherit options from another
1600 tapetype. For instance, the only difference between a DLT4000 tape
1601 drive using Compact-III tapes and one using Compact-IV tapes is the
1602 length of the tape. So they could be entered as:
1603 define tapetype "DLT4000-III" {
1604 comment "DLT4000 tape drives with Compact-III tapes"
1605 length 12500 mbytes # 10 Gig tapes with some compression
1606 filemark 2000 kbytes
1607 speed 1536 kps
1608 }
1609 define tapetype "DLT4000-IV" {
1610 "DLT4000-III"
1611 comment "DLT4000 tape drives with Compact-IV tapes"
1612 length 25000 mbytes # 20 Gig tapes with some compression
1613 }
1614
1616 The amanda.conf file may define multiple types of network interfaces.
1617 The information is entered in an interface section, which looks like
1618 this:
1619 define interface "name" {
1620 interface-option interface-value
1621 ...
1622 }
1623 The { must appear at the end of a line, and the } on its own line.
1625 name is the name of this type of network interface. It is referenced
1627 from the disklist file.
1628 If a src-ip is specified, then the connection should be from an
1630 interface with that IP. The system decide which interface to use if
1631 src-ip is not specified. You can add route at the system level to do
1632 more specific routing.
1633 The section do not impose limits on the bandwidth that will actually be
1635 taken up by Amanda. Amanda computes the estimated bandwidth each file
1636 system backup will take based on the estimated size and time, then
1637 compares that plus any other running backups with the limit as another
1638 of the criteria when deciding whether to start the backup. Once a
1639 backup starts, Amanda will use as much of the network as it can leaving
1640 throttling up to the operating system and network hardware.
1641 The interface options and values are:
1643 comment string
1645 Default: not set. A comment string describing this set of network
1646 information.
1647 src-ip string
1649 The IP address to use when sending a request to an amanda client.
1650 use int
1652 Default: 80000 Kbps. The speed of the interface in Kbytes per
1653 second.
1654 In addition to options, another interface name may be supplied as an
1656 identifier, which makes this interface inherit options from another
1657 interface. At the moment, this is of little use.
1658
1660 The amanda.conf file may define multiple types of application. The
1661 information is entered in a application section, which looks like this:
1662 define application "name" {
1663 application-option application-value
1664 ...
1665 }
1666 The { must appear at the end of a line, and the } on its own line.
1668 name is the name of this type of application. It is referenced from the
1670 dumptype
1671 The application options and values are:
1673 client-name string
1675 No default, specifies an application name that is in the
1676 amanda-client.conf on the client. The setting from that application
1677 will be merged with the current application. If client-name is set
1678 then it is an error if that application is not defined on the
1679 client.
1680 If client-name is not set then the merge is done with the
1682 application that have the name equal to the plugin. eg. if the
1683 plugin is 'amgtar', then the setting from the application 'amgtar'
1684 is used if it is defined.
1685 comment string
1687 Default: not set. A comment string describing this application.
1688 plugin string
1690 No default. Must be set to the name of the program. This program
1691 must be in the $libexecdir/amanda/application directory on the
1692 client.
1693 property [append] [priority] string string+
1695 No default. You can set property for the application, each
1696 application have a different set of property. Both strings are
1697 quoted; the first string contains the name of the property to set,
1698 and the others contains its values. append keyword append the
1699 values to the list of values for that property. priority keyword
1700 disallow the setting of that property on the client.
1701
1703 The amanda.conf file may define multiple types of script. The
1704 information is entered in a script section, which looks like this:
1705 define script "name" {
1706 script-option script-value
1707 ...
1708 }
1709 The { must appear at the end of a line, and the } on its own line.
1711 name is the name of this type of script. It is referenced from the
1713 dumptype
1714 The script options and values are:
1716 client-name string
1718 No default, specifies a script name that is in the
1719 amanda-client.conf on the client. The setting from that script will
1720 be merged with the currect script. If client-name is set then it is
1721 an error if that script is not defined on the client.
1722 If client-name is not set then the merge is done with the script
1724 that have the name equal to the plugin. eg. if the plugin is
1725 'amlog-script', then the setting from the script 'amlog-script' is
1726 used.
1727 comment string
1729 Default: not set. A comment string describing this script.
1730 execute-on execute_on [,execute_on]*
1732 No default. When the script must be executed, you can specify many
1733 of them:
1734 pre-amcheck
1736 Execute before the amcheck command for all dle. Can only be run
1737 on server.
1738 pre-dle-amcheck
1740 Execute before the amcheck command for the dle.
1741 pre-host-amcheck
1743 Execute before the amcheck command for all dle for the client.
1744 post-amcheck
1746 Execute after the amcheck command for all dle. Can only be run
1747 on server.
1748 post-dle-amcheck
1750 Execute after the amcheck command for the dle.
1751 post-host-amcheck
1753 Execute after the amcheck command for all dle for the client.
1754 pre-estimate
1756 Execute before the estimate command for all dle. Can only be
1757 run on server.
1758 pre-dle-estimate
1760 Execute before the estimate command for the dle.
1761 pre-host-estimate
1763 Execute before the estimate command for all dle for the client.
1764 post-estimate
1766 Execute after the estimate command for all dle. Can only be run
1767 on server.
1768 post-dle-estimate
1770 Execute after the estimate command for the dle.
1771 post-host-estimate
1773 Execute after the estimate command for all dle for the client.
1774 pre-backup
1776 Execute before the backup command for all dle. Can only be run
1777 on server.
1778 pre-dle-backup
1780 Execute before the backup command for the dle.
1781 pre-host-backup
1783 Execute before the backup command for all dle for the client.
1784 It can't be run on client, it must be run on server
1785 post-backup
1787 Execute after the backup command for all dle. Can only be run
1788 on server.
1789 post-dle-backup
1791 Execute after the backup command for the dle.
1792 post-host-backup
1794 Execute after the backup command for all dle for the client. It
1795 can't be run on client, it must be run on server
1796 pre-recover
1798 Execute before any level is recovered.
1799 post-recover
1801 Execute after all levels are recovered.
1802 pre-level-recover
1804 Execute before each level recovery.
1805 post-level-recover
1807 Execute after each level recovery.
1808 inter-level-recover
1810 Execute between two levels of recovery.
1811 If you recover level 0 and 2 of the disk /usr with amrecover, it
1813 will execute:
1814 script --pre-recover
1815 script --pre-level-recover --level 0
1816 #recovering level 0
1817 script --post-level-recover --level 0
1818 script --inter-level-recover --level 0 --level 2
1819 script --pre-level-recover --level 2
1820 #recovering level 2
1821 script --post-level-recover --level 2
1822 script --post-recover
1823 execute-where [ client | server ]
1825 Default: client. Where the script must be executed, on the client
1826 or server.
1827 order int
1829 Default: 5000. Scripts are executed in that order, it is useful if
1830 you have many scripts and they must be executed in a spefific
1831 order.
1832 plugin string
1834 No default. Must be set to the name of the program. This program
1835 must be in the $libexecdir/amanda/application directory on the
1836 client and/or server.
1837 property [append] [priority] string string+
1839 No default. You can set property for the script, each script have a
1840 different set of property. Both strings are quoted; the first
1841 string contains the name of the property to set, and the others
1842 contains its values. append keyword append the values to the list
1843 of values for that property. priority keyword disallow the setting
1844 of that property on the client.
1845 single-execution boolean
1847 Default: no. The script is executed for each dle. If yes, the
1848 script is executed one time only.
1849
1851 Backend storage devices are specified in amanda.conf in the form of
1852 "device" sections, which look like this:
1853 define device name {
1854 comment "comment (optional)"
1855 tapedev "device-specifier"
1856 device-property "prop-name" "prop-value"
1857 ...
1858 }
1859 The { must appear at the end of a line, and the } on its own line.
1861 name is the user-specified name of this device. It is referenced from
1863 the global tapedev parameter. The device-specifier specifies the device
1864 name to use; see amanda-devices(7). As with most sections, the comment
1865 parmeter is optional and only for the user's convenience.
1866 An arbitrary number of device-property parameters can be specified.
1868 Again, see amanda-devices(7) for information on device properties.
1869
1871 Changers are described in amanda.conf in the form of "changer"
1872 sections, which look like this:
1873 define changer name {
1874 comment "comment (optional)"
1875 tpchanger "changer-spec"
1876 changerdev "device-name"
1877 changerfile "state-file"
1878 ...
1879 }
1880 The { must appear at the end of a line, and the } on its own line.
1882 name is the user-specified name of this device. The remaining
1884 parameters are specific to the changer type selected.
1885 The tpchanger and changerfile can use '$t' to substitute the name of
1887 the changer.
1888 See amanda-changers(7) for more information on configuring changers.
1890
1892 The amanda.conf file may define multiple interactivyt methods, although
1893 only one will be used - that specified by the interactivity parameter.
1894 The information is entered in a interactivity section, which looks like
1895 this:
1896 define interactivity name {
1897 interactivity-option interactivity-value
1898 ...
1899 }
1900 The { must appear at the end of a line, and the } on its own line.
1902 name is the user-specified name of this interactivity. The remaining
1904 parameters are specific to the interactivity type selected.
1905 The interactivity options and values are:
1907 comment string
1909 Default: not set. A comment string describing this interactivity.
1910 plugin string
1912 No default. Must be set to the name of the interactivity module, as
1913 described in amanda-interactivity(7).
1914 property [append] string string+
1916 No default. You can set arbitrary properties for the interactivity.
1917 Each interactivity module has a different set of properties. The
1918 first string contains the name of the property to set, and the
1919 others contains its values. All strings should be quoted. The
1920 append keyword appends the given values to an existing list of
1921 values for that property.
1922 See amanda-interactivity(7) for more information on configuring
1924 interactivity methods.
1925
1927 The amanda.conf file may define multiple taperscan methods, it is set
1928 with the global taperscan parameter or in the storage section. The
1929 information is entered in a taperscan section, which looks like this:
1930 define taperscan name {
1931 taperscan-option taperscan-value
1932 ...
1933 }
1934 The { must appear at the end of a line, and the } on its own line.
1936 name is the user-specified name of this taperscan. The remaining
1938 parameters are specific to the taperscan type selected.
1939 The taperscan options and values are:
1941 comment string
1943 Default: not set. A comment string describing this taperscan.
1944 plugin string
1946 No default. Must be set to the name of the taperscan module. See
1947 amanda-taperscan(7) for a list of defined taperscan modules.
1948 property [append] string string+
1950 No default. Operates just like properties for interactivity
1951 methods, above.
1952 See amanda-taperscan(7) for more information on configuring taperscan.
1954
1956 The amanda.conf file may define multiple policy, it is set with the
1957 policy parameter of the storage section. A policy name CONFIG_NAME is
1958 automaticaly created. The information is entered in a policy section,
1959 which looks like this:
1960 define policy name {
1961 policy-option policy-value
1962 ...
1963 }
1964 The { must appear at the end of a line, and the } on its own line.
1966 name is the user-specified name of this policy. The remaining
1968 parameters are specific to the policy type selected.
1969 The policy options and values are:
1971 comment string
1973 Default: not set. A comment string describing this policy.
1974 retention-days int
1976 Default: 0. A volume is kept for that number of days before it can
1977 be reused.
1978 retention-full int
1980 Default: 0. A volume is kept if it contains a FULL not older then
1981 retention-full days.
1982 retention-recover int
1984 Default: 0. Keep all volumes needed to recover all files up to
1985 retention-recover days ago, if it was a level 2, also keep previous
1986 level 1 and level 0.
1987 retention-tapes int
1989 Default: global tapecycle-1. The latest used retention-tapes volume
1990 can't be reused. You must have more than retention-tapes volumes
1991 before a volume can be re-used.
1992
1994 The amanda.conf file may define multiple storage, the default storages
1995 are set with the storage parameter. The vaulting storage are set with
1996 the the vault-storage parameter. A storage name CONFIG_NAME is created
1997 if the global storage is not set. The information is entered in a
1998 storage section, which looks like this:
1999 define storage name {
2000 storage-option storage-value
2001 ...
2002 }
2003 The { must appear at the end of a line, and the } on its own line.
2005 name is the user-specified name of this storage. The remaining
2007 parameters are specific to the storage type selected.
2008 The storage options and values are:
2010 autoflush no|yes|all
2012 Default: value of the global autoflush.
2013 autolabel string [any] [other-config] [non-amanda] [volume-error]
2015 [empty]
2016 Default: value of the global autolabel.
2017 comment string
2019 Default: not set. A comment string describing this storage.
2020 device-output-buffer-size int
2022 Default: value of the global device-output-buffer-size.
2023 dump-selection [string | ALL] [ ALL | FULL | INCR ]
2025 Default: no default. The dump-selection specify which dump will be
2026 written to the storage. The first field is the tag, either it is
2027 ALL and all DLEs matches or it is a tag string and a dle match only
2028 if it have that tag. The second field is the level, it can be ALL
2029 for all level, FULL for level 0 only or INCR for level > 0 only.
2030 eject-volume bool
2032 Default: value of the global eject-volume.
2033 erase-on-failure bool
2035 Default: NO. Automatically erase a volume if nothing useful was
2036 written to it. This is useful to reuse the volume sooner.
2037 erase-on-full bool
2039 Default: NO. Automatically erase a no-retention volume if the vtape
2040 area become full.
2041 erase-volume bool
2043 Default: NO. Automatically erase the volume when the policy expire.
2044 This is useful to free space on vtape or s3 devices or to allow
2045 another storage to use that volume.
2046 flush-threshold-dumped int
2048 Default: value of the global flush-threshold-dumped.
2049 flush-threshold-scheduled int
2051 Default: value of the global flush-threshold-scheduled.
2052 interactivity string
2054 Default: value of the global interactivity.
2055 labelstr string
2057 Default: value of the global labelstr.
2058 max-dle-by-volume int
2060 Default: value of the global max-dle-by-volume.
2061 meta-autolabel string
2063 Default: value of the global meta-autolabel.
2064 policy string
2066 Default: CONFIG_NAME. Define the policy to use.
2067 report-next-media boolean
2069 Default: value of the global report-next-media.
2070 report-use-media boolean
2072 Default: value of the global report-use-media.
2073 runtapes int
2075 Default: value of the global runtapes.
2076 set-no-reuse bool
2078 Default: no. If set to yes, a volume is marked as no-reuse after it
2079 is written.
2080 tapedev string
2082 Default: value of the global tapedev.
2083 This parameter can either specify a device (explicitly or by
2085 referencing a device definition - see amanda-devices(7)) or a tape
2086 changer (explicitly or by referencing a device definition - see
2087 amanda-changers(7)).
2088 tapepool string
2090 Default: CONFIG_NAME. Some characters are substituted:
2091 $o : org configuration
2093 $c : config name
2094 $r : storage name
2095 taperalgo [ first | firstfit | largest | largestfit | smallest | last ]
2097 Default: value of the global taperalgo.
2098 taperflush int
2100 Default: value of the global taperflush.
2101 taperscan string
2103 Default: value of the global taperscan.
2104 taper-parallel-write int
2106 Default: value of the global taper-parallel-write.
2107 tapetype string
2109 Default: value of the global tapetype.
2110 tpchanger string
2112 Default: value of the global tpchanger.
2113 vault storage int
2115 Will vault all dumps from this storage to the new storage X days
2116 after the dumps. You can have multiple vault entry.
2117
2119 Amanda can "split" dumps into parts while writing them to storage
2120 media. This allows Amanda to recover gracefully from a failure while
2121 writing a part to a volume, by simply selecting a new volume and
2122 re-writing the dump from the beginning of the failed part. Parts also
2123 allow Amanda to seek directly to the required data, although this
2124 functionality is not yet used.
2125 In order to support re-writing from the beginning of a failed part,
2127 Amanda must have access to the contents of the part after it has been
2128 partially written. If the dump is being read from holding disk, then
2129 the part contents are available there. Otherwise, the part must be
2130 cached, and this can be done memory or on disk. In either of the latter
2131 cases, the cache must have enough space to hold an entire part.
2132 Because it is common for a single Amanda configuration to use both
2134 holding-disk (FILE-WRITE) and direct (known as PORT-WRITE) dumps,
2135 Amanda allows the configuration of different split sizes for the two
2136 cases. This allows, for example, for a part size appropriate to large
2137 tapes when performing FILE-WRITE dumps, with a part size limited by
2138 available disk or memory when performing PORT-WRITE dumps.
2139 Selecting a proper split size is a delicate matter. If the parts are
2141 too large, substantial storage space may be wasted in failed parts. If
2142 too small, large dumps will be split into innumerable tiny dumpfiles,
2143 adding to restoration complexity; furthermore, an excess of filemarks
2144 will cause slower tape drive operation and reduce the usable space on
2145 tape. A good rule of thumb is 1/10 of the size of a volume of storage
2146 media.
2147 In versions of Amanda through 3.1.*, splitting was controlled by the
2149 dumptype parameters tape-splitsize, split-diskbuffer, and
2150 fallback-splitsize. These keywords had confusing and non-intuitive
2151 interactions, and have since been deprecated.
2152 If the deprecated keywords are not present, subsequent versions of
2154 Amanda use the dumptype parameter allow-split to control whether a DLE
2155 can be split, and the tapetype parameters part-size, part-cache-type,
2156 part-cache-dir, and part-cache-max-size. The part-size specifies the
2157 "normal" part size, while the part-cache-* parameters describe how to
2158 behave when caching is required (on PORT-WRITE). Full details on these
2159 parameters are given above.
2160
2162 amanda(8), amanda-applications(7), amanda-auth(7), amanda-changers(7),
2163 amanda-client.conf(5), amanda-command-file(5), amanda-devices(7),
2164 amanda-interactivity(7), amanda-scripts(7), amanda-taperscan(7),
2165 amgetconf(8), amadmin(8)
2166 The Amanda Wiki: : http://wiki.zmanda.com/
2168
2170 James da Silva <jds@amanda.org>
2171 Stefan G. Weichinger <sgw@amanda.org>
2173Amanda 3.5.4 07/27/2023 AMANDA.CONF(5)