1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
5 <!-- entities files to use -->
6 <!ENTITY % global_entities SYSTEM 'global.entities'>
10 <refentry id='amanda.conf.5'>
13 <refentrytitle>amanda.conf</refentrytitle>
14 <manvolnum>5</manvolnum>
20 <refname>amanda.conf</refname>
21 <refpurpose>Main configuration file for Amanda, the Advanced Maryland Automatic Network Disk Archiver</refpurpose>
27 <!-- body begins here -->
29 <refsect1><title>DESCRIPTION</title>
30 <para>&amconf; is the main configuration file for Amanda. This manpage lists the
31 relevant sections and parameters of this file for quick reference.</para>
32 <para> The file <emphasis remap='B'><CONFIG_DIR>/<config>/amanda.conf</emphasis> is loaded.</para>
35 <refsect1><title>SYNTAX</title>
37 <para>There are a number of configuration parameters that control the
38 behavior of the Amanda programs.
39 All have default values,
40 so you need not specify the parameter in
41 <emphasis remap='B'>amanda.conf</emphasis>
42 if the default is suitable.</para>
44 <refsect2><title>COMMENTS</title>
46 <para>Lines starting with # are ignored, as are blank lines.
47 Comments may be placed on a line with a directive by starting
49 The remainder of the line is ignored.</para>
52 <refsect2><title>KEYWORDS AND IDENTIFIERS</title>
54 <para>Keywords are case insensitive, i.e.
55 <amkeyword>mailto</amkeyword>
57 <amkeyword>MailTo</amkeyword>
58 are treated the same. Also, the characters
59 '<amkeyword>-</amkeyword>'
61 '<amkeyword>_</amkeyword>'
62 are interchangeable in all predefined Amanda keywords:
63 <amkeyword>device_property</amkeyword>
65 <amkeyword>device-property</amkeyword>
66 have the same meaning.</para>
68 <para>Identifiers are names which are defined in the configuration itself, such
69 as dumptypes or interfaces. Identifiers are are case-insensitive, but
71 '<amkeyword>-</amkeyword>'
73 '<amkeyword>_</amkeyword>'.
74 Identifiers should be quoted in the configuration file, although For historical
75 reasons, the quotes are optional.</para>
77 <para>Strings are always quoted with double quotes ("), and any double quotes
78 or backslashes within the string are escaped with a backslash:
80 tapelist "/path/to/tapelist"
81 property "escaped-string" "escaping: \\ (backslash) and \" (double-quote)"
85 <para>To summarize, then:
88 logdir "logs" # required sensitive sensitive
89 send-amreport-on strange # prohibited insensitive insensitive
90 tapetype "EXABYTE" # optional insensitive sensitive
92 define dumptype "dt" { # optional insensitive sensitive
93 "dumptype-common" # optional insensitive sensitive
94 strategy noincr # prohibited insensitive insensitive
101 <refsect2><title>VALUE SUFFIXES</title>
103 <para>Integer arguments may have one of the following (case insensitive) suffixes,
104 some of which have a multiplier effect:</para>
106 <variablelist remap='TP'>
108 <term><amkeyword>b byte bytes</amkeyword></term>
110 <para>Some number of bytes.</para>
114 <term><amkeyword>bps</amkeyword></term>
116 <para>Some number of bytes per second.</para>
120 <term><amkeyword>k kb kbyte kbytes kilobyte kilobytes</amkeyword></term>
122 <para>Some number of kilobytes (bytes*1024).</para>
126 <term><amkeyword>kps kbps</amkeyword></term>
128 <para>Some number of kilobytes per second (bytes*1024).</para>
129 <para>It is the default multiplier for all size options.</para>
133 <term><amkeyword>m mb meg mbyte mbytes megabyte megabytes</amkeyword></term>
135 <para>Some number of megabytes (bytes*1024*1024).</para>
139 <term><amkeyword>mps mbps</amkeyword></term>
141 <para>Some number of megabytes per second (bytes*1024*1024).</para>
145 <term><amkeyword>g gb gbyte gbytes gigabyte gigabytes</amkeyword></term>
147 <para>Some number of gigabytes (bytes*1024*1024*1024).</para>
151 <term><amkeyword>t tb tbyte tbytes terabyte terabytes</amkeyword></term>
153 <para>Some number of terabytes (bytes*1024*1024*1024*1024).</para>
157 <term><amkeyword>tape tapes</amkeyword></term>
159 <para>Some number of tapes.</para>
163 <term><amkeyword>day days</amkeyword></term>
165 <para>Some number of days.</para>
169 <term><amkeyword>week weeks</amkeyword></term>
171 <para>Some number of weeks (days*7).</para>
173 <note><para>The value
174 <amkeyword>inf</amkeyword>
175 may be used in most places where an integer is expected
176 to mean an infinite amount.</para>
178 <para>Boolean arguments may have any of the values
179 <amkeyword>1</amkeyword>,
180 <amkeyword>y</amkeyword>,
181 <amkeyword>yes</amkeyword>,
182 <amkeyword>t</amkeyword>,
183 <amkeyword>true</amkeyword>
185 <amkeyword>on</amkeyword>
186 to indicate a true state, or
187 <amkeyword>0</amkeyword>,
188 <amkeyword>n</amkeyword>,
189 <amkeyword>no</amkeyword>,
190 <amkeyword>f</amkeyword>,
191 <amkeyword>false</amkeyword>
193 <amkeyword>off</amkeyword>
194 to indicate a false state.
195 If no argument is given,
196 <amkeyword>true</amkeyword>
205 <refsect2><title>PARAMETER ORDER</title>
207 <para>In general, the order in which parameters occur in the configuration file
208 does not matter, with the exception of subsection inheritance. For example, if
209 dumptype "normal-encrypt" which inherits from dumptype "normal", then "normal"
210 must appear first in the configuration file.</para>
214 <refsect2><title>STRINGS</title>
215 <para>Quoted strings in Amanda follow a common, C-like syntax. Printable
216 characters and whitespace are kept as-is, except that the backslash character
217 (\) is used as an escape character, and a double-quote ends the string. The allowed
220 ESCAPE SEQUENCE BECOMES
229 \001 - \377 (character specified in octal)
231 Illegally quoted strings are handled on a "best-effort" basis, which may lead to
236 finserver "/data/finance/XYZ Corp's \"real\" finances" finance-high eth0 -1
237 property "syspath" "C:\\WINDOWS\\SYSTEM"
242 <refsect2><title>SUBSECTIONS AND INHERITANCE</title>
244 <para>Amanda configuration files may include various
245 <emphasis>subsections</emphasis>, each defining a set of configuration
246 directives. Each type of subsection is described below. Note that all types
247 of subsections can <emphasis>inherit</emphasis> from other subsections of the
248 same type by naming the "parent" section in the "child" subsection. For
252 define dumptype global {
257 define dumptype nocomp {
258 global # inherit the parameters in dumptype 'global'
261 </programlisting></para>
263 <para>Note that multiple inheritance is also supported by simply naming
264 multiple parent sections in a child. Parents are implicitly expanded in place
265 in a child, and the last occurrence of each parameter takes precedence. For
268 define tapetype par1 {
274 define tapetype par2 {
279 define tapetype child {
285 In this example, 'child' will have a filemark of 32k, a speed of 400bps, and a
286 length of 200M.</para>
292 <title>GLOBAL PARAMETERS</title>
294 <variablelist remap='TP'>
296 <term><amkeyword>org</amkeyword> <amtype>string</amtype></term>
299 <amdefault>"daily"</amdefault>.
300 A descriptive name for the configuration.
301 This string appears in the Subject line of mail reports.
302 Each Amanda configuration should have a different string to keep
303 mail reports distinct.</para>
307 <term><amkeyword>mailer</amkeyword> <amtype>string</amtype></term>
309 <para>Default found by configure. A mail program that can send mail with '<emphasis remap='I'>MAILER -s "subject" user < message_file</emphasis>'.</para>
313 <term><amkeyword>mailto</amkeyword> <amtype>string</amtype></term>
316 A space separated list of recipients for mail reports. If not specified, amdump will not send any mail.</para>
320 <term><amkeyword>send-amreport-on</amkeyword> [ <amkeyword>all</amkeyword> | <amkeyword>strange</amkeyword> | <amkeyword>error</amkeyword> | <amkeyword>never</amkeyword> ]</term>
323 <amkeyword>all</amkeyword>.
324 Specify which types of messages will trigger an email from amreport. amreport is used by amdump and amflush.</para>
326 <variablelist remap='TP'>
328 <term><amkeyword>all</amkeyword></term>
330 <para>Send an email on any message.</para>
334 <term><amkeyword>strange</amkeyword></term>
336 <para>Send an email on strange or error message. A strange message occurs when the dump succeeded, but returned one or more errors unknown to Amanda.</para>
340 <term><amkeyword>error</amkeyword></term>
342 <para>Send an email only on error messages.</para>
346 <term><amkeyword>never</amkeyword></term>
348 <para>Never send an email.</para>
355 <term><amkeyword>dumpcycle</amkeyword> <amtype>int</amtype></term>
358 <amdefault>10 days</amdefault>.
359 The number of days in the backup cycle.
360 Each disk will get a full backup at least this often.
361 Setting this to zero tries to do a full backup each run.</para>
362 <note><para>This parameter may also be set in a specific
363 <amkeyword>dumptype</amkeyword>
365 This value sets the default for all
366 <amkeyword>dumptype</amkeyword>s
368 <emphasis remap='B'>amanda.conf</emphasis>
370 <amkeyword>dumptype</amkeyword>s
377 <term><amkeyword>runspercycle</amkeyword> <amtype>int</amtype></term>
380 <amdefault>same as dumpcycle</amdefault>.
381 The number of amdump runs in
382 <amkeyword>dumpcycle</amkeyword>
384 A value of 0 means the same value as
385 <amkeyword>dumpcycle</amkeyword>.
386 A value of -1 means guess the number of runs from the &tapelist; file,
387 which is the number of tapes used in the last
388 <amkeyword>dumpcycle</amkeyword>
390 <amkeyword>runtapes</amkeyword>.</para>
394 <term><amkeyword>tapecycle</amkeyword> <amtype>int</amtype></term>
397 <amdefault>15 tapes</amdefault>.
398 Typically tapes are used by Amanda in an ordered rotation. The <amkeyword>tapecycle</amkeyword> parameter
399 defines the size of that rotation. This parameter must be be larger than the number of tapes
400 used in a dumpcycle.</para>
402 The number of tapes per dumpcycle is calculated by multiplying the number of
403 &amdump; runs per dump cycle <amkeyword>runspercycle</amkeyword> (the
404 number of &amdump; runs per dump cycle) and <emphasis
405 remap='B'>runtapes</emphasis> (the number of tapes used per run). Typically
406 <amkeyword>tapecycle</amkeyword> is set to two or four times the tapes
407 per dumpcycle.</para>
409 <note>Amanda is commonly misconfigured with <amkeyword>tapecycle</amkeyword>
410 equal to the number of tapes per <amkeyword>dumpcycle</amkeyword>. In this
411 misconfiguration, amanda may erase a full dump before a new one is completed,
412 the recovery is then impossible. tapecycle must be at least one tape larger
413 than the number of tapes per dumpcycle.
416 <para>While Amanda is always willing to use a new tape in its rotation, it refuses to reuse a tape until at
417 least '<amkeyword>tapecycle</amkeyword> -1' number of other tapes have been used.
420 It is considered good administrative practice to set the <amkeyword>tapecycle</amkeyword> parameter
421 slightly lower than the actual number of tapes in rotation. This allows the administrator to more easily cope
422 with damaged or misplaced tapes or schedule adjustments that call for slight adjustments in the rotation order.
428 <term><amkeyword>usetimestamps</amkeyword>
429 <amtype>bool</amtype></term>
431 <para>Default: <amkeyword>Yes</amkeyword>.
432 This option allows Amanda to track multiple runs per calendar
433 day. The only reason one might disable it is that Amanda versions before 2.5.1
434 can't read logfiles written when this option was enabled.
440 <term><amkeyword>label_new_tapes</amkeyword>
441 <amtype>string</amtype></term>
443 <para>Deprecated, use <amkeyword>autolabel</amkeyword> option.</para>
444 <para>Default: not set.
445 When set, this directive will cause Amanda to automatically write an Amanda
446 tape label to any blank tape she encounters. This option is DANGEROUS
447 because when set, Amanda will ERASE any non-Amanda tapes you may have, and may
448 also ERASE any near-failing tapes. Use with caution.</para>
449 <para>When using this directive, specify the template for new tape
450 labels. The template should contain some number of contiguous '%'
451 characters, which will be replaced with a generated number. Be sure to
452 specify enough '%' characters that you do not run out of tape labels.
454 <markup>label_new_tapes "DailySet1-%%%"</markup>
460 <term><amkeyword>autolabel</amkeyword>
461 <amtype>string</amtype>
462 [<amkeyword>any</amkeyword>]
463 [<amkeyword>other_config</amkeyword>]
464 [<amkeyword>non_amanda</amkeyword>]
465 [<amkeyword>volume_error</amkeyword>]
466 [<amkeyword>empty</amkeyword>]</term>
468 <para>Default: not set.
469 When set, this directive will cause Amanda to automatically write an Amanda
470 tape label to most volume she encounters. This option is DANGEROUS
471 because when set, Amanda may erase near-failing tapes or tapes accidentally
472 loaded in the wrong slot.</para>
473 <para>When using this directive, specify the template for new tape
474 labels. The template should contain some number of contiguous '%'
475 characters, which will be replaced with a generated number. Be sure to
476 specify enough '%' characters that you do not run out of tape labels.
478 <markup>autolabel "DailySet1-%%%" empty</markup>
480 <variablelist remap='TP'>
482 <term><amkeyword>any</amkeyword></term>
483 <listitem>equivalent to '<amkeyword>other_config non_amanda volume_error empty</amkeyword>'
487 <term><amkeyword>other_config</amkeyword></term>
488 <listitem>Label volumes with a valid Amanda label that do not match our
489 <amkeyword>labelstr</amkeyword>. Danger: this may erase volumes
490 from other Amanda configurations without warning!
494 <term><amkeyword>non_amanda</amkeyword></term>
495 <listitem>Label volumes which do not start with data that resembles an
496 Amanda header. Danger: this may erase volumes from other backup applications
501 <term><amkeyword>volume_error</amkeyword></term>
502 <listitem>Label volumes where an error occurs while trying to read the label.
503 Danger: this may erase arbitrary volumes due to transient errors.
507 <term><amkeyword>empty</amkeyword></term>
508 <listitem>Label volumes where a read returns 0 bytes.
516 <term><amkeyword>dumpuser</amkeyword> <amtype>string</amtype></term>
519 <amdefault>"amanda"</amdefault>.
520 The login name Amanda uses to run the backups.
521 The backup client hosts must allow access
522 from the tape server host as this user via
523 <markup>.rhosts</markup>
525 <markup>.amandahosts</markup>,
526 depending on how the Amanda software was built.</para>
530 <term><amkeyword>printer</amkeyword> <amtype>string</amtype></term>
532 <para>Printer to use when doing tape labels.
534 <amkeyword>lbl-templ</amkeyword>
535 <amkeyword>tapetype</amkeyword>
541 <term><amkeyword>tapedev</amkeyword> <amtype>string</amtype></term>
544 <amdefault>"null:"</amdefault>.
545 The device name, referencing the name of a "device" section in the configuration file. See
546 <manref name="amanda-devices" vol="7"/>
547 for more information on device names.</para>
549 <para>If a tape changer is configured
551 <amkeyword>tpchanger</amkeyword>
552 option), this option might not be used.</para>
554 <para>If <amkeyword>tapedev</amkeyword> is
555 <emphasis remap='B'>null:</emphasis>,
558 will run normally but all images will be thrown away.
559 This should only be used for debugging and testing,
560 and probably only with the
561 <amkeyword>record</amkeyword>
563 <amdefault>no</amdefault>.</para>
568 <term><amkeyword>device_property</amkeyword> <amtype>string</amtype> <amtype>string</amtype></term>
570 <para>These options can set various device properties. See
571 <manref name="amanda-devices" vol="7"/>
572 for more information on device properties and their syntax.
573 Both strings are always quoted; the first string contains the name of
574 the property to set, and the second contains its value. For example, to set
575 a fixed block size of 128k, write:</para>
577 device_property "BLOCK_SIZE" "128k"
584 <term><amkeyword>property</amkeyword> [<amkeyword>append</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
586 <para>These options can set various properties, they can be used by third
587 party software to store information in the configuration file.
588 Both strings are quoted; the first string contains the name of
589 the property to set, and the others contains its values.
590 <amkeyword>append</amkeyword> keyword append the values to the list of values for that property.
596 <term><amkeyword>tpchanger</amkeyword> <amtype>string</amtype></term>
598 <para>Default: not set.
599 The name of the tape changer.
600 If a tape changer is not configured, this option is not used
601 and should be commented out of the configuration file.</para>
602 <para>If a tape changer is configured, choose one of the changer scripts
603 (e.g. <emphasis remap='B'>chg-scsi</emphasis>)
604 and enter that here.</para>
609 <term><amkeyword>changerdev</amkeyword> <amtype>string</amtype></term>
612 <amdefault>"dev/null"</amdefault>.
613 A tape changer configuration parameter.
614 Usage depends on the particular changer defined with the
615 <amkeyword>tpchanger</amkeyword>
620 <term><amkeyword>changerfile</amkeyword> <amtype>string</amtype></term>
623 <amdefault>"usr/adm/amanda/log/changer-status"</amdefault>.
624 A tape changer configuration parameter.
625 Usage depends on the particular changer defined with the
626 <amkeyword>tpchanger</amkeyword>
631 <term><amkeyword>runtapes</amkeyword> <amtype>int</amtype></term>
634 <amdefault>1</amdefault>.
635 The maximum number of tapes used in a single run.
636 If a tape changer is not configured, this option is not used
637 and should be commented out of the configuration file.</para>
638 <para>If a tape changer is configured, this may be set larger than one to
639 let Amanda write to more than one tape.</para>
640 <para>Note that this is an upper bound on the number of tapes,
641 and Amanda may use less.</para>
642 <para>Also note that as of this release, Amanda does not support true tape overflow.
643 When it reaches the end of one tape,
644 the backup image Amanda was processing starts over again on the next tape.</para>
649 <term><amkeyword>maxdumpsize</amkeyword> <amtype>int</amtype></term>
652 <amdefault><amkeyword>runtapes</amkeyword>*<amkeyword>tape_length</amkeyword></amdefault>.
653 Maximum number of bytes the planner will schedule for a run.</para>
654 <para>The default unit is Kbytes if it is not specified.</para>
658 <term><amkeyword>taperalgo</amkeyword> [ <amkeyword>first</amkeyword> | <amkeyword>firstfit</amkeyword> | <amkeyword>largest</amkeyword> | <amkeyword>largestfit</amkeyword> | <amkeyword>smallest</amkeyword> | <amkeyword>last</amkeyword> ]</term>
661 <amkeyword>first</amkeyword>.
662 The algorithm used to choose which dump image to send to the taper.</para>
664 <variablelist remap='TP'>
666 <term><amkeyword>first</amkeyword></term>
668 <para>First in, first out.</para>
672 <term><amkeyword>firstfit</amkeyword></term>
674 <para>The first dump image that will fit on the current tape.</para>
678 <term><amkeyword>largest</amkeyword></term>
680 <para>The largest dump image.</para>
684 <term><amkeyword>largestfit</amkeyword></term>
686 <para>The largest dump image that will fit on the current tape.</para>
690 <term><amkeyword>smallest</amkeyword></term>
692 <para>The smallest dump image.</para>
696 <term><amkeyword>last</amkeyword></term>
698 <para>Last in, first out.</para>
706 <term><amkeyword>labelstr</amkeyword> <amtype>string</amtype></term>
709 <amdefault>".*"</amdefault>.
710 The tape label constraint regular expression.
711 All tape labels generated (see
712 <manref name="amlabel" vol="8"/>)
713 and used by this configuration must match the regular expression.
714 If multiple configurations are run from the same tape server host,
715 it is helpful to set their labels to different strings
716 (for example, "DAILY[0-9][0-9]*" vs.
717 "ARCHIVE[0-9][0-9]*")
718 to avoid overwriting each other's tapes.</para>
722 <term><amkeyword>tapetype</amkeyword> <amtype>string</amtype></term>
725 <amdefault>no default</amdefault>.
726 The type of tape drive associated with
727 <amkeyword>tapedev</amkeyword>
729 <amkeyword>tpchanger</amkeyword>.
730 This refers to one of the defined <amkeyword>tapetype</amkeyword>s
731 in the config file (see below), which specify various tape parameters,
733 <amkeyword>length</amkeyword>,
734 <amkeyword>filemark</amkeyword>
736 <amkeyword>speed</amkeyword>
737 of the tape media and device.</para>
741 <term><amkeyword>ctimeout</amkeyword> <amtype>int</amtype></term>
744 <amdefault>30 seconds</amdefault>.
745 Maximum amount of time that
746 <emphasis remap='B'>amcheck</emphasis>
747 will wait for each client host.</para>
751 <term><amkeyword>dtimeout</amkeyword> <amtype>int</amtype></term>
754 <amdefault>1800 seconds</amdefault>.
755 Amount of idle time per disk on a given client that a
756 <emphasis remap='B'>dumper</emphasis>
758 <command>amdump</command>
759 will wait before it fails with a data timeout error.</para>
764 <term><amkeyword>etimeout</amkeyword> <amtype>int</amtype></term>
767 <amdefault>300 seconds</amdefault>.
768 Amount of time per estimate on a given client that the
769 <emphasis remap='B'>planner</emphasis> step of
770 <command>amdump</command> will wait to get the dump size estimates
771 (note: Amanda runs up to 3 estimates for each DLE). For instance,
772 with the default of 300 seconds and four DLE's, each estimating level
773 0 and level 1 on client A, <emphasis remap='B'>planner</emphasis>
774 will wait up to 40 minutes for that machine. A negative value will
775 be interpreted as a total amount of time to wait
776 per client instead of per disk.</para>
781 <term><amkeyword>connect_tries</amkeyword> <amtype>int</amtype></term>
784 <amdefault>3</amdefault>.
785 How many times the server will try a connection.</para>
790 <term><amkeyword>req_tries</amkeyword> <amtype>int</amtype></term>
793 <amdefault>3</amdefault>.
794 How many times the server will resend a REQ packet if it doesn't get the ACK packet.</para>
799 <term><amkeyword>netusage</amkeyword> <amtype>int</amtype></term>
802 <amdefault>8000 Kbps</amdefault>.
803 The maximum network bandwidth allocated to Amanda, in Kbytes per second.
805 <emphasis remap='B'>interface</emphasis>
810 <term><amkeyword>inparallel</amkeyword> <amtype>int</amtype></term>
813 <amdefault>10</amdefault>.
814 The maximum number of backups that Amanda will attempt to run in parallel.
815 Amanda will stay within the constraints of network bandwidth and
816 holding disk space available, so it doesn't hurt to set
817 this number a bit high. Some contention can occur with larger numbers
818 of backups, but this effect is relatively small on most systems.</para>
823 <term><amkeyword>displayunit</amkeyword> "k|m|g|t"</term>
826 <amdefault>"k"</amdefault>.
827 The unit used to print many numbers, k=kilo, m=mega, g=giga, t=tera.
833 <term><amkeyword>dumporder</amkeyword> <amtype>string</amtype></term>
836 <amdefault>"tttTTTTTTT"</amdefault>.
837 The priority order of each dumper:
844 b: smallest bandwidth
846 </programlisting></para>
852 <term><amkeyword>maxdumps</amkeyword> <amtype>int</amtype></term>
855 <amdefault>1</amdefault>.
856 The maximum number of backups from a single host that Amanda will
857 attempt to run in parallel. See also the
858 <emphasis remap='B'>inparallel</emphasis>
861 <para>Note that this parameter may also be set in a specific
862 <amkeyword>dumptype</amkeyword>
864 This value sets the default for all
865 <amkeyword>dumptype</amkeyword>s
867 <emphasis remap='B'>amanda.conf</emphasis>
869 <amkeyword>dumptype</amkeyword>s
875 <term><amkeyword>bumpsize</amkeyword> <amtype>int</amtype></term>
878 <amdefault>10 Mbytes</amdefault>.
879 The minimum savings required to trigger an automatic
880 bump from one incremental level to the next, expressed as size.
881 If Amanda determines that the next higher backup level
882 will be this much smaller than the current level,
883 it will do the next level.
884 The value of this parameter is used only if the parameter
885 <emphasis>bumppercent</emphasis> is set to 0.
887 <para>The default unit is Kbytes if it is not specified.</para>
889 The global setting of this parameter can be overwritten inside of a
894 <amkeyword>bumppercent</amkeyword>,
895 <amkeyword>bumpmult</amkeyword> and
896 <amkeyword>bumpdays</amkeyword>.</para>
901 <term><amkeyword>bumppercent</amkeyword> <amtype>int</amtype></term>
904 <amdefault>0</amdefault>.
905 The minimum savings required to trigger an automatic
906 bump from one incremental level to the next, expressed as percentage of the
907 current size of the DLE (size of current level 0).
908 If Amanda determines that the next higher backup level
909 will be this much smaller than the current level,
910 it will do the next level.
913 If this parameter is set to 0, the value of the
914 parameter <emphasis>bumpsize</emphasis> is used to trigger bumping.
917 The global setting of this parameter can be overwritten inside of a
922 <amkeyword>bumpsize</amkeyword>,
923 <amkeyword>bumpmult</amkeyword> and
924 <amkeyword>bumpdays</amkeyword>.</para>
929 <term><amkeyword>bumpmult</amkeyword> <amtype>float</amtype></term>
932 <amdefault>1.5</amdefault>.
933 The bump size multiplier.
935 <amkeyword>bumpsize</amkeyword>
936 by this factor for each level.
937 This prevents active filesystems from
938 bumping too much by making it harder to bump to the next level.
939 For example, with the default
940 <amkeyword>bumpsize</amkeyword>
942 <amkeyword>bumpmult</amkeyword>
943 set to 2.0, the bump threshold will be 10 Mbytes for level one, 20
944 Mbytes for level two, 40 Mbytes for level three, and so on.</para>
946 The global setting of this parameter can be overwritten inside of a
952 <term><amkeyword>bumpdays</amkeyword> <amtype>int</amtype></term>
955 <amdefault>2 days</amdefault>.
956 To insure redundancy in the dumps, Amanda keeps filesystems at the
957 same incremental level for at least
958 <amkeyword>bumpdays</amkeyword>
959 days, even if the other bump threshold criteria are met.</para>
961 The global setting of this parameter can be overwritten inside of a
968 <term><amkeyword>diskfile</amkeyword> <amtype>string</amtype></term>
971 <amdefault>"disklist"</amdefault>.
972 The file name for the
973 <emphasis remap='I'>disklist</emphasis>
974 file holding client hosts, disks and other client dumping information.</para>
978 <term><amkeyword>infofile</amkeyword> <amtype>string</amtype></term>
981 <amdefault>"/usr/adm/amanda/curinfo"</amdefault>.
982 The file or directory name for the historical information database.
983 If Amanda was configured to use DBM databases, this is the base file
985 If it was configured to use text formated databases (the default),
986 this is the base directory and within here will be a directory per
987 client, then a directory per disk, then a text file of data.</para>
991 <term><amkeyword>logdir</amkeyword> <amtype>string</amtype></term>
994 <amdefault>"/usr/adm/amanda"</amdefault>.
995 The directory for the
996 <command>amdump</command>
998 <emphasis remap='B'>log</emphasis>
1003 <term><amkeyword>indexdir</amkeyword> <amtype>string</amtype></term>
1006 <amdefault>"/usr/adm/amanda/index"</amdefault>.
1007 The directory where index files (backup image catalogues) are stored.
1009 only generated for filesystems whose
1010 <amkeyword>dumptype</amkeyword>
1012 <amkeyword>index</amkeyword>
1013 option enabled.</para>
1017 <term><amkeyword>tapelist</amkeyword> <amtype>string</amtype></term>
1020 <amdefault>"tapelist"</amdefault>.
1021 The file name for the active &tapelist;.
1022 Amanda maintains this file with information about the active set of tapes.</para>
1026 <term><amkeyword>device_output_buffer_size</amkeyword> <amtype>int</amtype></term>
1029 <amdefault>1280k</amdefault>.
1030 Controls the amount of memory used by Amanda
1031 to hold data as it is read from the network or disk before it is written to
1032 the output device. Higher values may be
1033 useful on fast tape drives and optical media.</para>
1034 <para>The default unit is bytes if it is not specified.</para>
1038 <term><amkeyword>tapebufs</amkeyword> <amtype>int</amtype></term>
1041 <amdefault>20</amdefault>.
1042 This option is deprecated; use
1043 the <amkeyword>device_output_buffer_size</amkeyword> directive
1044 instead. <amkeyword>tapebufs</amkeyword> works the same way,
1045 but the number specified is multiplied by the device blocksize prior
1050 <term><amkeyword>reserve</amkeyword> <amtype>int</amtype></term>
1053 <amdefault>100</amdefault>.
1054 The part of holding-disk space that should be reserved for incremental
1055 backups if no tape is available, expressed as a percentage of the
1056 available holding-disk space (0-100).
1057 By default, when there is no tape to write to, degraded mode (incremental) backups
1058 will be performed to the holding disk. If full backups should also be allowed in this case,
1059 the amount of holding disk space reserved for incrementals should be lowered.</para>
1063 <term><amkeyword>autoflush</amkeyword> <amtype>bool</amtype></term>
1066 <amkeyword>off</amkeyword>.
1067 Whether an amdump run will flush the dumps from holding disk to tape.</para>
1071 <term><amkeyword>amrecover_do_fsf</amkeyword> <amtype>bool</amtype></term>
1074 <amkeyword>on</amkeyword>.
1075 Amrecover will call amrestore with the -f flag for faster positioning of the tape.</para>
1079 <term><amkeyword>amrecover_check_label</amkeyword> <amtype>bool</amtype></term>
1082 <amkeyword>on</amkeyword>.
1083 Amrecover will call amrestore with the -l flag to check the label.</para>
1087 <term><amkeyword>amrecover_changer</amkeyword> <amtype>string</amtype></term>
1089 <para>Default: not set.
1090 Amrecover will use the changer if you use 'settape <string>' and that string
1091 is the same as the amrecover_changer setting.</para>
1095 <term><amkeyword>columnspec</amkeyword> <amtype>string</amtype></term>
1097 <para> default: "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"</para>
1098 <para>Defines the width of columns <emphasis remap='B'>amreport</emphasis>
1100 <emphasis remap='I'>String</emphasis>
1101 is a comma (',') separated list of triples. Each triple consists
1102 of three parts which are separated by a equal sign ('=') and a colon (':') (see the example).
1103 These four parts specify:
1107 <para>the name of the column, which may be:
1110 Compress (compression ratio)
1111 Disk (client disk name)
1112 DumpRate (dump rate in KBytes/sec)
1113 DumpTime (total dump time in hours:minutes)
1114 HostName (client host name)
1116 OrigKB (original image size in KBytes)
1117 OutKB (output image size in KBytes)
1118 TapeRate (tape writing rate in KBytes/sec)
1119 TapeTime (total tape time in hours:minutes)
1120 </programlisting></para>
1125 <para>the amount of space to display before the column (used to get whitespace between columns).</para>
1128 <para>the width of the column itself.
1129 If set to a negative value, the width will be calculated on demand to fit the largest entry in
1133 <para>the precision of the column, number of digit after the decimal point for number.</para>
1135 </orderedlist></para>
1137 <para>Here is an example:
1139 columnspec "Disk=1:18,HostName=0:10,OrigKB=::2,OutKB=1:7"
1140 </programlisting></para>
1142 The above will display the disk information in 18 characters
1143 and put one space before it. The hostname column will be 10 characters wide with
1144 no space to the left. The Original KBytes print 2 decimal digit. The output KBytes column is seven characters wide
1145 with one space before it.</para>
1150 <term><amkeyword>includefile</amkeyword> <amtype>string</amtype></term>
1153 <amdefault>no default</amdefault>.
1154 The name of an Amanda configuration file to include within the current file.
1155 Useful for sharing dumptypes, tapetypes and interface definitions among several configurations.
1156 Relative pathnames are relative to the configuration directory.
1162 <term><amkeyword>debug_days</amkeyword> <amtype>int</amtype></term>
1165 <amdefault>3</amdefault>.
1166 The number of days the debug files are kept.</para>
1171 <term><amkeyword>debug_auth</amkeyword> <amtype>int</amtype></term>
1174 <amdefault>0</amdefault>.
1175 Debug level of the auth module</para>
1180 <term><amkeyword>debug_event</amkeyword> <amtype>int</amtype></term>
1183 <amdefault>0</amdefault>.
1184 Debug level of the event module</para>
1189 <term><amkeyword>debug_holding</amkeyword> <amtype>int</amtype></term>
1192 <amdefault>0</amdefault>.
1193 Debug level of the holdingdisk module</para>
1198 <term><amkeyword>debug_protocol</amkeyword> <amtype>int</amtype></term>
1201 <amdefault>0</amdefault>.
1202 Debug level of the protocol module</para>
1207 <term><amkeyword>debug_planner</amkeyword> <amtype>int</amtype></term>
1210 <amdefault>0</amdefault>.
1211 Debug level of the planner process</para>
1216 <term><amkeyword>debug_driver</amkeyword> <amtype>int</amtype></term>
1219 <amdefault>0</amdefault>.
1220 Debug level of the driver process</para>
1225 <term><amkeyword>debug_dumper</amkeyword> <amtype>int</amtype></term>
1228 <amdefault>0</amdefault>.
1229 Debug level of the dumper process</para>
1234 <term><amkeyword>debug_chunker</amkeyword> <amtype>int</amtype></term>
1237 <amdefault>0</amdefault>.
1238 Debug level of the chunker process</para>
1243 <term><amkeyword>debug_taper</amkeyword> <amtype>int</amtype></term>
1246 <amdefault>0</amdefault>.
1247 Debug level of the taper process</para>
1252 <term><amkeyword>flush-threshold-dumped</amkeyword> <amtype>int</amtype></term>
1254 <para>Default: <amdefault>0</amdefault>.
1255 Amanda will not begin writing data to a new volume until the amount of
1256 data on the holding disk is at least this percentage of the volume
1257 size. In other words, Amanda will not begin until the
1258 amount of data on the holding disk is greater than the tape
1259 length times this parameter.
1260 This parameter may be larger than 100%, for example to keep
1261 more recent dumps on the holding disk for faster recovery.</para>
1262 <para> Needless to say, your holding disk must be big enough
1263 that this criterion could be satisfied. If the holding disk cannot
1264 be used for a particular dump (because, for example, there is no
1265 remaining holding space) then Amanda will disregard the constraint
1266 specified by this setting and start a new volume anyway. Once
1267 writing to a volume has begun, this constraint is not applied unless
1268 and until a new volume is needed.</para>
1269 <para> The value of this parameter may not exceed than that of
1270 the <amkeyword>flush-threshold-scheduled</amkeyword>
1276 <term><amkeyword>flush-threshold-scheduled</amkeyword> <amtype>int</amtype></term>
1278 <para>Default: <amdefault>0</amdefault>.
1279 Amanda will not begin writing data to a new volume until the sum of the
1280 amount of data on the holding disk and the estimated amount of data
1281 remaining to be dumped during this run is at least this percentage
1282 of the volume size. In other words, Amanda will not begin until the
1283 inequality <inlineequation><mathphrase>h + s > t ×
1284 d</mathphrase></inlineequation> is satisfied,
1285 where <mathphrase>h</mathphrase> is the amount of data on the
1286 holding disk, <mathphrase>s</mathphrase> is the total amount of
1287 data scheduled for this run but not dumped
1288 yet, <mathphrase>t</mathphrase> is the capacity of a volume,
1289 and <mathphrase>d</mathphrase> is this parameter, expressed as a
1290 percentage. This parameter may be larger than 100%.</para>
1291 <para> Needless to say, your holding disk must be big enough
1292 that this criterion could be satisfied. If the holding disk cannot
1293 be used for a particular dump (because, for example, there is no
1294 remaining holding space) then Amanda will disregard the constraint
1295 specified by this setting and start a new volume anyway. Once
1296 writing to a volume has begun, this constraint is not applied unless
1297 and until a new volume is needed.</para>
1298 <para> The value of this parameter may not be less than that of
1299 the <amkeyword>flush-threshold-dumped</amkeyword>
1300 or <amkeyword>taperflush</amkeyword> parameters.</para>
1304 <!-- the entity '#215' below is U+00D7 MULTIPLICATION SIGN; the 'times' entity
1305 is not as portable as one might hope. -->
1307 <term><amkeyword>taperflush</amkeyword> <amtype>int</amtype></term>
1309 <para>Default: <amdefault>0</amdefault>.
1310 At the end of a run, Amanda will start a new tape to flush remaining
1311 data if there is more data on the holding disk at the end of a run
1312 than this setting allows; the amount is specified as a percentage of
1313 the capacity of a single
1314 volume. In other words, at the end of a run, Amanda will begin
1316 inequality <inlineequation><mathphrase>h > t ×
1317 f</mathphrase></inlineequation> is satisfied,
1318 where <mathphrase>h</mathphrase> is the amount of data remaining on the
1319 holding disk from this or previous runs, <mathphrase>t</mathphrase>
1320 is the capacity of a volume,
1321 and <mathphrase>f</mathphrase> is this parameter, expressed as a
1322 percentage. This parameter may be greater than 100%.</para>
1323 <para> The value of this parameter may not exceed that of
1324 the <amkeyword>flush-threshold-scheduled</amkeyword>
1325 parameter.; <amkeyword>autoflush</amkeyword> must be set to 'yes' if
1326 <amkeyword>taperflush</amkeyword> is greater than 0.</para>
1331 <term><amkeyword>reserved-udp-port</amkeyword> <amtype>int</amtype>,<amtype>int</amtype></term>
1333 <para>Default: --with-udpportrange or
1334 <amdefault>512,1023</amdefault>.
1335 Reserved udp port that will be used (bsd, bsdudp).
1336 Range is inclusive.</para>
1341 <term><amkeyword>reserved-tcp-port</amkeyword> <amtype>int</amtype>,<amtype>int</amtype></term>
1343 <para>Default: --with-low-tcpportrange or
1344 <amdefault>512,1023</amdefault>.
1345 Reserved tcp port that will be used (bsdtcp).
1346 Range is inclusive.</para>
1351 <term><amkeyword>unreserved-tcp-port</amkeyword> <amtype>int</amtype>,<amtype>int</amtype></term>
1353 <para>Default: --with-tcpportrange or
1354 <amdefault>1024,65535</amdefault>.
1355 Unreserved tcp port that will be used (bsd, bsdudp).
1356 Range is inclusive.</para>
1363 <refsect1><title>HOLDINGDISK SECTION</title>
1364 <para>The <emphasis remap='B'>amanda.conf</emphasis>
1365 file may define one or more holding disks used as buffers to hold
1366 backup images before they are written to tape.
1367 The syntax is:</para>
1370 define holdingdisk <emphasis remap='I'>name</emphasis> {
1371 <emphasis remap='I'>holdingdisk-option</emphasis> <emphasis remap='I'>holdingdisk-value</emphasis>
1372 <literal>...</literal>
1376 <para>The { must appear at the end of a line, and the } on its own line.</para>
1377 <para><emphasis remap='I'>Name</emphasis>
1378 is a logical name for this holding disk.</para>
1380 <para>The options and values are:</para>
1382 <variablelist remap='TP'>
1384 <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
1386 <para>Default: not set.
1387 A comment string describing this holding disk.</para>
1392 <term><amkeyword>directory</amkeyword> <amtype>string</amtype></term>
1395 <amdefault>"/dumps/amanda"</amdefault>.
1396 The path to this holding area.</para>
1401 <term><amkeyword>use</amkeyword> <amtype>int</amtype></term>
1404 <amdefault>0 Gb</amdefault>.
1405 Amount of space that can be used in this holding disk area.
1406 If the value is zero, all available space on the file system is used.
1407 If the value is negative, Amanda will use all available space minus that value.</para>
1412 <term><amkeyword>chunksize</amkeyword> <amtype>int</amtype></term>
1415 <amdefault>1 Gb</amdefault>.
1416 Holding disk chunk size. Dumps larger than the specified size will be stored in multiple
1417 holding disk files. The size of each chunk will not exceed the specified value.
1418 However, even though dump images are split in the holding disk, they are concatenated as
1419 they are written to tape, so each dump image still corresponds to a single continuous
1420 tape section.</para>
1421 <para>The default unit is Kbytes if it is not specified.</para>
1423 <para>If 0 is specified, Amanda will create holding disk chunks as large as
1424 ((INT_MAX/1024)-64) Kbytes.</para>
1426 <para>Each holding disk chunk includes a 32 Kbyte header, so the minimum
1427 chunk size is 64 Kbytes (but that would be really silly).</para>
1429 <para>Operating systems that are limited to a maximum file size of 2 Gbytes
1430 actually cannot handle files that large.
1431 They must be at least one byte less than 2 Gbytes.
1432 Since Amanda works with 32 Kbyte blocks, and
1433 to handle the final read at the end of the chunk, the chunk size
1434 should be at least 64 Kbytes (2 * 32 Kbytes) smaller than the maximum
1435 file size, e.g. 2047 Mbytes.</para>
1441 <refsect1><title>DUMPTYPE SECTION</title>
1442 <para>The &amconf; file may define multiple sets of backup options
1443 and refer to them by name from the &disklist; file.
1444 For instance, one set of options might be defined for file systems
1445 that can benefit from high compression, another set that does not compress well,
1446 another set for file systems that should always get a full backup and so on.</para>
1448 <para>A set of backup options are entered in a
1449 <amkeyword>dumptype</amkeyword>
1450 section, which looks like this:</para>
1453 define dumptype "<emphasis remap='I'>name</emphasis>" {
1454 <emphasis remap='I'>dumptype-option</emphasis> <emphasis remap='I'>dumptype-value</emphasis>
1455 <literal>...</literal>
1459 <para>The { must appear at the end of a line, and the } on its own line.</para>
1460 <para><emphasis remap='I'>Name</emphasis>
1461 is the name of this set of backup options.
1462 It is referenced from the &disklist; file.</para>
1464 <para>Some of the options in a
1465 <amkeyword>dumptype</amkeyword>
1466 section are the same as those in the main part of &amconf;.
1467 The main option value is used to set the default for all
1468 <amkeyword>dumptype</amkeyword>
1469 sections. For instance, setting
1470 <amkeyword>dumpcycle</amkeyword>
1471 to 50 in the main part of the config file causes all following
1472 <amkeyword>dumptype</amkeyword>
1473 sections to start with that value,
1474 but the value may be changed on a section by section basis.
1475 Changes to variables in the main part of the config file must be
1476 done before (earlier in the file) any
1477 <amkeyword>dumptype</amkeyword>s
1480 <para>The dumptype options and values are:</para>
1482 <variablelist remap='TP'>
1484 <term><amkeyword>auth</amkeyword> <amtype>string</amtype></term>
1487 <amdefault>"bsd"</amdefault>.
1488 Type of authorization to perform between tape server and backup client hosts. See <manref name="amanda-auth" vol="7"/> for more detail.</para>
1493 <term><amkeyword>amandad_path</amkeyword> <amtype>string</amtype></term>
1496 <amdefault>"$libexec/amandad"</amdefault>.
1497 Specify the amandad path of the client, only use with rsh/ssh authentification.
1503 <term><amkeyword>client_username</amkeyword> <amtype>string</amtype></term>
1506 <amdefault>CLIENT_LOGIN</amdefault>.
1507 Specify the username to connect on the client, only use with rsh/ssh authentification.
1513 <term><amkeyword>client_port</amkeyword> [ <amtype>int</amtype> | <amtype>string</amtype> ]</term>
1516 <amdefault>"amanda"</amdefault>.
1517 Specifies the port to connect to on the client. It can be a service name or a numeric port number.
1522 <!-- bumping parameters yanked from the global section above -->
1525 <term><amkeyword>bumpsize</amkeyword> <amtype>int</amtype></term>
1528 <amdefault>10 Mbytes</amdefault>.
1529 The minimum savings required to trigger an automatic
1530 bump from one incremental level to the next, expressed as size.
1531 If Amanda determines that the next higher backup level
1532 will be this much smaller than the current level,
1533 it will do the next level.
1534 The value of this parameter is used only if the parameter
1535 <emphasis>bumppercent</emphasis> is set to 0.
1537 <para>The default unit is Kbytes if it is not specified.</para>
1539 See also the options
1540 <amkeyword>bumppercent</amkeyword>,
1541 <amkeyword>bumpmult</amkeyword> and
1542 <amkeyword>bumpdays</amkeyword>.</para>
1547 <term><amkeyword>bumppercent</amkeyword> <amtype>int</amtype></term>
1550 <amdefault>0</amdefault>.
1551 The minimum savings required to trigger an automatic
1552 bump from one incremental level to the next, expressed as percentage of the
1553 current size of the DLE (size of current level 0).
1554 If Amanda determines that the next higher backup level
1555 will be this much smaller than the current level,
1556 it will do the next level.
1559 If this parameter is set to 0, the value of the
1560 parameter <emphasis>bumpsize</emphasis> is used to trigger bumping.
1563 See also the options
1564 <amkeyword>bumpsize</amkeyword>,
1565 <amkeyword>bumpmult</amkeyword> and
1566 <amkeyword>bumpdays</amkeyword>.</para>
1571 <term><amkeyword>bumpmult</amkeyword> <amtype>float</amtype></term>
1574 <amdefault>1.5</amdefault>.
1575 The bump size multiplier.
1577 <amkeyword>bumpsize</amkeyword>
1578 by this factor for each level.
1579 This prevents active filesystems from
1580 bumping too much by making it harder to bump to the next level.
1581 For example, with the default
1582 <amkeyword>bumpsize</amkeyword>
1584 <amkeyword>bumpmult</amkeyword>
1585 set to 2.0, the bump threshold will be 10 Mbytes for level one, 20
1586 Mbytes for level two, 40 Mbytes for level three, and so on.</para>
1590 <term><amkeyword>bumpdays</amkeyword> <amtype>int</amtype></term>
1593 <amdefault>2 days</amdefault>.
1594 To insure redundancy in the dumps, Amanda keeps filesystems at the
1595 same incremental level for at least
1596 <amkeyword>bumpdays</amkeyword>
1597 days, even if the other bump threshold criteria are met.</para>
1602 <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
1604 <para>Default: not set.
1605 A comment string describing this set of backup options.</para>
1609 <term><amkeyword>comprate</amkeyword> <amtype>float</amtype> [, <amtype>float</amtype> ]</term>
1612 <amdefault>0.50, 0.50</amdefault>.
1613 The expected full and incremental compression factor for dumps.
1614 It is only used if Amanda does not have any history information on
1615 compression rates for a filesystem, so should not usually need to be set.
1616 However, it may be useful for the first time a very large filesystem that
1617 compresses very little is backed up.</para>
1621 <term><amkeyword>compress</amkeyword> [ <amkeyword>none</amkeyword> | <amkeyword>client</amkeyword> | <amkeyword>server</amkeyword> ] [ <amkeyword>best</amkeyword> | <amkeyword>fast</amkeyword> | <amkeyword>custom</amkeyword> ]</term>
1624 <amkeyword>client fast</amkeyword>.
1625 If Amanda does compression of the backup images, it can do so either on the backup client
1626 host before it crosses the network or on the tape server host as it goes from the
1627 network into the holding disk or to tape. Which place to do compression (if at all) depends on how well the
1628 dump image usually compresses, the speed and load on the client or server, network capacity,
1629 holding disk capacity, availability of tape hardware compression, etc.</para>
1631 <para>For either type of compression, Amanda also allows the selection
1632 of three styles of compression.
1633 <amkeyword>best</amkeyword>
1634 is the best compression available, often at the expense of CPU overhead.
1635 <amkeyword>fast</amkeyword>
1636 is often not as good a compression as
1637 <amkeyword>best</amkeyword>,
1638 but usually less CPU overhead. Or to specify <amkeyword>custom</amkeyword>
1639 to use your own compression method. (See dumptype custom-compress in example/amanda.conf for reference)</para>
1641 <para>So the <amkeyword>compress</amkeyword> options line may be one of:</para>
1643 <variablelist remap='TP'>
1645 <term>compress none</term><listitem><para/></listitem>
1648 <term>compress client fast</term><listitem><para/></listitem>
1651 <term>compress client best</term><listitem><para/></listitem>
1654 <term>compress client custom</term>
1656 <para>Specify <emphasis>client_custom_compress</emphasis> "PROG"</para>
1657 <para>PROG must not contain white space and it must accept -d for uncompress.</para>
1661 <term>compress server fast</term><listitem><para/></listitem>
1664 <term>compress server best</term><listitem><para/></listitem>
1667 <term>compress server custom</term>
1669 <para>Specify <amkeyword>server_custom_compress</amkeyword> "PROG"</para>
1670 <para>PROG must not contain white space and it must accept -d for uncompress.</para>
1674 <para>Note that some tape devices do compression and this option has nothing
1675 to do with whether that is used. If hardware compression is used (usually via a particular tape device name
1676 or <emphasis remap='B'>mt</emphasis> option), Amanda (software) compression should be disabled.</para>
1681 <term><amkeyword>client_custom_compress</amkeyword> <amtype>string</amtype></term>
1683 <para>Default: none.
1684 The program to use to perform compression/decompression on the client; used with
1685 "compress client custom". Must not contain whitespace. Must accept -d to uncompress.</para>
1690 <term><amkeyword>server_custom_compress</amkeyword> <amtype>string</amtype></term>
1692 <para>Default: none.
1693 The program to use to perform compression/decompression on the server; used with
1694 "compress server custom". Must not contain whitespace. Must accept -d to uncompress.</para>
1699 <term><amkeyword>dumpcycle</amkeyword> <amtype>int</amtype></term>
1701 <para>Default: <amdefault>10 days</amdefault>.
1702 The number of days in the backup cycle. Each disk using this set of options will get a full
1703 backup at least this of
1704 ten. Setting this to zero tries to do a full backup each run.</para>
1709 <term><amkeyword>encrypt</amkeyword> [ <amkeyword>none</amkeyword> | <amkeyword>client</amkeyword> | <amkeyword>server</amkeyword> ]</term>
1711 <para>Default: not set.
1712 To encrypt backup images, it can do so either on the backup client host before it crosses the network or on the tape
1713 server host as it goes from the network into the holding disk or to tape.</para>
1715 <para>So the <amkeyword>encrypt</amkeyword> options line may be one
1718 <variablelist remap='TP'>
1720 <term>encrypt none</term><listitem><para/></listitem>
1723 <term>encrypt client</term>
1725 <para>Specify client_encrypt "PROG"</para>
1726 <para>PROG must not contain white space.</para>
1727 <para>Specify client_decrypt_option "decryption-parameter" Default: "-d"</para>
1728 <para>decryption-parameter must not contain white space.</para>
1729 <para>(See dumptype client-encrypt-nocomp in example/amanda.conf for reference)</para>
1733 <term>encrypt server</term>
1735 <para>Specify server_encrypt "PROG"</para>
1736 <para>PROG must not contain white space.</para>
1737 <para>Specify server_decrypt_option "decryption-parameter" Default: "-d"</para>
1738 <para>decryption-parameter must not contain white space.</para>
1739 <para>(See dumptype server-encrypt-fast in example/amanda.conf for reference)</para>
1743 <para>Note that current logic assumes compression then encryption during
1744 backup(thus decrypt then uncompress during restore). So specifying
1745 client-encryption AND server-compression is not supported.
1746 <emphasis remap='I'>amcrypt</emphasis> which is a wrapper of
1747 <emphasis remap='I'>aespipe</emphasis> is provided as a reference
1748 symmetric encryption program.</para>
1753 <term><amkeyword>client_encrypt</amkeyword> <amtype>string</amtype></term>
1755 <para>Default: none.
1756 The program to use to perform encryption/decryption on the client; used with
1757 "encrypt client". Must not contain whitespace.</para>
1762 <term><amkeyword>client_decrypt_option</amkeyword> <amtype>string</amtype></term>
1765 The option that can be passed to client_encrypt to make it decrypt instead.
1766 Must not contain whitespace.</para>
1771 <term><amkeyword>server_encrypt</amkeyword> <amtype>string</amtype></term>
1773 <para>Default: none.
1774 The program to use to perform encryption/decryption on the server; used with
1775 "encrypt server". Must not contain whitespace.</para>
1780 <term><amkeyword>server_decrypt_option</amkeyword> <amtype>string</amtype></term>
1783 The option that can be passed to server_encrypt to make it decrypt instead.
1784 Must not contain whitespace.</para>
1789 <term><amkeyword>estimate</amkeyword> [ <amkeyword>client</amkeyword> | <amkeyword>calcsize</amkeyword> | <amkeyword>server</amkeyword> ]+</term>
1791 <para>Default: <amkeyword>client</amkeyword>.
1792 Determine the way Amanda estimates the size of each DLE before beginning a backup. This is a list of acceptable estimate methods, and Amanda applies the first method supported by the application. The methods are:</para>
1793 <variablelist remap='TP'>
1797 <para>Use the same program as the dumping program. This is the most
1798 accurate method to do estimates, but it can take a long time.</para>
1802 <term>calcsize</term>
1804 <para>Use a faster program to do estimates, but the result is less
1811 <para>Use only statistics from the previous few runs to give an estimate.
1812 This very quick, but the result is not accurate if your disk
1813 usage changes from day to day. If this method is specified, but the
1814 server does not have enough data to make an estimate, then the option
1815 is internally moved to the end of the list, thereby preferring 'client'
1816 or 'calcsize' in this case.</para>
1825 <term><amkeyword>exclude</amkeyword> [ <amkeyword>list</amkeyword> | <amkeyword>file</amkeyword> ][[<amkeyword>optional</amkeyword>][<amkeyword>append</amkeyword>][ <amtype>string</amtype> ]+]</term>
1828 <amkeyword>file</amkeyword>. Exclude is the opposite of
1829 <amkeyword>include</amkeyword> and specifies files that will be excluded from
1830 the backup. The format of the exclude expressions depends on the application,
1831 and some applications do not support excluding files at all.</para>
1833 <para>There are two exclude parameters,
1834 <amkeyword>exclude</amkeyword> <amkeyword>file</amkeyword>
1836 <amkeyword>exclude</amkeyword> <amkeyword>list.</amkeyword>
1838 <amkeyword>exclude</amkeyword> <amkeyword>file</amkeyword>, the
1839 <amtype>string</amtype>
1840 is an exclude expression. With
1841 <amkeyword>exclude</amkeyword> <amkeyword>list</amkeyword>
1843 <amtype>string</amtype>
1844 is a file name on the client containing &gnutar; exclude expressions.
1845 The path to the specified exclude list file, if present (see description of
1846 'optional' below), must be readable by the Amanda user.</para>
1848 <para>All exclude expressions are concatenated in one file and passed to the
1849 application as an <option>--exclude-from</option> argument.</para>
1851 <para>For &gnutar;, exclude expressions must always be specified as relative to the
1852 top-level directory of the DLE, and must start with "./". See the manpages for individual
1853 applications for more information on supported exclude expressions.</para>
1856 <amkeyword>append</amkeyword> keyword, the
1857 <amtype>string</amtype> is appended to the current list, without it, the
1858 <amtype>string</amtype> overwrites the list.</para>
1860 <para>If <amkeyword>optional</amkeyword>
1861 is specified for <amkeyword>exclude</amkeyword> <amkeyword>list</amkeyword>,
1862 then amcheck will not complain if the file doesn't exist or is not readable.</para>
1864 <para>For <amkeyword>exclude</amkeyword> <amkeyword>list</amkeyword>,
1865 if the file name is relative, the disk name being backed up is prepended.
1866 So if this is entered:</para>
1869 exclude list ".amanda.excludes"
1872 <para>the actual file used would be
1873 <filename>/var/.amanda.excludes</filename>
1874 for a backup of <filename>/var</filename>,
1875 <filename>/usr/local/.amanda.excludes</filename> for a backup of
1876 <filename>/usr/local</filename>, and so on.</para>
1881 <term><amkeyword>holdingdisk</amkeyword> [ <amkeyword>never</amkeyword> | <amkeyword>auto</amkeyword> | <amkeyword>required</amkeyword> ]</term>
1884 <amkeyword>auto</amkeyword>.
1885 Whether a holding disk should be used for these backups or whether they should go directly to tape.
1886 If the holding disk is a portion of another file system that Amanda
1887 is backing up, that file system should refer to a dumptype with
1888 <amkeyword>holdingdisk</amkeyword>
1890 <emphasis remap='I'>never</emphasis>
1891 to avoid backing up the holding disk into itself.</para>
1893 <variablelist remap='TP'>
1895 <term><amkeyword>never</amkeyword>|no|false|off</term>
1897 <para>Never use a holdingdisk, the dump will always go directly to tape. There will be no dump if you have a tape error.</para>
1901 <term><amkeyword>auto</amkeyword>|yes|true|on</term>
1903 <para>Use the holding disk, unless there is a problem with the holding disk, the dump won't fit there or the medium doesn't require spooling (e.g., VFS device)</para>
1907 <term><amkeyword>required</amkeyword></term>
1909 <para>Always dump to holdingdisk, never directly to tape. There will be no dump if it doesn't fit on holdingdisk</para>
1918 <term><amkeyword>ignore</amkeyword> <amtype>boolean</amtype></term>
1921 <amkeyword>no</amkeyword>.
1922 Whether disks associated with this backup type should be backed up or not.
1923 This option is useful when the
1924 <emphasis remap='I'>disklist</emphasis>
1925 file is shared among several configurations,
1926 some of which should not back up all the listed file systems.</para>
1930 <term><amkeyword>include</amkeyword> [ <amkeyword>list</amkeyword> | <amkeyword>file</amkeyword> ][[<amkeyword>optional</amkeyword>][<amkeyword>append</amkeyword>][ <amtype>string</amtype> ]+]</term>
1933 <amkeyword>file</amkeyword>
1935 There are two include lists,
1936 <amkeyword>include file</amkeyword>
1938 <amkeyword>include list.</amkeyword>
1940 <amkeyword>include file</amkeyword>
1942 <amtype>string</amtype>
1943 is a glob expression. With
1944 <amkeyword>include list</amkeyword>
1946 <amtype>string</amtype>
1947 is a file name on the client containing glob expressions.</para>
1949 <para>All include expressions are expanded by Amanda, concatenated in one file and passed to &gnutar; as a
1950 <option>--files-from</option> argument. They must start with "./" and contain no other "/".</para>
1952 <para>Include expressions must always be specified as relative to the
1953 head directory of the DLE.</para>
1955 <note><para>For globbing to work at all, even the limited single level,
1956 the top level directory of the DLE must be readable by the Amanda user.</para>
1959 <para>With the <amkeyword>append</amkeyword> keyword, the
1960 <amtype>string</amtype> is appended to the current list, without it, the
1961 <amtype>string</amtype> overwrites the list.</para>
1964 <amkeyword>optional</amkeyword> is specified for
1965 <amkeyword>include list</amkeyword>, then amcheck will not complain if the file
1966 doesn't exist or is not readable.</para>
1968 <para>For <amkeyword>include list</amkeyword>,
1969 If the file name is relative, the disk name being backed up is prepended.</para>
1974 <term><amkeyword>index</amkeyword> <amtype>boolean</amtype></term>
1976 <para>Default: <amkeyword>no</amkeyword>.
1977 Whether an index (catalogue) of the backup should be generated and saved in
1978 <amkeyword>indexdir</amkeyword>.
1979 These catalogues are used by the <emphasis remap='B'>amrecover</emphasis> utility.</para>
1984 <term><amkeyword>kencrypt</amkeyword> <amtype>boolean</amtype></term>
1987 <amkeyword>no</amkeyword>.
1988 Whether the backup image should be encrypted by Kerberos as it is sent
1989 across the network from the backup client host to the tape server host.</para>
1993 <term><amkeyword>maxdumps</amkeyword> <amtype>int</amtype></term>
1996 <amdefault>1</amdefault>.
1997 The maximum number of backups from a single host that Amanda will attempt to run in parallel.
1998 See also the main section parameter <amkeyword>inparallel</amkeyword>.</para>
2002 <term><amkeyword>maxpromoteday</amkeyword> <amtype>int</amtype></term>
2005 <amdefault>10000</amdefault>.
2006 The maximum number of day for a promotion, set it 0 if you don't want
2007 promotion, set it to 1 or 2 if your disks get overpromoted.</para>
2011 <term><amkeyword>priority</amkeyword> [ <amkeyword>low</amkeyword> | <amkeyword>medium</amkeyword> | <amkeyword>high</amkeyword> ]</term>
2013 <para>Default: <amkeyword>medium</amkeyword>.
2014 When there is no tape to write to, Amanda will do incremental backups
2015 in priority order to the holding disk. The priority may be
2016 high (2), medium (1), low (0) or a number of your choice.</para>
2020 <term><amkeyword>program</amkeyword> [ <amkeyword>"DUMP"</amkeyword> | <amkeyword>"GNUTAR"</amkeyword> | <amkeyword>"APPLICATION"</amkeyword> ]</term>
2023 <amdefault>"DUMP"</amdefault>.
2024 The type of backup to perform. Valid values are:</para>
2026 <variablelist remap='TP'>
2028 <term><amkeyword>"DUMP"</amkeyword></term>
2030 <para>The native operating system backup program.</para>
2034 <term><amkeyword>"GNUTAR"</amkeyword></term>
2036 <para>To use GNU-tar or to do PC backups using Samba.</para>
2040 <term><amkeyword>"APPLICATION"</amkeyword></term>
2042 <para>To use an application, see the <emphasis>application</emphasis> option.</para>
2049 <term><amkeyword>application</amkeyword> <amtype>string</amtype></term>
2051 <para>No default. Must be the name of an application if <emphasis>program</emphasis> is set to <emphasis remap='I'>APPLICATION</emphasis>. See APPLICATION SECTION below.</para>
2055 <term><amkeyword>script</amkeyword> <amtype>string</amtype></term>
2057 <para>No default. Must be the name of a script. You can have many script. See SCRIPT SECTION below.</para>
2061 <term><amkeyword>property</amkeyword> [<amkeyword>append</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
2063 <para>These options can set various properties, they can be used by third
2064 party software to store information in the configuration file.
2065 Both strings are quoted; the first string contains the name of
2066 the property to set, and the others contains its values.
2067 <amkeyword>append</amkeyword> keyword append the values to the list of values for that property.
2073 <term><amkeyword>record</amkeyword> <amtype>boolean</amtype></term>
2076 <amkeyword>yes</amkeyword>.
2077 Whether to ask the backup program to update its database (e.g. <filename>/etc/dumpdates</filename>
2078 for DUMP or <filename>/usr/local/var/amanda/gnutar-lists</filename> for GNUTAR) of time stamps.
2079 This is normally enabled for daily backups and turned off for periodic archival runs.</para>
2083 <term><amkeyword>skip-full</amkeyword> <amtype>boolean</amtype></term>
2086 <amkeyword>no</amkeyword>. If <amkeyword>true</amkeyword> and
2087 <emphasis remap='B'>planner</emphasis> has scheduled a full backup, these disks will be skipped, and
2088 full backups should be run off-line on these days. It was reported that Amanda only schedules
2089 level 1 incrementals in this configuration; this is probably a bug.</para>
2093 <term><amkeyword>skip-incr</amkeyword> <amtype>boolean</amtype></term>
2096 <amkeyword>no</amkeyword>. If <amkeyword>true</amkeyword> and
2097 <emphasis remap='B'>planner</emphasis> has scheduled an incremental backup, these disks will be skipped.</para>
2101 <term><amkeyword>ssh_keys</amkeyword> <amtype>string</amtype></term>
2103 <para>Default: not set.
2104 The key file the ssh auth will use, it must be the private key. If this parameter is not specified, then the default ssh key will be used.</para>
2108 <term><amkeyword>starttime</amkeyword> <amtype>int</amtype></term>
2110 <para>Default: not set.
2111 Backup of these disks will not start until after this time of day.
2112 The value should be hh*100+mm, e.g. 6:30PM (18:30) would be entered as
2113 <literal>1830</literal>.</para>
2117 <term><amkeyword>strategy</amkeyword> [ <amkeyword>standard</amkeyword> | <amkeyword>nofull</amkeyword> | <amkeyword>noinc</amkeyword> | <amkeyword>skip</amkeyword> | <amkeyword>incronly</amkeyword> ]</term>
2119 <para>Default: <amkeyword>standard</amkeyword>.
2120 Strategy to use when planning what level of backup to run next. Values are:</para>
2122 <variablelist remap='TP'>
2124 <term><amkeyword>standard</amkeyword></term>
2126 <para>The standard Amanda schedule.</para>
2130 <term><amkeyword>nofull</amkeyword></term>
2132 <para>Never do full backups, only level 1 incrementals.</para>
2136 <term><amkeyword>noinc</amkeyword></term>
2138 <para>Never do incremental backups, only full dumps.</para>
2142 <term><amkeyword>skip</amkeyword></term>
2144 <para>Treat this DLE as if it doesn't exist (useful to disable DLEs
2145 when sharing the <emphasis remap='I'>disklist</emphasis> file between
2146 multiple configurations). Skipped DLEs will not be checked or
2147 dumped, and will not be matched by disklist expressions.</para>
2151 <term><amkeyword>incronly</amkeyword></term>
2153 <para>Only do incremental dumps. <command>amadmin force</command> should be used to tell
2154 Amanda that a full dump has been performed off-line, so that it resets to level 1.</para>
2162 <term><amkeyword>tape_splitsize</amkeyword> <amtype>int</amtype></term>
2164 <para>Default: not set.
2165 Split dump file on tape into pieces of a specified size.
2166 This allows dumps to be spread across multiple tapes, and can potentially
2167 make more efficient use of tape space.
2168 Note that if this value is too large (more than half the size of the
2169 average dump being split), substantial tape space can be wasted.
2170 If too small, large dumps will be split into innumerable tiny dumpfiles,
2171 adding to restoration complexity.
2172 A good rule of thumb, usually, is 1/10 of the size of your tape.</para>
2173 <para>The default unit is Kbytes if it is not specified.</para>
2178 <term><amkeyword>split_diskbuffer</amkeyword> <amtype>string</amtype></term>
2180 <para>Default: not set.
2181 When dumping a split dump in PORT-WRITE mode (usually meaning "no holding disk"), buffer the split chunks to a file in the directory specified by this option.
2187 <term><amkeyword>fallback_splitsize</amkeyword> <amtype>int</amtype></term>
2190 <amdefault>10M</amdefault>.
2191 When dumping a split dump in PORT-WRITE mode, if no split_diskbuffer is
2192 specified (or if we somehow fail to use our split_diskbuffer), we must
2193 buffer split chunks in memory.
2194 This specifies the maximum size split chunks can be in this scenario,
2195 and thus the maximum amount of memory consumed for in-memory splitting.
2196 The size of this buffer can be changed from its (very conservative) default
2197 to a value reflecting the amount of memory that each taper process on
2198 the dump server may reasonably consume.
2200 <para>The default unit is Kbytes if it is not specified.</para>
2205 <para>The following <amkeyword>dumptype</amkeyword> entries are predefined by Amanda:</para>
2207 <programlisting remap='.nf'>
2208 define dumptype "no-compress" {
2211 define dumptype "compress-fast" {
2212 compress client fast
2214 define dumptype "compress-best" {
2215 compress client best
2217 define dumptype "srvcompress" {
2218 compress server fast
2220 define dumptype "bsd-auth" {
2223 define dumptype "no-record" {
2226 define dumptype "no-hold" {
2229 define dumptype "no-full" {
2234 <para>In addition to options in a
2235 <amkeyword>dumptype</amkeyword>
2236 section, one or more other
2237 <amkeyword>dumptype</amkeyword>
2238 names may be supplied as identifiers, which make this
2239 <amkeyword>dumptype</amkeyword>
2240 inherit options from other previously defined
2241 <amkeyword>dumptype</amkeyword>s.
2242 For instance, two sections might be the same except for the
2243 <amkeyword>record</amkeyword> option:</para>
2245 <programlisting remap='.nf'>
2246 define dumptype "normal" {
2247 comment "Normal backup, no compression, do indexing"
2252 define dumptype "testing" {
2253 comment "Test backup, no compression, do indexing, no recording"
2259 <para>Amanda provides a
2260 <amkeyword>dumptype</amkeyword>
2262 <emphasis remap='I'>global</emphasis>
2264 <emphasis remap='B'>amanda.conf</emphasis>
2266 <amkeyword>dumptype</amkeyword>s
2268 This provides an easy place to make changes that will affect every
2269 <amkeyword>dumptype</amkeyword>, although you must be careful
2270 that every dumptype explicitly inherits from the
2271 <emphasis remap='I'>global</emphasis>
2272 dumptype - Amanda does not do so automatically.</para>
2275 <refsect1><title>TAPETYPE SECTION</title>
2276 <para>The <emphasis remap='B'>amanda.conf</emphasis>
2277 file may define multiple types of tape media and devices.
2278 The information is entered in a
2279 <amkeyword>tapetype</amkeyword>
2280 section, which looks like this in the config file:</para>
2283 define tapetype "<amtype>name</amtype>" {
2284 <emphasis remap='I'>tapetype-option</emphasis> <emphasis remap='I'>tapetype-value</emphasis>
2285 <literal>...</literal>
2289 <para>The { must appear at the end of a line, and the } on its own line.</para>
2290 <para><emphasis remap='I'>Name</emphasis>
2291 is the name of this type of tape medium/device.
2292 It is referenced from the
2293 <amkeyword>tapetype</amkeyword>
2294 option in the main part of the config file.</para>
2296 <para>The tapetype options and values are:</para>
2297 <variablelist remap='TP'>
2299 <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
2301 <para>Default: not set.
2302 A comment string describing this set of tape information.</para>
2306 <term><amkeyword>filemark</amkeyword> <amtype>int</amtype></term>
2309 <amdefault>1 kbytes</amdefault>.
2310 How large a file mark (tape mark) is, measured in kbytes.
2311 If the size is only known in some linear measurement (e.g. inches),
2312 convert it to kbytes using the device density.</para>
2316 <term><amkeyword>length</amkeyword> <amtype>int</amtype></term>
2319 <amdefault>2000 kbytes</amdefault>. How much data will fit on a tape, expressed in kbytes.</para>
2321 <para>Note that this value is only used by Amanda to schedule which backups will be run.
2322 Once the backups start, Amanda will continue to write to a tape until it gets an error,
2323 regardless of what value is entered for <amkeyword>length</amkeyword>
2324 (but see <manref name="amanda-devices" vol="7" /> for exceptions).
2330 <term><amkeyword>blocksize</amkeyword> <amtype>int</amtype></term>
2333 <amdefault>32 kbytes</amdefault>.
2334 How much data will be written in each tape record, expressed in kbytes. This is similar to the <emphasis remap="I">BLOCK_SIZE</emphasis> device property, but if the blocksize is not a multiple of 1024 bytes, then this parameter cannot be used to specify it, and the property must be used instead.</para>
2338 <term><amkeyword>readblocksize</amkeyword> <amtype>int</amtype></term>
2340 <para>Default: <amdefault>32 kytes</amdefault>
2341 How much data will be read in each tape record. This can be used to override a
2342 device's block size for reads only. This may be useful, for example, in
2343 reading a tape written with a 256k block size when Amanda is configured to use
2344 128k blocks. This unusual feature is not supported by all operating systems and
2347 <para>The default unit is Kbytes if it is not specified.</para>
2352 <term><amkeyword>speed</amkeyword> <amtype>int</amtype></term>
2355 <amdefault>200 bps</amdefault>.
2356 How fast the drive will accept data, in bytes per second.
2357 This parameter is NOT currently used by Amanda.</para>
2361 <term><amkeyword>lbl-templ</amkeyword> <amtype>string</amtype></term>
2363 <para>Default: not set.
2364 A PostScript template file used by
2365 <emphasis remap='B'>amreport</emphasis>
2366 to generate labels. Several sample files are provided with the Amanda sources in the
2367 <emphasis remap='I'>example</emphasis> directory.
2369 <manref name="amreport" vol="8"/>
2370 man page for more information.</para>
2375 <para>In addition to options, another
2376 <amkeyword>tapetype</amkeyword>
2377 name may be supplie as an identifier, which makes this
2378 <amkeyword>tapetype</amkeyword>
2379 inherit options from another
2380 <amkeyword>tapetype</amkeyword>.
2381 For instance, the only difference between a DLT4000 tape drive using
2382 Compact-III tapes and one using Compact-IV tapes is the length of the tape.
2383 So they could be entered as:</para>
2385 <programlisting remap='.nf'>
2386 define tapetype "DLT4000-III" {
2387 comment "DLT4000 tape drives with Compact-III tapes"
2388 length 12500 mbytes # 10 Gig tapes with some compression
2389 filemark 2000 kbytes
2392 define tapetype "DLT4000-IV" {
2394 comment "DLT4000 tape drives with Compact-IV tapes"
2395 length 25000 mbytes # 20 Gig tapes with some compression
2399 <!-- If anybody has read this, where do all those stupid
2400 pseudo-duplicate FOM-tapetype-entries come from??
2406 <refsect1><title>INTERFACE SECTION</title>
2408 <emphasis remap='B'>amanda.conf</emphasis>
2409 file may define multiple types of network interfaces.
2410 The information is entered in an <amkeyword>interface</amkeyword>
2411 section, which looks like this:</para>
2414 define interface "<emphasis remap='I'>name</emphasis>" {
2415 <emphasis remap='I'>interface-option</emphasis> <emphasis remap='I'>interface-value</emphasis>
2416 <literal>...</literal>
2420 <para>The { must appear at the end of a line, and the } on its own line.</para>
2421 <para><emphasis remap='I'>name</emphasis>
2422 is the name of this type of network interface. It is referenced from the
2423 <emphasis remap='I'>disklist</emphasis> file.</para>
2425 <para>Note that these sections define network interface characteristics,
2426 not the actual interface that will be used. Nor do they impose limits on the bandwidth that will
2427 actually be taken up by Amanda.
2428 Amanda computes the estimated bandwidth each file system backup will take
2429 based on the estimated size and time, then compares that plus any other running
2430 backups with the limit as another of the criteria when deciding whether
2431 to start the backup. Once a backup starts, Amanda will use as much of the network as it can
2432 leaving throttling up to the operating system and network hardware.</para>
2434 <para>The interface options and values are:</para>
2435 <variablelist remap='TP'>
2437 <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
2439 <para>Default: not set.
2440 A comment string describing this set of network information.</para>
2444 <term><amkeyword>use</amkeyword> <amtype>int</amtype></term>
2447 <amdefault>8000 Kbps</amdefault>.
2448 The speed of the interface in Kbytes per second.</para>
2453 <para>In addition to options, another
2454 <amkeyword>interface</amkeyword>
2455 name may be supplied as an identifier, which makes this
2456 <amkeyword>interface</amkeyword>
2457 inherit options from another
2458 <amkeyword>interface</amkeyword>.
2459 At the moment, this is of little use.</para>
2462 <refsect1><title>APPLICATION SECTION</title>
2464 <emphasis remap='B'>amanda.conf</emphasis>
2465 file may define multiple types of application.
2466 The information is entered in a <amkeyword>application</amkeyword>
2467 section, which looks like this:</para>
2470 define application "<emphasis remap='I'>name</emphasis>" {
2471 <emphasis remap='I'>application-option</emphasis> <emphasis remap='I'>application-value</emphasis>
2472 <literal>...</literal>
2475 <para>The { must appear at the end of a line, and the } on its own line.</para>
2477 <para><emphasis remap='I'>name</emphasis>
2478 is the name of this type of application. It is referenced from the
2479 <emphasis remap='I'>dumptype</emphasis></para>
2481 <para>The application options and values are:</para>
2482 <variablelist remap='TP'>
2484 <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
2486 <para>Default: not set.
2487 A comment string describing this application.</para>
2491 <term><amkeyword>plugin</amkeyword> <amtype>string</amtype></term>
2493 <para>No default. Must be set to the name of the program. This program must be in the <emphasis remap='I'>$libexecdir/amanda/application</emphasis> directory on the client.</para>
2497 <term><amkeyword>property</amkeyword> [<amkeyword>append</amkeyword>] [<amkeyword>priority</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
2499 <para>No default. You can set property for the application, each application have a different set of property. Both strings are quoted; the first string contains the name of
2500 the property to set, and the others contains its values.
2501 <amkeyword>append</amkeyword> keyword append the values to the list of values for that property.
2502 <amkeyword>priority</amkeyword> keyword disallow the setting of that property on the client.
2509 <refsect1><title>SCRIPT SECTION</title>
2511 <emphasis remap='B'>amanda.conf</emphasis>
2512 file may define multiple types of script.
2513 The information is entered in a <amkeyword>script</amkeyword>
2514 section, which looks like this:</para>
2517 define script "<emphasis remap='I'>name</emphasis>" {
2518 <emphasis remap='I'>script-option</emphasis> <emphasis remap='I'>script-value</emphasis>
2519 <literal>...</literal>
2522 <para>The { must appear at the end of a line, and the } on its own line.</para>
2524 <para><emphasis remap='I'>name</emphasis>
2525 is the name of this type of script. It is referenced from the
2526 <emphasis remap='I'>dumptype</emphasis></para>
2528 <para>The script options and values are:</para>
2529 <variablelist remap='TP'>
2531 <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
2533 <para>Default: not set.
2534 A comment string describing this script.</para>
2538 <term><amkeyword>plugin</amkeyword> <amtype>string</amtype></term>
2540 <para>No default. Must be set to the name of the program. This program must be in the <emphasis remap='I'>$libexecdir/amanda/application</emphasis> directory on the client and/or server.</para>
2544 <term><amkeyword>order</amkeyword> <amtype>int</amtype></term>
2546 <para>Default: <amdefault>5000</amdefault>. Scripts are executed in that order, it is useful if you have many scripts and they must be executed in a spefific order.</para>
2550 <term><amkeyword>execute_where</amkeyword> [ <amkeyword>client</amkeyword> | <amkeyword>server</amkeyword> ]</term>
2552 <para>Default: <amkeyword>client</amkeyword>. Where the script must be executed, on the client or server.</para>
2556 <term><amkeyword>>execute_on</amkeyword> <amtype>execute_on</amtype> [,<amtype>execute_on</amtype>]*</term>
2558 <para>No default. When the script must be executed, you can specify many of them:</para>
2560 <variablelist remap='TP'>
2562 <term><amkeyword>pre-dle-amcheck</amkeyword></term>
2564 <para>Execute before the amcheck command for the dle.</para>
2568 <term><amkeyword>pre-host-amcheck</amkeyword></term>
2570 <para>Execute before the amcheck command for all dle for the client.</para>
2574 <term><amkeyword>post-dle-amcheck</amkeyword></term>
2576 <para>Execute after the amcheck command for the dle.</para>
2580 <term><amkeyword>post-host-amcheck</amkeyword></term>
2582 <para>Execute after the amcheck command for all dle for the client.</para>
2586 <term><amkeyword>pre-dle-estimate</amkeyword></term>
2588 <para>Execute before the estimate command for the dle.</para>
2592 <term><amkeyword>pre-host-estimate</amkeyword></term>
2594 <para>Execute before the estimate command for all dle for the client.</para>
2598 <term><amkeyword>post-dle-estimate</amkeyword></term>
2600 <para>Execute after the estimate command for the dle.</para>
2604 <term><amkeyword>post-host-estimate</amkeyword></term>
2606 <para>Execute after the estimate command for all dle for the client.</para>
2610 <term><amkeyword>pre-dle-backup</amkeyword></term>
2612 <para>Execute before the backup command for the dle.</para>
2616 <term><amkeyword>pre-host-backup</amkeyword></term>
2618 <para>Execute before the backup command for all dle for the client. It can't be run on client, it must be run on server</para>
2622 <term><amkeyword>post-dle-backup</amkeyword></term>
2624 <para>Execute after the backup command for the dle.</para>
2628 <term><amkeyword>post-host-backup</amkeyword></term>
2630 <para>Execute after the backup command for all dle for the client. It can't be run on client, it must be run on server</para>
2634 <term><amkeyword>pre-recover</amkeyword></term>
2636 <para>Execute before any level is recovered.</para>
2640 <term><amkeyword>post-recover</amkeyword></term>
2642 <para>Execute after all levels are recovered.</para>
2646 <term><amkeyword>pre-level-recover</amkeyword></term>
2648 <para>Execute before each level recovery.</para>
2652 <term><amkeyword>post-level-recover</amkeyword></term>
2654 <para>Execute after each level recovery.</para>
2658 <term><amkeyword>inter-level-recover</amkeyword></term>
2660 <para>Execute between two levels of recovery.</para>
2664 <para>If you recover level 0 and 2 of the disk /usr with amrecover, it will execute:</para>
2666 script --pre-recover
2667 script --pre-level-recover --level 0
2669 script --post-level-recover --level 0
2670 script --inter-level-recover --level 0 --level 2
2671 script --pre-level-recover --level 2
2673 script --post-level-recover --level 2
2674 script --post-recover
2679 <term><amkeyword>property</amkeyword>> [<amkeyword>append</amkeyword>] [<amkeyword>priority</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
2681 <para>No default. You can set property for the script, each script have a different set of property. Both strings are quoted; the first string contains the name of
2682 the property to set, and the others contains its values.
2683 <amkeyword>append</amkeyword> keyword append the values to the list of values for that property.
2684 <amkeyword>priority</amkeyword> keyword disallow the setting of that property on the client.
2691 <refsect1><title>DEVICE SECTION</title>
2692 <para>Backend storage devices are specified in
2693 <emphasis remap='B'>amanda.conf</emphasis>
2694 in the form of "device" sections, which look like this:</para>
2697 define device <emphasis remap='I'>name</emphasis> {
2698 commend "<emphasis remap='I'>comment (optional)</emphasis>"
2699 tapedev "<emphasis remap='I'>device-specifier</emphasis>"
2700 device_property "<emphasis remap='I'>prop-name</emphasis>" "<emphasis remap='I'>prop-value</emphasis>"
2701 <literal>...</literal>
2705 <para>The { must appear at the end of a line, and the } on its own line.</para>
2706 <para><emphasis remap='I'>name</emphasis> is the user-specified name of
2707 this device. It is referenced from the global <emphasis
2708 remap='I'>tapedev</emphasis> parameter. The <emphasis
2709 remap='I'>device-specifier</emphasis> specifies the device name to use;
2710 see <manref name="amanda-devices" vol="7"/>.
2711 As with most sections, the <emphasis remap='I'>comment</emphasis>
2712 parmeter is optional and only for the user's convenience.</para>
2714 <para>An arbitrary number of <emphasis
2715 remap='I'>device_property</emphasis> parameters can be specified.
2717 <manref name="amanda-devices" vol="7"/>
2718 for information on device properties.</para>
2722 <refsect1><title>CHANGER SECTION</title>
2723 <para>Changers are described in
2724 <emphasis remap='B'>amanda.conf</emphasis>
2725 in the form of "changer" sections, which look like this:</para>
2728 define changer <emphasis remap='I'>name</emphasis> {
2729 comment "<emphasis remap='I'>comment (optional)</emphasis>"
2730 tpchanger "<emphasis remap='I'>changer-spec</emphasis>"
2731 changerdev "<emphasis remap='I'>device-name</emphasis>"
2732 changerfile "<emphasis remap='I'>state-file</emphasis>"
2733 <literal>...</literal>
2737 <para>The { must appear at the end of a line, and the } on its own line.</para>
2738 <para><emphasis remap='I'>name</emphasis> is the user-specified name of this
2739 device. The remaining parameters are specific to the changer type selected.
2742 <para>See <manref name="amanda-changers" vol="7" /> for more information on configuring changers.</para>
2747 <manref name="amanda-client.conf" vol="5"/>,
2748 <manref name="amanda-applications" vol="7"/>,
2749 <manref name="amanda-auth" vol="7"/>,
2750 <manref name="amanda-changers" vol="7"/>,
2751 <manref name="amanda-devices" vol="7"/>,
2752 <manref name="amanda-scripts" vol="7"/>