1AMANDA.CONF(5)           File formats and conventions           AMANDA.CONF(5)
2
3
4

NAME

6       amanda.conf - Main configuration file for Amanda, the Advanced Maryland
7       Automatic Network Disk Archiver
8

DESCRIPTION

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
14       The file <CONFIG_DIR>/<config>/amanda.conf is loaded.
15

SYNTAX

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
21   COMMENTS
22       Lines starting with # are ignored, as are blank lines. Comments may be
23       placed on a line with a directive by starting the comment with a #. The
24       remainder of the line is ignored.
25
26   KEYWORDS AND IDENTIFIERS
27       Keywords are case insensitive, i.e.  mailto and MailTo are treated the
28       same. Also, the characters ´-´ and ´_´ are interchangeable in all
29       predefined Amanda keywords: device_property and device-property have
30       the same meaning.
31
32       Identifiers are names which are defined in the configuration itself,
33       such as dumptypes or interfaces. Identifiers are are case-insensitive,
34       but sensitive to ´-´ vs. ´_´. Identifiers should be quoted in the
35       configuration file, although For historical reasons, the quotes are
36       optional.
37
38       Strings are always quoted with double quotes ("), and any double quotes
39       or backslashes within the string are escaped with a backslash:
40
41       tapelist "/path/to/tapelist"
42       property "escaped-string" "escaping: \\ (backslash) and \" (double-quote)"
43
44       To summarize, then:
45
46                                 # QUOTES        CASE            -/_
47       logdir "logs"             # required      sensitive       sensitive
48       send-amreport-on strange  # prohibited    insensitive     insensitive
49       tapetype "EXABYTE"        # optional      insensitive     sensitive
50
51       define dumptype "dt" {    # optional      insensitive     sensitive
52         "dumptype-common"       # optional      insensitive     sensitive
53         strategy noincr         # prohibited    insensitive     insensitive
54       }
55
56   VALUE SUFFIXES
57       Integer arguments may have one of the following (case insensitive)
58       suffixes, some of which have a multiplier effect:
59
60       b byte bytes
61           Some number of bytes.
62
63       bps
64           Some number of bytes per second.
65
66       k kb kbyte kbytes kilobyte kilobytes
67           Some number of kilobytes (bytes*1024).
68
69       kps kbps
70           Some number of kilobytes per second (bytes*1024).
71
72           It is the default multiplier for all size options.
73
74       m mb meg mbyte mbytes megabyte megabytes
75           Some number of megabytes (bytes*1024*1024).
76
77       mps mbps
78           Some number of megabytes per second (bytes*1024*1024).
79
80       g gb gbyte gbytes gigabyte gigabytes
81           Some number of gigabytes (bytes*1024*1024*1024).
82
83       t tb tbyte tbytes terabyte terabytes
84           Some number of terabytes (bytes*1024*1024*1024*1024).
85
86       tape tapes
87           Some number of tapes.
88
89       day days
90           Some number of days.
91
92       week weeks
93           Some number of weeks (days*7).
94
95               Note
96               The value inf may be used in most places where an integer is
97               expected to mean an infinite amount.
98
99               Boolean arguments may have any of the values 1, y, yes, t, true
100               or on to indicate a true state, or 0, n, no, f, false or off to
101               indicate a false state. If no argument is given, true is
102               assumed.
103
104   PARAMETER ORDER
105       In general, the order in which parameters occur in the configuration
106       file does not matter, with the exception of subsection inheritance. For
107       example, if dumptype "normal-encrypt" which inherits from dumptype
108       "normal", then "normal" must appear first in the configuration file.
109
110   STRINGS
111       Quoted strings in Amanda follow a common, C-like syntax. Printable
112       characters and whitespace are kept as-is, except that the backslash
113       character (\) is used as an escape character, and a double-quote ends
114       the string. The allowed escape sequences are
115
116           ESCAPE SEQUENCE     BECOMES
117           \\                  \
118           \"                  "
119           \n                  (newline)
120           \t                  (tab)
121           \r                  (carriage return)
122           \f                  (form-feed)
123           \1 - \7
124           \01 - \77
125           \001 - \377         (character specified in octal)
126       Illegally quoted strings are handled on a "best-effort" basis, which
127       may lead to unexpected results.
128
129       Examples:
130
131       finserver "/data/finance/XYZ Corp´s \"real\" finances" finance-high eth0 -1
132       property "syspath" "C:\\WINDOWS\\SYSTEM"
133
134   SUBSECTIONS AND INHERITANCE
135       Amanda configuration files may include various subsections, each
136       defining a set of configuration directives. Each type of subsection is
137       described below. Note that all types of subsections can inherit from
138       other subsections of the same type by naming the "parent" section in
139       the "child" subsection. For example:
140
141       define dumptype global {
142           record yes
143           index yes
144       }
145
146       define dumptype nocomp {
147           global      # inherit the parameters in dumptype ´global´
148           compress none
149       }
150
151       Note that multiple inheritance is also supported by simply naming
152       multiple parent sections in a child. Parents are implicitly expanded in
153       place in a child, and the last occurrence of each parameter takes
154       precedence. For example,
155
156       define tapetype par1 {
157           comment "Parent 1"
158           filemark 8k
159           speed 300bps
160           length 200M
161       }
162       define tapetype par2 {
163           comment "Parent 2"
164           filemark 16k
165           speed 400bps
166       }
167       define tapetype child {
168           par1
169           par2
170           filemark 32k
171       }
172       In this example, ´child´ will have a filemark of 32k, a speed of
173       400bps, and a length of 200M.
174

GLOBAL PARAMETERS

176       org string
177           Default: "daily". A descriptive name for the configuration. This
178           string appears in the Subject line of mail reports. Each Amanda
179           configuration should have a different string to keep mail reports
180           distinct.
181
182       mailer string
183           Default found by configure. A mail program that can send mail with
184           ´MAILER -s "subject" user < message_file´.
185
186       mailto string
187           Default: none. A space separated list of recipients for mail
188           reports. If not specified, amdump will not send any mail.
189
190       send-amreport-on [ all | strange | error | never ]
191           Default: all. Specify which types of messages will trigger an email
192           from amreport. amreport is used by amdump and amflush.
193
194           all
195               Send an email on any message.
196
197           strange
198               Send an email on strange or error message. A strange message
199               occurs when the dump succeeded, but returned one or more errors
200               unknown to Amanda.
201
202           error
203               Send an email only on error messages.
204
205           never
206               Never send an email.
207
208       dumpcycle int
209           Default: 10 days. The number of days in the backup cycle. Each disk
210           will get a full backup at least this often. Setting this to zero
211           tries to do a full backup each run.
212
213               Note
214               This parameter may also be set in a specific dumptype (see
215               below). This value sets the default for all dumptypes so must
216               appear in amanda.conf before any dumptypes are defined.
217
218       runspercycle int
219           Default: same as dumpcycle. The number of amdump runs in dumpcycle
220           days. A value of 0 means the same value as dumpcycle. A value of -1
221           means guess the number of runs from the tapelist(5) file, which is
222           the number of tapes used in the last dumpcycle days / runtapes.
223
224       tapecycle int
225           Default: 15 tapes. Typically tapes are used by Amanda in an ordered
226           rotation. The tapecycle parameter defines the size of that
227           rotation. This parameter must be be larger than the number of tapes
228           used in a dumpcycle.
229
230           The number of tapes per dumpcycle is calculated by multiplying the
231           number of amdump runs per dump cycle runspercycle (the number of
232           amdump runs per dump cycle) and runtapes (the number of tapes used
233           per run). Typically tapecycle is set to two or four times the tapes
234           per dumpcycle.
235
236               Note
237               Amanda is commonly misconfigured with tapecycle equal to the
238               number of tapes per dumpcycle.  In this misconfiguration,
239               amanda may erase a full dump before a new one is completed, the
240               recovery is then impossible. tapecycle must be at least one
241               tape larger than the number of tapes per dumpcycle.
242           While Amanda is always willing to use a new tape in its rotation,
243           it refuses to reuse a tape until at least ´tapecycle -1´ number of
244           other tapes have been used.
245
246           It is considered good administrative practice to set the tapecycle
247           parameter slightly lower than the actual number of tapes in
248           rotation. This allows the administrator to more easily cope with
249           damaged or misplaced tapes or schedule adjustments that call for
250           slight adjustments in the rotation order.
251
252       usetimestamps bool
253           Default: Yes. This option allows Amanda to track multiple runs per
254           calendar day. The only reason one might disable it is that Amanda
255           versions before 2.5.1 can´t read logfiles written when this option
256           was enabled.
257
258       label_new_tapes string
259           Deprecated, use autolabel option.
260
261           Default: not set. When set, this directive will cause Amanda to
262           automatically write an Amanda tape label to any blank tape she
263           encounters. This option is DANGEROUS because when set, Amanda will
264           ERASE any non-Amanda tapes you may have, and may also ERASE any
265           near-failing tapes. Use with caution.
266
267           When using this directive, specify the template for new tape
268           labels. The template should contain some number of contiguous ´%´
269           characters, which will be replaced with a generated number. Be sure
270           to specify enough ´%´ characters that you do not run out of tape
271           labels. Example: label_new_tapes "DailySet1-%%%"
272
273       autolabel string [any] [other_config] [non_amanda] [volume_error]
274       [empty]
275           Default: not set. When set, this directive will cause Amanda to
276           automatically write an Amanda tape label to most volume she
277           encounters. This option is DANGEROUS because when set, Amanda may
278           erase near-failing tapes or tapes accidentally loaded in the wrong
279           slot.
280
281           When using this directive, specify the template for new tape
282           labels. The template should contain some number of contiguous ´%´
283           characters, which will be replaced with a generated number. Be sure
284           to specify enough ´%´ characters that you do not run out of tape
285           labels. Example: autolabel "DailySet1-%%%" empty
286
287           any
288               equivalent to ´other_config non_amanda volume_error empty´
289
290           other_config
291               Label volumes with a valid Amanda label that do not match our
292               labelstr. Danger: this may erase volumes from other Amanda
293               configurations without warning!
294
295           non_amanda
296               Label volumes which do not start with data that resembles an
297               Amanda header. Danger: this may erase volumes from other backup
298               applications without warning!
299
300           volume_error
301               Label volumes where an error occurs while trying to read the
302               label.  Danger: this may erase arbitrary volumes due to
303               transient errors.
304
305           empty
306               Label volumes where a read returns 0 bytes.
307
308       dumpuser string
309           Default: "amanda". The login name Amanda uses to run the backups.
310           The backup client hosts must allow access from the tape server host
311           as this user via .rhosts or .amandahosts, depending on how the
312           Amanda software was built.
313
314       printer string
315           Printer to use when doing tape labels. See the lbl-templ tapetype
316           option.
317
318       tapedev string
319           Default: "null:". The device name, referencing the name of a
320           "device" section in the configuration file. See amanda-devices(7)
321           for more information on device names.
322
323           If a tape changer is configured (see the tpchanger option), this
324           option might not be used.
325
326           If tapedev is null:, programs such as amdump will run normally but
327           all images will be thrown away. This should only be used for
328           debugging and testing, and probably only with the record option set
329           to no.
330
331       device_property string string
332           These options can set various device properties. See amanda-
333           devices(7) for more information on device properties and their
334           syntax. Both strings are always quoted; the first string contains
335           the name of the property to set, and the second contains its value.
336           For example, to set a fixed block size of 128k, write:
337           device_property "BLOCK_SIZE" "128k"
338
339       property [append] string string+
340           These options can set various properties, they can be used by third
341           party software to store information in the configuration file. Both
342           strings are quoted; the first string contains the name of the
343           property to set, and the others contains its values.  append
344           keyword append the values to the list of values for that property.
345
346       tpchanger string
347           Default: not set. The name of the tape changer. If a tape changer
348           is not configured, this option is not used and should be commented
349           out of the configuration file.
350
351           If a tape changer is configured, choose one of the changer scripts
352           (e.g.  chg-scsi) and enter that here.
353
354       changerdev string
355           Default: "dev/null". A tape changer configuration parameter. Usage
356           depends on the particular changer defined with the tpchanger
357           option.
358
359       changerfile string
360           Default: "usr/adm/amanda/log/changer-status". A tape changer
361           configuration parameter. Usage depends on the particular changer
362           defined with the tpchanger option.
363
364       runtapes int
365           Default: 1. The maximum number of tapes used in a single run. If a
366           tape changer is not configured, this option is not used and should
367           be commented out of the configuration file.
368
369           If a tape changer is configured, this may be set larger than one to
370           let Amanda write to more than one tape.
371
372           Note that this is an upper bound on the number of tapes, and Amanda
373           may use less.
374
375           Also note that as of this release, Amanda does not support true
376           tape overflow. When it reaches the end of one tape, the backup
377           image Amanda was processing starts over again on the next tape.
378
379       maxdumpsize int
380           Default: runtapes*tape_length. Maximum number of bytes the planner
381           will schedule for a run.
382
383           The default unit is Kbytes if it is not specified.
384
385       taperalgo [ first | firstfit | largest | largestfit | smallest | last ]
386           Default: first. The algorithm used to choose which dump image to
387           send to the taper.
388
389           first
390               First in, first out.
391
392           firstfit
393               The first dump image that will fit on the current tape.
394
395           largest
396               The largest dump image.
397
398           largestfit
399               The largest dump image that will fit on the current tape.
400
401           smallest
402               The smallest dump image.
403
404           last
405               Last in, first out.
406
407       labelstr string
408           Default: ".*". The tape label constraint regular expression. All
409           tape labels generated (see amlabel(8)) and used by this
410           configuration must match the regular expression. If multiple
411           configurations are run from the same tape server host, it is
412           helpful to set their labels to different strings (for example,
413           "DAILY[0-9][0-9]*" vs. "ARCHIVE[0-9][0-9]*") to avoid overwriting
414           each other´s tapes.
415
416       tapetype string
417           Default: no default. The type of tape drive associated with tapedev
418           or tpchanger. This refers to one of the defined tapetypes in the
419           config file (see below), which specify various tape parameters,
420           like the length, filemark size, and speed of the tape media and
421           device.
422
423       ctimeout int
424           Default: 30 seconds. Maximum amount of time that amcheck will wait
425           for each client host.
426
427       dtimeout int
428           Default: 1800 seconds. Amount of idle time per disk on a given
429           client that a dumper running from within amdump will wait before it
430           fails with a data timeout error.
431
432       etimeout int
433           Default: 300 seconds. Amount of time per estimate on a given client
434           that the planner step of amdump will wait to get the dump size
435           estimates (note: Amanda runs up to 3 estimates for each DLE). For
436           instance, with the default of 300 seconds and four DLE´s, each
437           estimating level 0 and level 1 on client A, planner will wait up to
438           40 minutes for that machine. A negative value will be interpreted
439           as a total amount of time to wait per client instead of per disk.
440
441       connect_tries int
442           Default: 3. How many times the server will try a connection.
443
444       req_tries int
445           Default: 3. How many times the server will resend a REQ packet if
446           it doesn´t get the ACK packet.
447
448       netusage int
449           Default: 8000 Kbps. The maximum network bandwidth allocated to
450           Amanda, in Kbytes per second. See also the interface section.
451
452       inparallel int
453           Default: 10. The maximum number of backups that Amanda will attempt
454           to run in parallel. Amanda will stay within the constraints of
455           network bandwidth and holding disk space available, so it doesn´t
456           hurt to set this number a bit high. Some contention can occur with
457           larger numbers of backups, but this effect is relatively small on
458           most systems.
459
460       displayunit "k|m|g|t"
461           Default: "k". The unit used to print many numbers, k=kilo, m=mega,
462           g=giga, t=tera.
463
464       dumporder string
465           Default: "tttTTTTTTT". The priority order of each dumper:
466
467           s: smallest size
468           S: largest size
469           t: smallest time
470           T: largest time
471           b: smallest bandwidth
472           B: largest bandwidth
473
474       maxdumps int
475           Default: 1. The maximum number of backups from a single host that
476           Amanda will attempt to run in parallel. See also the inparallel
477           option.
478
479           Note that this parameter may also be set in a specific dumptype
480           (see below). This value sets the default for all dumptypes so must
481           appear in amanda.conf before any dumptypes are defined.
482
483       bumpsize int
484           Default: 10 Mbytes. The minimum savings required to trigger an
485           automatic bump from one incremental level to the next, expressed as
486           size. If Amanda determines that the next higher backup level will
487           be this much smaller than the current level, it will do the next
488           level. The value of this parameter is used only if the parameter
489           bumppercent is set to 0.
490
491           The default unit is Kbytes if it is not specified.
492
493           The global setting of this parameter can be overwritten inside of a
494           dumptype-definition.
495
496           See also the options bumppercent, bumpmult and bumpdays.
497
498       bumppercent int
499           Default: 0. The minimum savings required to trigger an automatic
500           bump from one incremental level to the next, expressed as
501           percentage of the current size of the DLE (size of current level
502           0). If Amanda determines that the next higher backup level will be
503           this much smaller than the current level, it will do the next
504           level.
505
506           If this parameter is set to 0, the value of the parameter bumpsize
507           is used to trigger bumping.
508
509           The global setting of this parameter can be overwritten inside of a
510           dumptype-definition.
511
512           See also the options bumpsize, bumpmult and bumpdays.
513
514       bumpmult float
515           Default: 1.5. The bump size multiplier. Amanda multiplies bumpsize
516           by this factor for each level. This prevents active filesystems
517           from bumping too much by making it harder to bump to the next
518           level. For example, with the default bumpsize and bumpmult set to
519           2.0, the bump threshold will be 10 Mbytes for level one, 20 Mbytes
520           for level two, 40 Mbytes for level three, and so on.
521
522           The global setting of this parameter can be overwritten inside of a
523           dumptype-definition.
524
525       bumpdays int
526           Default: 2 days. To insure redundancy in the dumps, Amanda keeps
527           filesystems at the same incremental level for at least bumpdays
528           days, even if the other bump threshold criteria are met.
529
530           The global setting of this parameter can be overwritten inside of a
531           dumptype-definition.
532
533       diskfile string
534           Default: "disklist". The file name for the disklist file holding
535           client hosts, disks and other client dumping information.
536
537       infofile string
538           Default: "/usr/adm/amanda/curinfo". The file or directory name for
539           the historical information database. If Amanda was configured to
540           use DBM databases, this is the base file name for them. If it was
541           configured to use text formated databases (the default), this is
542           the base directory and within here will be a directory per client,
543           then a directory per disk, then a text file of data.
544
545       logdir string
546           Default: "/usr/adm/amanda". The directory for the amdump and log
547           files.
548
549       indexdir string
550           Default "/usr/adm/amanda/index". The directory where index files
551           (backup image catalogues) are stored. Index files are only
552           generated for filesystems whose dumptype has the index option
553           enabled.
554
555       tapelist string
556           Default: "tapelist". The file name for the active tapelist(5).
557           Amanda maintains this file with information about the active set of
558           tapes.
559
560       device_output_buffer_size int
561           Default: 1280k. Controls the amount of memory used by Amanda to
562           hold data as it is read from the network or disk before it is
563           written to the output device. Higher values may be useful on fast
564           tape drives and optical media.
565
566           The default unit is bytes if it is not specified.
567
568       tapebufs int
569           Default: 20. This option is deprecated; use the
570           device_output_buffer_size directive instead.  tapebufs works the
571           same way, but the number specified is multiplied by the device
572           blocksize prior to use.
573
574       reserve int
575           Default: 100. The part of holding-disk space that should be
576           reserved for incremental backups if no tape is available, expressed
577           as a percentage of the available holding-disk space (0-100). By
578           default, when there is no tape to write to, degraded mode
579           (incremental) backups will be performed to the holding disk. If
580           full backups should also be allowed in this case, the amount of
581           holding disk space reserved for incrementals should be lowered.
582
583       autoflush bool
584           Default: off. Whether an amdump run will flush the dumps from
585           holding disk to tape.
586
587       amrecover_do_fsf bool
588           Default: on. Amrecover will call amrestore with the -f flag for
589           faster positioning of the tape.
590
591       amrecover_check_label bool
592           Default: on. Amrecover will call amrestore with the -l flag to
593           check the label.
594
595       amrecover_changer string
596           Default: not set. Amrecover will use the changer if you use
597           ´settape <string>´ and that string is the same as the
598           amrecover_changer setting.
599
600       columnspec string
601           default:
602           "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"
603
604           Defines the width of columns amreport should use.  String is a
605           comma (´,´) separated list of triples. Each triple consists of
606           three parts which are separated by a equal sign (´=´) and a colon
607           (´:´) (see the example). These four parts specify:
608
609            1. the name of the column, which may be:
610
611                    Compress (compression ratio)
612                    Disk (client disk name)
613                    DumpRate (dump rate in KBytes/sec)
614                    DumpTime (total dump time in hours:minutes)
615                    HostName (client host name)
616                    Level (dump level)
617                    OrigKB (original image size in KBytes)
618                    OutKB (output image size in KBytes)
619                    TapeRate (tape writing rate in KBytes/sec)
620                    TapeTime (total tape time in hours:minutes)
621
622            2. the amount of space to display before the column (used to get
623               whitespace between columns).
624
625            3. the width of the column itself. If set to a negative value, the
626               width will be calculated on demand to fit the largest entry in
627               this column.
628
629            4. the precision of the column, number of digit after the decimal
630               point for number.
631
632               Here is an example:
633
634               columnspec "Disk=1:18,HostName=0:10,OrigKB=::2,OutKB=1:7"
635
636               The above will display the disk information in 18 characters
637               and put one space before it. The hostname column will be 10
638               characters wide with no space to the left. The Original KBytes
639               print 2 decimal digit. The output KBytes column is seven
640               characters wide with one space before it.
641
642           includefile string
643               Default: no default. The name of an Amanda configuration file
644               to include within the current file. Useful for sharing
645               dumptypes, tapetypes and interface definitions among several
646               configurations. Relative pathnames are relative to the
647               configuration directory.
648
649           debug_days int
650               Default: 3. The number of days the debug files are kept.
651
652           debug_auth int
653               Default: 0. Debug level of the auth module
654
655           debug_event int
656               Default: 0. Debug level of the event module
657
658           debug_holding int
659               Default: 0. Debug level of the holdingdisk module
660
661           debug_protocol int
662               Default: 0. Debug level of the protocol module
663
664           debug_planner int
665               Default: 0. Debug level of the planner process
666
667           debug_driver int
668               Default: 0. Debug level of the driver process
669
670           debug_dumper int
671               Default: 0. Debug level of the dumper process
672
673           debug_chunker int
674               Default: 0. Debug level of the chunker process
675
676           debug_taper int
677               Default: 0. Debug level of the taper process
678
679           flush-threshold-dumped int
680               Default: 0. Amanda will not begin writing data to a new volume
681               until the amount of data on the holding disk is at least this
682               percentage of the volume size. In other words, Amanda will not
683               begin until the amount of data on the holding disk is greater
684               than the tape length times this parameter. This parameter may
685               be larger than 100%, for example to keep more recent dumps on
686               the holding disk for faster recovery.
687
688               Needless to say, your holding disk must be big enough that this
689               criterion could be satisfied. If the holding disk cannot be
690               used for a particular dump (because, for example, there is no
691               remaining holding space) then Amanda will disregard the
692               constraint specified by this setting and start a new volume
693               anyway. Once writing to a volume has begun, this constraint is
694               not applied unless and until a new volume is needed.
695
696               The value of this parameter may not exceed than that of the
697               flush-threshold-scheduled parameter.
698
699           flush-threshold-scheduled int
700               Default: 0. Amanda will not begin writing data to a new volume
701               until the sum of the amount of data on the holding disk and the
702               estimated amount of data remaining to be dumped during this run
703               is at least this percentage of the volume size. In other words,
704               Amanda will not begin until the inequality h + s > t × d is
705               satisfied, where h is the amount of data on the holding disk, s
706               is the total amount of data scheduled for this run but not
707               dumped yet, t is the capacity of a volume, and d is this
708               parameter, expressed as a percentage. This parameter may be
709               larger than 100%.
710
711               Needless to say, your holding disk must be big enough that this
712               criterion could be satisfied. If the holding disk cannot be
713               used for a particular dump (because, for example, there is no
714               remaining holding space) then Amanda will disregard the
715               constraint specified by this setting and start a new volume
716               anyway. Once writing to a volume has begun, this constraint is
717               not applied unless and until a new volume is needed.
718
719               The value of this parameter may not be less than that of the
720               flush-threshold-dumped or taperflush parameters.
721
722           taperflush int
723               Default: 0. At the end of a run, Amanda will start a new tape
724               to flush remaining data if there is more data on the holding
725               disk at the end of a run than this setting allows; the amount
726               is specified as a percentage of the capacity of a single
727               volume. In other words, at the end of a run, Amanda will begin
728               a new tape if the inequality h > t × f is satisfied, where h is
729               the amount of data remaining on the holding disk from this or
730               previous runs, t is the capacity of a volume, and f is this
731               parameter, expressed as a percentage. This parameter may be
732               greater than 100%.
733
734               The value of this parameter may not exceed that of the
735               flush-threshold-scheduled parameter.; autoflush must be set to
736               ´yes´ if taperflush is greater than 0.
737
738           reserved-udp-port int,int
739               Default: --with-udpportrange or 512,1023. Reserved udp port
740               that will be used (bsd, bsdudp). Range is inclusive.
741
742           reserved-tcp-port int,int
743               Default: --with-low-tcpportrange or 512,1023. Reserved tcp port
744               that will be used (bsdtcp). Range is inclusive.
745
746           unreserved-tcp-port int,int
747               Default: --with-tcpportrange or 1024,65535. Unreserved tcp port
748               that will be used (bsd, bsdudp). Range is inclusive.
749

HOLDINGDISK SECTION

751       The amanda.conf file may define one or more holding disks used as
752       buffers to hold backup images before they are written to tape. The
753       syntax is:
754       define holdingdisk name {
755           holdingdisk-option holdingdisk-value
756           ...
757       }
758
759       The { must appear at the end of a line, and the } on its own line.
760
761       Name is a logical name for this holding disk.
762
763       The options and values are:
764
765       comment string
766           Default: not set. A comment string describing this holding disk.
767
768       directory string
769           Default: "/dumps/amanda". The path to this holding area.
770
771       use int
772           Default: 0 Gb. Amount of space that can be used in this holding
773           disk area. If the value is zero, all available space on the file
774           system is used. If the value is negative, Amanda will use all
775           available space minus that value.
776
777       chunksize int
778           Default: 1 Gb. Holding disk chunk size. Dumps larger than the
779           specified size will be stored in multiple holding disk files. The
780           size of each chunk will not exceed the specified value. However,
781           even though dump images are split in the holding disk, they are
782           concatenated as they are written to tape, so each dump image still
783           corresponds to a single continuous tape section.
784
785           The default unit is Kbytes if it is not specified.
786
787           If 0 is specified, Amanda will create holding disk chunks as large
788           as ((INT_MAX/1024)-64) Kbytes.
789
790           Each holding disk chunk includes a 32 Kbyte header, so the minimum
791           chunk size is 64 Kbytes (but that would be really silly).
792
793           Operating systems that are limited to a maximum file size of 2
794           Gbytes actually cannot handle files that large. They must be at
795           least one byte less than 2 Gbytes. Since Amanda works with 32 Kbyte
796           blocks, and to handle the final read at the end of the chunk, the
797           chunk size should be at least 64 Kbytes (2 * 32 Kbytes) smaller
798           than the maximum file size, e.g. 2047 Mbytes.
799

DUMPTYPE SECTION

801       The amanda.conf(5) file may define multiple sets of backup options and
802       refer to them by name from the disklist(5) file. For instance, one set
803       of options might be defined for file systems that can benefit from high
804       compression, another set that does not compress well, another set for
805       file systems that should always get a full backup and so on.
806
807       A set of backup options are entered in a dumptype section, which looks
808       like this:
809       define dumptype "name" {
810           dumptype-option dumptype-value
811           ...
812       }
813
814       The { must appear at the end of a line, and the } on its own line.
815
816       Name is the name of this set of backup options. It is referenced from
817       the disklist(5) file.
818
819       Some of the options in a dumptype section are the same as those in the
820       main part of amanda.conf(5). The main option value is used to set the
821       default for all dumptype sections. For instance, setting dumpcycle to
822       50 in the main part of the config file causes all following dumptype
823       sections to start with that value, but the value may be changed on a
824       section by section basis. Changes to variables in the main part of the
825       config file must be done before (earlier in the file) any dumptypes are
826       defined.
827
828       The dumptype options and values are:
829
830       auth string
831           Default: "bsd". Type of authorization to perform between tape
832           server and backup client hosts. See amanda-auth(7) for more detail.
833
834       amandad_path string
835           Default: "$libexec/amandad". Specify the amandad path of the
836           client, only use with rsh/ssh authentification.
837
838       client_username string
839           Default: CLIENT_LOGIN. Specify the username to connect on the
840           client, only use with rsh/ssh authentification.
841
842       client_port [ int | string ]
843           Default: "amanda". Specifies the port to connect to on the client.
844           It can be a service name or a numeric port number.
845
846       bumpsize int
847           Default: 10 Mbytes. The minimum savings required to trigger an
848           automatic bump from one incremental level to the next, expressed as
849           size. If Amanda determines that the next higher backup level will
850           be this much smaller than the current level, it will do the next
851           level. The value of this parameter is used only if the parameter
852           bumppercent is set to 0.
853
854           The default unit is Kbytes if it is not specified.
855
856           See also the options bumppercent, bumpmult and bumpdays.
857
858       bumppercent int
859           Default: 0. The minimum savings required to trigger an automatic
860           bump from one incremental level to the next, expressed as
861           percentage of the current size of the DLE (size of current level
862           0). If Amanda determines that the next higher backup level will be
863           this much smaller than the current level, it will do the next
864           level.
865
866           If this parameter is set to 0, the value of the parameter bumpsize
867           is used to trigger bumping.
868
869           See also the options bumpsize, bumpmult and bumpdays.
870
871       bumpmult float
872           Default: 1.5. The bump size multiplier. Amanda multiplies bumpsize
873           by this factor for each level. This prevents active filesystems
874           from bumping too much by making it harder to bump to the next
875           level. For example, with the default bumpsize and bumpmult set to
876           2.0, the bump threshold will be 10 Mbytes for level one, 20 Mbytes
877           for level two, 40 Mbytes for level three, and so on.
878
879       bumpdays int
880           Default: 2 days. To insure redundancy in the dumps, Amanda keeps
881           filesystems at the same incremental level for at least bumpdays
882           days, even if the other bump threshold criteria are met.
883
884       comment string
885           Default: not set. A comment string describing this set of backup
886           options.
887
888       comprate float [, float ]
889           Default: 0.50, 0.50. The expected full and incremental compression
890           factor for dumps. It is only used if Amanda does not have any
891           history information on compression rates for a filesystem, so
892           should not usually need to be set. However, it may be useful for
893           the first time a very large filesystem that compresses very little
894           is backed up.
895
896       compress [ none | client | server ] [ best | fast | custom ]
897           Default: client fast. If Amanda does compression of the backup
898           images, it can do so either on the backup client host before it
899           crosses the network or on the tape server host as it goes from the
900           network into the holding disk or to tape. Which place to do
901           compression (if at all) depends on how well the dump image usually
902           compresses, the speed and load on the client or server, network
903           capacity, holding disk capacity, availability of tape hardware
904           compression, etc.
905
906           For either type of compression, Amanda also allows the selection of
907           three styles of compression.  best is the best compression
908           available, often at the expense of CPU overhead.  fast is often not
909           as good a compression as best, but usually less CPU overhead. Or to
910           specify custom to use your own compression method. (See dumptype
911           custom-compress in example/amanda.conf for reference)
912
913           So the compress options line may be one of:
914
915           compress none
916
917           compress client fast
918
919           compress client best
920
921           compress client custom
922               Specify client_custom_compress "PROG"
923
924               PROG must not contain white space and it must accept -d for
925               uncompress.
926
927           compress server fast
928
929           compress server best
930
931           compress server custom
932               Specify server_custom_compress "PROG"
933
934               PROG must not contain white space and it must accept -d for
935               uncompress.
936
937           Note that some tape devices do compression and this option has
938           nothing to do with whether that is used. If hardware compression is
939           used (usually via a particular tape device name or mt option),
940           Amanda (software) compression should be disabled.
941
942       client_custom_compress string
943           Default: none. The program to use to perform
944           compression/decompression on the client; used with "compress client
945           custom". Must not contain whitespace. Must accept -d to uncompress.
946
947       server_custom_compress string
948           Default: none. The program to use to perform
949           compression/decompression on the server; used with "compress server
950           custom". Must not contain whitespace. Must accept -d to uncompress.
951
952       dumpcycle int
953           Default: 10 days. The number of days in the backup cycle. Each disk
954           using this set of options will get a full backup at least this of
955           ten. Setting this to zero tries to do a full backup each run.
956
957       encrypt [ none | client | server ]
958           Default: not set. To encrypt backup images, it can do so either on
959           the backup client host before it crosses the network or on the tape
960           server host as it goes from the network into the holding disk or to
961           tape.
962
963           So the encrypt options line may be one of:
964
965           encrypt none
966
967           encrypt client
968               Specify client_encrypt "PROG"
969
970               PROG must not contain white space.
971
972               Specify client_decrypt_option "decryption-parameter" Default:
973               "-d"
974
975               decryption-parameter must not contain white space.
976
977               (See dumptype client-encrypt-nocomp in example/amanda.conf for
978               reference)
979
980           encrypt server
981               Specify server_encrypt "PROG"
982
983               PROG must not contain white space.
984
985               Specify server_decrypt_option "decryption-parameter" Default:
986               "-d"
987
988               decryption-parameter must not contain white space.
989
990               (See dumptype server-encrypt-fast in example/amanda.conf for
991               reference)
992
993           Note that current logic assumes compression then encryption during
994           backup(thus decrypt then uncompress during restore). So specifying
995           client-encryption AND server-compression is not supported.  amcrypt
996           which is a wrapper of aespipe is provided as a reference symmetric
997           encryption program.
998
999       client_encrypt string
1000           Default: none. The program to use to perform encryption/decryption
1001           on the client; used with "encrypt client". Must not contain
1002           whitespace.
1003
1004       client_decrypt_option string
1005           Default: -d. The option that can be passed to client_encrypt to
1006           make it decrypt instead. Must not contain whitespace.
1007
1008       server_encrypt string
1009           Default: none. The program to use to perform encryption/decryption
1010           on the server; used with "encrypt server". Must not contain
1011           whitespace.
1012
1013       server_decrypt_option string
1014           Default: -d. The option that can be passed to server_encrypt to
1015           make it decrypt instead. Must not contain whitespace.
1016
1017       estimate [ client | calcsize | server ]+
1018           Default: client. Determine the way Amanda estimates the size of
1019           each DLE before beginning a backup. This is a list of acceptable
1020           estimate methods, and Amanda applies the first method supported by
1021           the application. The methods are:
1022
1023           client
1024               Use the same program as the dumping program. This is the most
1025               accurate method to do estimates, but it can take a long time.
1026
1027           calcsize
1028               Use a faster program to do estimates, but the result is less
1029               accurate.
1030
1031           server
1032               Use only statistics from the previous few runs to give an
1033               estimate. This very quick, but the result is not accurate if
1034               your disk usage changes from day to day. If this method is
1035               specified, but the server does not have enough data to make an
1036               estimate, then the option is internally moved to the end of the
1037               list, thereby preferring ´client´ or ´calcsize´ in this case.
1038
1039       exclude [ list | file ][[optional][append][ string ]+]
1040           Default: file. Exclude is the opposite of include and specifies
1041           files that will be excluded from the backup. The format of the
1042           exclude expressions depends on the application, and some
1043           applications do not support excluding files at all.
1044
1045           There are two exclude parameters, exclude file and exclude list.
1046           With exclude file, the string is an exclude expression. With
1047           exclude list , the string is a file name on the client containing
1048           GNU-tar exclude expressions. The path to the specified exclude list
1049           file, if present (see description of ´optional´ below), must be
1050           readable by the Amanda user.
1051
1052           All exclude expressions are concatenated in one file and passed to
1053           the application as an --exclude-from argument.
1054
1055           For GNU-tar, exclude expressions must always be specified as
1056           relative to the top-level directory of the DLE, and must start with
1057           "./". See the manpages for individual applications for more
1058           information on supported exclude expressions.
1059
1060           With the append keyword, the string is appended to the current
1061           list, without it, the string overwrites the list.
1062
1063           If optional is specified for exclude list, then amcheck will not
1064           complain if the file doesn´t exist or is not readable.
1065
1066           For exclude list, if the file name is relative, the disk name being
1067           backed up is prepended. So if this is entered:
1068               exclude list ".amanda.excludes"
1069           the actual file used would be /var/.amanda.excludes for a backup of
1070           /var, /usr/local/.amanda.excludes for a backup of /usr/local, and
1071           so on.
1072
1073       holdingdisk [ never | auto | required ]
1074           Default: auto. Whether a holding disk should be used for these
1075           backups or whether they should go directly to tape. If the holding
1076           disk is a portion of another file system that Amanda is backing up,
1077           that file system should refer to a dumptype with holdingdisk set to
1078           never to avoid backing up the holding disk into itself.
1079
1080           never|no|false|off
1081               Never use a holdingdisk, the dump will always go directly to
1082               tape. There will be no dump if you have a tape error.
1083
1084           auto|yes|true|on
1085               Use the holding disk, unless there is a problem with the
1086               holding disk, the dump won´t fit there or the medium doesn´t
1087               require spooling (e.g., VFS device)
1088
1089           required
1090               Always dump to holdingdisk, never directly to tape. There will
1091               be no dump if it doesn´t fit on holdingdisk
1092
1093       ignore boolean
1094           Default: no. Whether disks associated with this backup type should
1095           be backed up or not. This option is useful when the disklist file
1096           is shared among several configurations, some of which should not
1097           back up all the listed file systems.
1098
1099       include [ list | file ][[optional][append][ string ]+]
1100           Default: file ".". There are two include lists, include file and
1101           include list.  With include file , the string is a glob expression.
1102           With include list , the string is a file name on the client
1103           containing glob expressions.
1104
1105           All include expressions are expanded by Amanda, concatenated in one
1106           file and passed to GNU-tar as a --files-from argument. They must
1107           start with "./" and contain no other "/".
1108
1109           Include expressions must always be specified as relative to the
1110           head directory of the DLE.
1111
1112               Note
1113               For globbing to work at all, even the limited single level, the
1114               top level directory of the DLE must be readable by the Amanda
1115               user.
1116           With the append keyword, the string is appended to the current
1117           list, without it, the string overwrites the list.
1118
1119           If optional is specified for include list, then amcheck will not
1120           complain if the file doesn´t exist or is not readable.
1121
1122           For include list, If the file name is relative, the disk name being
1123           backed up is prepended.
1124
1125       index boolean
1126           Default: no. Whether an index (catalogue) of the backup should be
1127           generated and saved in indexdir. These catalogues are used by the
1128           amrecover utility.
1129
1130       kencrypt boolean
1131           Default: no. Whether the backup image should be encrypted by
1132           Kerberos as it is sent across the network from the backup client
1133           host to the tape server host.
1134
1135       maxdumps int
1136           Default: 1. The maximum number of backups from a single host that
1137           Amanda will attempt to run in parallel. See also the main section
1138           parameter inparallel.
1139
1140       maxpromoteday int
1141           Default: 10000. The maximum number of day for a promotion, set it 0
1142           if you don´t want promotion, set it to 1 or 2 if your disks get
1143           overpromoted.
1144
1145       priority [ low | medium | high ]
1146           Default: medium. When there is no tape to write to, Amanda will do
1147           incremental backups in priority order to the holding disk. The
1148           priority may be high (2), medium (1), low (0) or a number of your
1149           choice.
1150
1151       program [ "DUMP" | "GNUTAR" | "APPLICATION" ]
1152           Default: "DUMP". The type of backup to perform. Valid values are:
1153
1154           "DUMP"
1155               The native operating system backup program.
1156
1157           "GNUTAR"
1158               To use GNU-tar or to do PC backups using Samba.
1159
1160           "APPLICATION"
1161               To use an application, see the application option.
1162
1163       application string
1164           No default. Must be the name of an application if program is set to
1165           APPLICATION. See APPLICATION SECTION below.
1166
1167       script string
1168           No default. Must be the name of a script. You can have many script.
1169           See SCRIPT SECTION below.
1170
1171       property [append] string string+
1172           These options can set various properties, they can be used by third
1173           party software to store information in the configuration file. Both
1174           strings are quoted; the first string contains the name of the
1175           property to set, and the others contains its values.  append
1176           keyword append the values to the list of values for that property.
1177
1178       record boolean
1179           Default: yes. Whether to ask the backup program to update its
1180           database (e.g.  /etc/dumpdates for DUMP or
1181           /usr/local/var/amanda/gnutar-lists for GNUTAR) of time stamps. This
1182           is normally enabled for daily backups and turned off for periodic
1183           archival runs.
1184
1185       skip-full boolean
1186           Default: no. If true and planner has scheduled a full backup, these
1187           disks will be skipped, and full backups should be run off-line on
1188           these days. It was reported that Amanda only schedules level 1
1189           incrementals in this configuration; this is probably a bug.
1190
1191       skip-incr boolean
1192           Default: no. If true and planner has scheduled an incremental
1193           backup, these disks will be skipped.
1194
1195       ssh_keys string
1196           Default: not set. The key file the ssh auth will use, it must be
1197           the private key. If this parameter is not specified, then the
1198           default ssh key will be used.
1199
1200       starttime int
1201           Default: not set. Backup of these disks will not start until after
1202           this time of day. The value should be hh*100+mm, e.g. 6:30PM
1203           (18:30) would be entered as 1830.
1204
1205       strategy [ standard | nofull | noinc | skip | incronly ]
1206           Default: standard. Strategy to use when planning what level of
1207           backup to run next. Values are:
1208
1209           standard
1210               The standard Amanda schedule.
1211
1212           nofull
1213               Never do full backups, only level 1 incrementals.
1214
1215           noinc
1216               Never do incremental backups, only full dumps.
1217
1218           skip
1219               Treat this DLE as if it doesn´t exist (useful to disable DLEs
1220               when sharing the disklist file between multiple
1221               configurations). Skipped DLEs will not be checked or dumped,
1222               and will not be matched by disklist expressions.
1223
1224           incronly
1225               Only do incremental dumps.  amadmin force should be used to
1226               tell Amanda that a full dump has been performed off-line, so
1227               that it resets to level 1.
1228
1229       tape_splitsize int
1230           Default: not set. Split dump file on tape into pieces of a
1231           specified size. This allows dumps to be spread across multiple
1232           tapes, and can potentially make more efficient use of tape space.
1233           Note that if this value is too large (more than half the size of
1234           the average dump being split), substantial tape space can be
1235           wasted. If too small, large dumps will be split into innumerable
1236           tiny dumpfiles, adding to restoration complexity. A good rule of
1237           thumb, usually, is 1/10 of the size of your tape.
1238
1239           The default unit is Kbytes if it is not specified.
1240
1241       split_diskbuffer string
1242           Default: not set. When dumping a split dump in PORT-WRITE mode
1243           (usually meaning "no holding disk"), buffer the split chunks to a
1244           file in the directory specified by this option.
1245
1246       fallback_splitsize int
1247           Default: 10M. When dumping a split dump in PORT-WRITE mode, if no
1248           split_diskbuffer is specified (or if we somehow fail to use our
1249           split_diskbuffer), we must buffer split chunks in memory. This
1250           specifies the maximum size split chunks can be in this scenario,
1251           and thus the maximum amount of memory consumed for in-memory
1252           splitting. The size of this buffer can be changed from its (very
1253           conservative) default to a value reflecting the amount of memory
1254           that each taper process on the dump server may reasonably consume.
1255
1256           The default unit is Kbytes if it is not specified.
1257
1258       The following dumptype entries are predefined by Amanda:
1259       define dumptype "no-compress" {
1260           compress none
1261       }
1262       define dumptype "compress-fast" {
1263           compress client fast
1264       }
1265       define dumptype "compress-best" {
1266           compress client best
1267       }
1268       define dumptype "srvcompress" {
1269           compress server fast
1270       }
1271       define dumptype "bsd-auth" {
1272           auth bsd
1273       }
1274       define dumptype "no-record" {
1275           record no
1276       }
1277       define dumptype "no-hold" {
1278           holdingdisk no
1279       }
1280       define dumptype "no-full" {
1281           skip-full yes
1282       }
1283
1284       In addition to options in a dumptype section, one or more other
1285       dumptype names may be supplied as identifiers, which make this dumptype
1286       inherit options from other previously defined dumptypes. For instance,
1287       two sections might be the same except for the record option:
1288       define dumptype "normal" {
1289           comment "Normal backup, no compression, do indexing"
1290           no-compress
1291           index yes
1292           maxdumps 2
1293       }
1294       define dumptype "testing" {
1295           comment "Test backup, no compression, do indexing, no recording"
1296           "normal"
1297           record no
1298       }
1299
1300       Amanda provides a dumptype named global in the sample amanda.conf file
1301       that all dumptypes should reference. This provides an easy place to
1302       make changes that will affect every dumptype, although you must be
1303       careful that every dumptype explicitly inherits from the global
1304       dumptype - Amanda does not do so automatically.
1305

TAPETYPE SECTION

1307       The amanda.conf file may define multiple types of tape media and
1308       devices. The information is entered in a tapetype section, which looks
1309       like this in the config file:
1310       define tapetype "name" {
1311           tapetype-option tapetype-value
1312           ...
1313       }
1314
1315       The { must appear at the end of a line, and the } on its own line.
1316
1317       Name is the name of this type of tape medium/device. It is referenced
1318       from the tapetype option in the main part of the config file.
1319
1320       The tapetype options and values are:
1321
1322       comment string
1323           Default: not set. A comment string describing this set of tape
1324           information.
1325
1326       filemark int
1327           Default: 1 kbytes. How large a file mark (tape mark) is, measured
1328           in kbytes. If the size is only known in some linear measurement
1329           (e.g. inches), convert it to kbytes using the device density.
1330
1331       length int
1332           Default: 2000 kbytes. How much data will fit on a tape, expressed
1333           in kbytes.
1334
1335           Note that this value is only used by Amanda to schedule which
1336           backups will be run. Once the backups start, Amanda will continue
1337           to write to a tape until it gets an error, regardless of what value
1338           is entered for length (but see amanda-devices(7) for exceptions).
1339
1340       blocksize int
1341           Default: 32 kbytes. How much data will be written in each tape
1342           record, expressed in kbytes. This is similar to the BLOCK_SIZE
1343           device property, but if the blocksize is not a multiple of 1024
1344           bytes, then this parameter cannot be used to specify it, and the
1345           property must be used instead.
1346
1347       readblocksize int
1348           Default: 32 kytes How much data will be read in each tape record.
1349           This can be used to override a device´s block size for reads only.
1350           This may be useful, for example, in reading a tape written with a
1351           256k block size when Amanda is configured to use 128k blocks. This
1352           unusual feature is not supported by all operating systems and tape
1353           devices.
1354
1355           The default unit is Kbytes if it is not specified.
1356
1357       speed int
1358           Default: 200 bps. How fast the drive will accept data, in bytes per
1359           second. This parameter is NOT currently used by Amanda.
1360
1361       lbl-templ string
1362           Default: not set. A PostScript template file used by amreport to
1363           generate labels. Several sample files are provided with the Amanda
1364           sources in the example directory. See the amreport(8) man page for
1365           more information.
1366
1367       In addition to options, another tapetype name may be supplie as an
1368       identifier, which makes this tapetype inherit options from another
1369       tapetype. For instance, the only difference between a DLT4000 tape
1370       drive using Compact-III tapes and one using Compact-IV tapes is the
1371       length of the tape. So they could be entered as:
1372       define tapetype "DLT4000-III" {
1373           comment "DLT4000 tape drives with Compact-III tapes"
1374           length 12500 mbytes         # 10 Gig tapes with some compression
1375           filemark 2000 kbytes
1376           speed 1536 kps
1377       }
1378       define tapetype "DLT4000-IV" {
1379           "DLT4000-III"
1380           comment "DLT4000 tape drives with Compact-IV tapes"
1381           length 25000 mbytes         # 20 Gig tapes with some compression
1382       }
1383

INTERFACE SECTION

1385       The amanda.conf file may define multiple types of network interfaces.
1386       The information is entered in an interface section, which looks like
1387       this:
1388       define interface "name" {
1389           interface-option interface-value
1390           ...
1391       }
1392
1393       The { must appear at the end of a line, and the } on its own line.
1394
1395       name is the name of this type of network interface. It is referenced
1396       from the disklist file.
1397
1398       Note that these sections define network interface characteristics, not
1399       the actual interface that will be used. Nor do they impose limits on
1400       the bandwidth that will actually be taken up by Amanda. Amanda computes
1401       the estimated bandwidth each file system backup will take based on the
1402       estimated size and time, then compares that plus any other running
1403       backups with the limit as another of the criteria when deciding whether
1404       to start the backup. Once a backup starts, Amanda will use as much of
1405       the network as it can leaving throttling up to the operating system and
1406       network hardware.
1407
1408       The interface options and values are:
1409
1410       comment string
1411           Default: not set. A comment string describing this set of network
1412           information.
1413
1414       use int
1415           Default: 8000 Kbps. The speed of the interface in Kbytes per
1416           second.
1417
1418       In addition to options, another interface name may be supplied as an
1419       identifier, which makes this interface inherit options from another
1420       interface. At the moment, this is of little use.
1421

APPLICATION SECTION

1423       The amanda.conf file may define multiple types of application. The
1424       information is entered in a application section, which looks like this:
1425       define application "name" {
1426           application-option application-value
1427           ...
1428       }
1429
1430       The { must appear at the end of a line, and the } on its own line.
1431
1432       name is the name of this type of application. It is referenced from the
1433       dumptype
1434
1435       The application options and values are:
1436
1437       comment string
1438           Default: not set. A comment string describing this application.
1439
1440       plugin string
1441           No default. Must be set to the name of the program. This program
1442           must be in the $libexecdir/amanda/application directory on the
1443           client.
1444
1445       property [append] [priority] string string+
1446           No default. You can set property for the application, each
1447           application have a different set of property. Both strings are
1448           quoted; the first string contains the name of the property to set,
1449           and the others contains its values.  append keyword append the
1450           values to the list of values for that property.  priority keyword
1451           disallow the setting of that property on the client.
1452

SCRIPT SECTION

1454       The amanda.conf file may define multiple types of script. The
1455       information is entered in a script section, which looks like this:
1456       define script "name" {
1457           script-option script-value
1458           ...
1459       }
1460
1461       The { must appear at the end of a line, and the } on its own line.
1462
1463       name is the name of this type of script. It is referenced from the
1464       dumptype
1465
1466       The script options and values are:
1467
1468       comment string
1469           Default: not set. A comment string describing this script.
1470
1471       plugin string
1472           No default. Must be set to the name of the program. This program
1473           must be in the $libexecdir/amanda/application directory on the
1474           client and/or server.
1475
1476       order int
1477           Default: 5000. Scripts are executed in that order, it is useful if
1478           you have many scripts and they must be executed in a spefific
1479           order.
1480
1481       execute_where [ client | server ]
1482           Default: client. Where the script must be executed, on the client
1483           or server.
1484
1485       >execute_on execute_on [,execute_on]*
1486           No default. When the script must be executed, you can specify many
1487           of them:
1488
1489           pre-dle-amcheck
1490               Execute before the amcheck command for the dle.
1491
1492           pre-host-amcheck
1493               Execute before the amcheck command for all dle for the client.
1494
1495           post-dle-amcheck
1496               Execute after the amcheck command for the dle.
1497
1498           post-host-amcheck
1499               Execute after the amcheck command for all dle for the client.
1500
1501           pre-dle-estimate
1502               Execute before the estimate command for the dle.
1503
1504           pre-host-estimate
1505               Execute before the estimate command for all dle for the client.
1506
1507           post-dle-estimate
1508               Execute after the estimate command for the dle.
1509
1510           post-host-estimate
1511               Execute after the estimate command for all dle for the client.
1512
1513           pre-dle-backup
1514               Execute before the backup command for the dle.
1515
1516           pre-host-backup
1517               Execute before the backup command for all dle for the client.
1518               It can´t be run on client, it must be run on server
1519
1520           post-dle-backup
1521               Execute after the backup command for the dle.
1522
1523           post-host-backup
1524               Execute after the backup command for all dle for the client. It
1525               can´t be run on client, it must be run on server
1526
1527           pre-recover
1528               Execute before any level is recovered.
1529
1530           post-recover
1531               Execute after all levels are recovered.
1532
1533           pre-level-recover
1534               Execute before each level recovery.
1535
1536           post-level-recover
1537               Execute after each level recovery.
1538
1539           inter-level-recover
1540               Execute between two levels of recovery.
1541
1542           If you recover level 0 and 2 of the disk /usr with amrecover, it
1543           will execute:
1544           script --pre-recover
1545           script --pre-level-recover --level 0
1546           #recovering level 0
1547           script --post-level-recover --level 0
1548           script --inter-level-recover --level 0 --level 2
1549           script --pre-level-recover --level 2
1550           #recovering level 2
1551           script --post-level-recover --level 2
1552           script --post-recover
1553
1554       property> [append] [priority] string string+
1555           No default. You can set property for the script, each script have a
1556           different set of property. Both strings are quoted; the first
1557           string contains the name of the property to set, and the others
1558           contains its values.  append keyword append the values to the list
1559           of values for that property.  priority keyword disallow the setting
1560           of that property on the client.
1561

DEVICE SECTION

1563       Backend storage devices are specified in amanda.conf in the form of
1564       "device" sections, which look like this:
1565       define device name {
1566           commend "comment (optional)"
1567           tapedev "device-specifier"
1568           device_property "prop-name" "prop-value"
1569           ...
1570       }
1571
1572       The { must appear at the end of a line, and the } on its own line.
1573
1574       name is the user-specified name of this device. It is referenced from
1575       the global tapedev parameter. The device-specifier specifies the device
1576       name to use; see amanda-devices(7). As with most sections, the comment
1577       parmeter is optional and only for the user´s convenience.
1578
1579       An arbitrary number of device_property parameters can be specified.
1580       Again, see amanda-devices(7) for information on device properties.
1581

CHANGER SECTION

1583       Changers are described in amanda.conf in the form of "changer"
1584       sections, which look like this:
1585       define changer name {
1586           comment "comment (optional)"
1587           tpchanger "changer-spec"
1588           changerdev "device-name"
1589           changerfile "state-file"
1590           ...
1591       }
1592
1593       The { must appear at the end of a line, and the } on its own line.
1594
1595       name is the user-specified name of this device. The remaining
1596       parameters are specific to the changer type selected.
1597
1598       See amanda-changers(7) for more information on configuring changers.
1599

SEE ALSO

1601       amanda(8), amanda-client.conf(5), amanda-applications(7), amanda-
1602       auth(7), amanda-changers(7), amanda-devices(7), amanda-scripts(7)
1603
1604       The Amanda Wiki: : http://wiki.zmanda.com/
1605

AUTHORS

1607       James da Silva <jds@amanda.org>
1608
1609       Stefan G. Weichinger <sgw@amanda.org>
1610
1611
1612
1613Amanda 3.1.3                      10/04/2010                    AMANDA.CONF(5)
Impressum