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>' and '<amkeyword>_</amkeyword>'
60 are interchangeable in all predefined Amanda keywords:
61 <amkeyword>device_property</amkeyword>
63 <amkeyword>device-property</amkeyword>
64 have the same meaning. This manpage uses the dashed versions, but the
65 underscored versions will be accepted for backward compatibility</para>
67 <para>Identifiers are names which are defined in the configuration itself, such
68 as dumptypes or interfaces. Identifiers are are case-insensitive, but
70 '<amkeyword>-</amkeyword>' vs. '<amkeyword>_</amkeyword>'.
71 Identifiers should be quoted in the configuration file, although For historical
72 reasons, the quotes are optional.</para>
74 <para>Strings are always quoted with double quotes ("), and any double quotes
75 or backslashes within the string are escaped with a backslash:
77 tapelist "/path/to/tapelist"
78 property "escaped-string" "escaping: \\ (backslash) and \" (double-quote)"
82 <para>To summarize, then:
85 logdir "logs" # required sensitive sensitive
86 send-amreport-on strange # prohibited insensitive insensitive
87 tapetype "EXABYTE" # optional insensitive sensitive
89 define dumptype "dt" { # optional insensitive sensitive
90 "dumptype-common" # optional insensitive sensitive
91 strategy noinc # prohibited insensitive insensitive
98 <refsect2><title>VALUE SUFFIXES</title>
100 <para>Integer arguments may have one of the following (case insensitive) suffixes,
101 some of which have a multiplier effect:</para>
103 <variablelist remap='TP'>
105 <term><amkeyword>b byte bytes</amkeyword></term>
107 <para>Some number of bytes.</para>
111 <term><amkeyword>bps</amkeyword></term>
113 <para>Some number of bytes per second.</para>
117 <term><amkeyword>k kb kbyte kbytes kilobyte kilobytes</amkeyword></term>
119 <para>Some number of kilobytes (bytes*1024).</para>
123 <term><amkeyword>kps kbps</amkeyword></term>
125 <para>Some number of kilobytes per second (bytes*1024).</para>
126 <para>It is the default multiplier for all size options.</para>
130 <term><amkeyword>m mb meg mbyte mbytes megabyte megabytes</amkeyword></term>
132 <para>Some number of megabytes (bytes*1024*1024).</para>
136 <term><amkeyword>mps mbps</amkeyword></term>
138 <para>Some number of megabytes per second (bytes*1024*1024).</para>
142 <term><amkeyword>g gb gbyte gbytes gigabyte gigabytes</amkeyword></term>
144 <para>Some number of gigabytes (bytes*1024*1024*1024).</para>
148 <term><amkeyword>t tb tbyte tbytes terabyte terabytes</amkeyword></term>
150 <para>Some number of terabytes (bytes*1024*1024*1024*1024).</para>
154 <term><amkeyword>tape tapes</amkeyword></term>
156 <para>Some number of tapes.</para>
160 <term><amkeyword>day days</amkeyword></term>
162 <para>Some number of days.</para>
166 <term><amkeyword>week weeks</amkeyword></term>
168 <para>Some number of weeks (days*7).</para>
170 <note><para>The value
171 <amkeyword>inf</amkeyword>
172 may be used in most places where an integer is expected
173 to mean an infinite amount.</para>
175 <para>Boolean arguments may have any of the values
176 <amkeyword>1</amkeyword>,
177 <amkeyword>y</amkeyword>,
178 <amkeyword>yes</amkeyword>,
179 <amkeyword>t</amkeyword>,
180 <amkeyword>true</amkeyword>
182 <amkeyword>on</amkeyword>
183 to indicate a true state, or
184 <amkeyword>0</amkeyword>,
185 <amkeyword>n</amkeyword>,
186 <amkeyword>no</amkeyword>,
187 <amkeyword>f</amkeyword>,
188 <amkeyword>false</amkeyword>
190 <amkeyword>off</amkeyword>
191 to indicate a false state.
192 If no argument is given,
193 <amkeyword>true</amkeyword>
202 <refsect2><title>PARAMETER ORDER</title>
204 <para>In general, the order in which parameters occur in the configuration file
205 does not matter, with the exception of subsection inheritance. For example, if
206 dumptype "normal-encrypt" which inherits from dumptype "normal", then "normal"
207 must appear first in the configuration file.</para>
211 <refsect2><title>STRINGS</title>
212 <para>Quoted strings in Amanda follow a common, C-like syntax. Printable
213 characters and whitespace are kept as-is, except that the backslash character
214 (\) is used as an escape character, and a double-quote ends the string. The allowed
217 ESCAPE SEQUENCE BECOMES
226 \001 - \377 (character specified in octal)
228 Illegally quoted strings are handled on a "best-effort" basis, which may lead to
233 finserver "/data/finance/XYZ Corp's \"real\" finances" finance-high eth0 -1
234 property "syspath" "C:\\WINDOWS\\SYSTEM"
239 <refsect2><title>SUBSECTIONS AND INHERITANCE</title>
241 <para>Amanda configuration files may include various
242 <emphasis>subsections</emphasis>, each defining a set of configuration
243 directives. Each type of subsection is described below. Note that all types
244 of subsections can <emphasis>inherit</emphasis> from other subsections of the
245 same type by naming the "parent" section in the "child" subsection. For
249 define dumptype global {
254 define dumptype nocomp {
255 global # inherit the parameters in dumptype 'global'
258 </programlisting></para>
260 <para>Note that multiple inheritance is also supported by simply naming
261 multiple parent sections in a child. Parents are implicitly expanded in place
262 in a child, and the last occurrence of each parameter takes precedence. For
265 define tapetype par1 {
271 define tapetype par2 {
276 define tapetype child {
282 In this example, 'child' will have a filemark of 32k, a speed of 400bps, and a
283 length of 200M.</para>
289 <title>GLOBAL PARAMETERS</title>
291 <variablelist remap='TP'>
293 <term><amkeyword>org</amkeyword> <amtype>string</amtype></term>
296 <amdefault>"daily"</amdefault>.
297 A descriptive name for the configuration.
298 This string appears in the Subject line of mail reports.
299 Each Amanda configuration should have a different string to keep
300 mail reports distinct.</para>
304 <term><amkeyword>mailer</amkeyword> <amtype>string</amtype></term>
306 <para>Default found by configure. A mail program that can send mail with '<emphasis remap='I'>MAILER -s "subject" user < message_file</emphasis>'.</para>
310 <term><amkeyword>mailto</amkeyword> <amtype>string</amtype></term>
313 A space separated list of recipients for mail reports. If not specified, amdump will not send any mail.</para>
317 <term><amkeyword>send-amreport-on</amkeyword> [ <amkeyword>all</amkeyword> | <amkeyword>strange</amkeyword> | <amkeyword>error</amkeyword> | <amkeyword>never</amkeyword> ]</term>
320 <amkeyword>all</amkeyword>.
321 Specify which types of messages will trigger an email from amreport. amreport is used by amdump and amflush.</para>
323 <variablelist remap='TP'>
325 <term><amkeyword>all</amkeyword></term>
327 <para>Send an email on any message.</para>
331 <term><amkeyword>strange</amkeyword></term>
333 <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>
337 <term><amkeyword>error</amkeyword></term>
339 <para>Send an email only on error messages.</para>
343 <term><amkeyword>never</amkeyword></term>
345 <para>Never send an email.</para>
352 <term><amkeyword>dumpcycle</amkeyword> <amtype>int</amtype></term>
355 <amdefault>10 days</amdefault>.
356 The number of days in the backup cycle.
357 Each disk will get a full backup at least this often.
358 Setting this to zero tries to do a full backup each run.</para>
359 <note><para>This parameter may also be set in a specific
360 <amkeyword>dumptype</amkeyword>
362 This value sets the default for all
363 <amkeyword>dumptype</amkeyword>s
365 <emphasis remap='B'>amanda.conf</emphasis>
367 <amkeyword>dumptype</amkeyword>s
374 <term><amkeyword>runspercycle</amkeyword> <amtype>int</amtype></term>
377 <amdefault>same as dumpcycle</amdefault>.
378 The number of amdump runs in
379 <amkeyword>dumpcycle</amkeyword>
381 A value of 0 means the same value as
382 <amkeyword>dumpcycle</amkeyword>.
383 A value of -1 means guess the number of runs from the &tapelist; file,
384 which is the number of tapes used in the last
385 <amkeyword>dumpcycle</amkeyword>
387 <amkeyword>runtapes</amkeyword>.</para>
391 <term><amkeyword>tapecycle</amkeyword> <amtype>int</amtype></term>
394 <amdefault>15 tapes</amdefault>.
396 Specifies the number of "active" volumes - volumes that Amanda will not
397 overwrite. While Amanda is always willing to write to a new volume, it refuses
398 to overwrite a volume unless at least '<amkeyword>tapecycle</amkeyword> -1'
399 volumes have been written since.</para>
401 <para> It is considered good administrative practice to set the
402 <amkeyword>tapecycle</amkeyword> parameter slightly lower than the actual
403 number of tapes in use. This allows the administrator to more easily cope
404 with damaged or misplaced tapes or schedule adjustments that call for
405 slight adjustments in the rotation order.</para>
407 <para>Note: Amanda is commonly misconfigured with <amkeyword>tapecycle</amkeyword>
408 equal to the number of tapes per <amkeyword>dumpcycle</amkeyword>. In this
409 misconfiguration, amanda may erase a full dump before a new one is
410 completed. Recovery is then impossible. The
411 <amkeyword>tapecycle</amkeyword> must be at least one tape larger than the
412 number of tapes per dumpcycle.</para>
415 The number of tapes per dumpcycle is calculated by multiplying the number of
416 &amdump; runs per dump cycle <amkeyword>runspercycle</amkeyword> (the
417 number of &amdump; runs per dump cycle) and <emphasis
418 remap='B'>runtapes</emphasis> (the number of tapes used per run). Typically
419 <amkeyword>tapecycle</amkeyword> is set to two or four times the tapes
420 per dumpcycle.</para>
426 <term><amkeyword>usetimestamps</amkeyword>
427 <amtype>bool</amtype></term>
429 <para>Default: <amkeyword>Yes</amkeyword>.
430 This option allows Amanda to track multiple runs per calendar
431 day. The only reason one might disable it is that Amanda versions before 2.5.1
432 can't read logfiles written when this option was enabled.
438 <term><amkeyword>label-new-tapes</amkeyword>
439 <amtype>string</amtype></term>
441 <para>Deprecated, use <amkeyword>autolabel</amkeyword> option with options <amkeyword>volume-error empty</amkeyword> to get equivalent behavior.</para>
442 <para>Default: not set.
443 When set, this directive will cause Amanda to automatically write an Amanda
444 tape label to any blank tape she encounters.</para>
449 <term><amkeyword>autolabel</amkeyword>
450 <amtype>string</amtype>
451 [<amkeyword>any</amkeyword>]
452 [<amkeyword>other-config</amkeyword>]
453 [<amkeyword>non-amanda</amkeyword>]
454 [<amkeyword>volume-error</amkeyword>]
455 [<amkeyword>empty</amkeyword>]</term>
457 <para>Default: not set.
458 When set, this directive will cause Amanda to automatically write an Amanda
459 tape label to most volume she encounters. This option is DANGEROUS
460 because when set, Amanda may erase near-failing tapes or tapes accidentally
461 loaded in the wrong slot.</para>
462 <para>When using this directive, specify the template for new tape
463 labels. The template can contains many variables that are substituted by their
467 $o : org configuration
468 $b : barcode of the volume
470 </programlisting></para>
471 <para>The template should contain some number of contiguous '%'
472 characters, which will be replaced with a generated number. Be sure to
473 specify enough '%' characters that you do not run out of tape labels.
475 <markup>"DailySet1-%%%"</markup>,
476 <markup>"$c-%%%"</markup>,
477 <markup>"$m-%%%"</markup>,
478 <markup>"$m-$b"</markup>
480 <para>Note that many devices cannot distinguish an empty tape from an error
481 condition, so it may is often necessary to include
482 <amkeyword>volume-error</amkeyword> as an autolabel condition.</para>
483 <variablelist remap='TP'>
485 <term><amkeyword>any</amkeyword></term>
486 <listitem>equivalent to '<amkeyword>other-config non-amanda volume-error empty</amkeyword>'
490 <term><amkeyword>other-config</amkeyword></term>
491 <listitem>Label volumes with a valid Amanda label that do not match our
492 <amkeyword>labelstr</amkeyword>. Danger: this may erase volumes
493 from other Amanda configurations without warning!
497 <term><amkeyword>non-amanda</amkeyword></term>
498 <listitem>Label volumes which do not start with data that resembles an
499 Amanda header. Danger: this may erase volumes from other backup applications
504 <term><amkeyword>volume-error</amkeyword></term>
505 <listitem>Label volumes where an error occurs while trying to read the label.
506 Danger: this may erase arbitrary volumes due to transient errors.
510 <term><amkeyword>empty</amkeyword></term>
511 <listitem>Label volumes where a read returns 0 bytes.
519 <term><amkeyword>meta-autolabel</amkeyword>
520 <amtype>string</amtype></term>
522 <para>Default: not set. When set and if the changer support meta-label, this directive will cause Amanda to automatically add a meta-label to a meta-volume.</para>
523 <para>A meta-volume is a containers that contains many volumes, eg. a removable
524 hard-disk for use with chg-disk, each hard disk have many slots (volume).
525 The meta-label is the label to put on the meta-volume.</para>
526 <para>When using this directive, specify the template for new meta
527 labels. The template can contains many variables that are substituted by their
531 $o : org configuration
532 </programlisting></para>
533 <para>The template should contain some number of contiguous '%'
534 characters, which will be replaced with a generated number. Be sure to
535 specify enough '%' characters that you do not run out of meta labels.
537 <markup>"DailySet1-%%%"</markup>,
538 <markup>"$o-%%%"</markup>,
544 <term><amkeyword>dumpuser</amkeyword> <amtype>string</amtype></term>
547 <amdefault>"amanda"</amdefault>.
548 The login name Amanda uses to run the backups.
549 The backup client hosts must allow access
550 from the tape server host as this user via
551 <markup>.rhosts</markup>
553 <markup>.amandahosts</markup>,
554 depending on how the Amanda software was built.</para>
558 <term><amkeyword>printer</amkeyword> <amtype>string</amtype></term>
560 <para>Printer to use when doing tape labels.
562 <amkeyword>lbl-templ</amkeyword>
563 <amkeyword>tapetype</amkeyword>
569 <term><amkeyword>tapedev</amkeyword> <amtype>string</amtype></term>
572 <amdefault>"null:"</amdefault>.
573 This parameter can either specify a device (explicitly or by referencing a device definition - see <manref name="amanda-devices" vol="7" />)
574 or a tape changer (explicitly or by referencing a device definition - see <manref name="amanda-changers" vol="7" />).</para>
580 <term><amkeyword>device-property</amkeyword> <amtype>string</amtype> <amtype>string</amtype></term>
582 <para>These options can set various device properties. See
583 <manref name="amanda-devices" vol="7"/>
584 for more information on device properties and their syntax.
585 Both strings are always quoted; the first string contains the name of
586 the property to set, and the second contains its value. For example, to set
587 a fixed block size of 128k, write:</para>
589 device-property "BLOCK_SIZE" "128k"
596 <term><amkeyword>property</amkeyword> [<amkeyword>append</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
598 <para>These options can set various properties, they can be used by third
599 party software to store information in the configuration file.
600 Both strings are quoted; the first string contains the name of
601 the property to set, and the others contains its values.
602 <amkeyword>append</amkeyword> keyword append the values to the list of values for that property.
608 <term><amkeyword>tpchanger</amkeyword> <amtype>string</amtype></term>
610 <para>Default: not set. The tape changer to use. In most cases, only one of
611 <amkeyword>tpchanger</amkeyword> or <amkeyword>tapedev</amkeyword> is
612 specified, although for backward compatibility both may be specified if
613 <amkeyword>tpchanger</amkeyword> gives the name of an old changer script.
614 See <manref name="amanda-changers" vol="7" /> for more information on
615 configuring changers.</para>
620 <term><amkeyword>interactivity</amkeyword> <amtype>string</amtype></term>
622 <para>Default: not set. The interactivity module Amanda should use to interact with
623 the user. See <manref name="amanda-interactivity" vol="7" /> for a list of
629 <term><amkeyword>taperscan</amkeyword> <amtype>string</amtype></term>
631 <para>Default: traditional. The taperscan module amanda should use to find a tape
632 to write to. See <manref name="amanda-taperscan" vol="7" /> for a list of
638 <term><amkeyword>changerdev</amkeyword> <amtype>string</amtype></term>
641 <amdefault>"dev/null"</amdefault>.
642 A tape changer configuration parameter.
643 Usage depends on the particular changer defined with the
644 <amkeyword>tpchanger</amkeyword>
649 <term><amkeyword>changerfile</amkeyword> <amtype>string</amtype></term>
652 <amdefault>"/usr/adm/amanda/log/changer-status"</amdefault>.
653 A tape changer configuration parameter.
654 Usage depends on the particular changer defined with the
655 <amkeyword>tpchanger</amkeyword>
660 <term><amkeyword>runtapes</amkeyword> <amtype>int</amtype></term>
663 <amdefault>1</amdefault>.
664 The maximum number of tapes used in a single run.
665 If a tape changer is not configured, this option is not used
666 and should be commented out of the configuration file.</para>
667 <para>If a tape changer is configured, this may be set larger than one to
668 let Amanda write to more than one tape.</para>
669 <para>Note that this is an upper bound on the number of tapes,
670 and Amanda may use less.</para>
675 <term><amkeyword>maxdumpsize</amkeyword> <amtype>int</amtype></term>
678 <amdefault><amkeyword>runtapes</amkeyword>*<amkeyword>tape-length</amkeyword></amdefault>.
679 Maximum number of bytes the planner will schedule for a run.</para>
680 <para>The default unit is Kbytes if it is not specified.</para>
684 <term><amkeyword>taperalgo</amkeyword> [ <amkeyword>first</amkeyword> | <amkeyword>firstfit</amkeyword> | <amkeyword>largest</amkeyword> | <amkeyword>largestfit</amkeyword> | <amkeyword>smallest</amkeyword> | <amkeyword>last</amkeyword> ]</term>
687 <amkeyword>first</amkeyword>.
688 The algorithm used to choose which dump image to send to the taper.</para>
690 <variablelist remap='TP'>
692 <term><amkeyword>first</amkeyword></term>
694 <para>First in, first out.</para>
698 <term><amkeyword>firstfit</amkeyword></term>
700 <para>The first dump image that will fit on the current tape.</para>
704 <term><amkeyword>largest</amkeyword></term>
706 <para>The largest dump image.</para>
710 <term><amkeyword>largestfit</amkeyword></term>
712 <para>The largest dump image that will fit on the current tape.</para>
716 <term><amkeyword>smallest</amkeyword></term>
718 <para>The smallest dump image.</para>
722 <term><amkeyword>last</amkeyword></term>
724 <para>Last in, first out.</para>
732 <term><amkeyword>taper-parallel-write</amkeyword> <amtype>int</amtype></term>
735 <para>Default: <amdefault>1</amdefault>.
736 Amanda can write simultaneously up to that number of volume at any given
737 time. The changer must have as many drives.</para>
740 <term><amkeyword>labelstr</amkeyword> <amtype>string</amtype></term>
743 <amdefault>".*"</amdefault>.
744 The tape label constraint regular expression.
745 All tape labels generated (see
746 <manref name="amlabel" vol="8"/>)
747 and used by this configuration must match the regular expression.
748 If multiple configurations are run from the same tape server host,
749 it is helpful to set their labels to different strings
750 (for example, "DAILY[0-9][0-9]*" vs.
751 "ARCHIVE[0-9][0-9]*")
752 to avoid overwriting each other's tapes.</para>
756 <term><amkeyword>tapetype</amkeyword> <amtype>string</amtype></term>
759 <amdefault>no default</amdefault>.
760 The type of tape drive associated with
761 <amkeyword>tapedev</amkeyword>
763 <amkeyword>tpchanger</amkeyword>.
764 This refers to one of the defined <amkeyword>tapetype</amkeyword>s
765 in the config file (see below), which specify various tape parameters,
767 <amkeyword>length</amkeyword>,
768 <amkeyword>filemark</amkeyword>
770 <amkeyword>speed</amkeyword>
771 of the tape media and device.</para>
775 <term><amkeyword>ctimeout</amkeyword> <amtype>int</amtype></term>
778 <amdefault>30 seconds</amdefault>.
779 Maximum amount of time that
780 <emphasis remap='B'>amcheck</emphasis>
781 will wait for each client host.</para>
785 <term><amkeyword>dtimeout</amkeyword> <amtype>int</amtype></term>
788 <amdefault>1800 seconds</amdefault>.
789 Amount of idle time per disk on a given client that a
790 <emphasis remap='B'>dumper</emphasis>
792 <command>amdump</command>
793 will wait before it fails with a data timeout error.</para>
798 <term><amkeyword>etimeout</amkeyword> <amtype>int</amtype></term>
801 <amdefault>300 seconds</amdefault>.
802 Amount of time per estimate on a given client that the
803 <emphasis remap='B'>planner</emphasis> step of
804 <command>amdump</command> will wait to get the dump size estimates
805 (note: Amanda runs up to 3 estimates for each DLE). For instance,
806 with the default of 300 seconds and four DLE's, each estimating level
807 0 and level 1 on client A, <emphasis remap='B'>planner</emphasis>
808 will wait up to 40 minutes for that machine. A negative value will
809 be interpreted as a total amount of time to wait
810 per client instead of per disk.</para>
815 <term><amkeyword>connect-tries</amkeyword> <amtype>int</amtype></term>
818 <amdefault>3</amdefault>.
819 How many times the server will try a connection.</para>
824 <term><amkeyword>req-tries</amkeyword> <amtype>int</amtype></term>
827 <amdefault>3</amdefault>.
828 How many times the server will resend a REQ packet if it doesn't get the ACK packet.</para>
833 <term><amkeyword>netusage</amkeyword> <amtype>int</amtype></term>
836 <amdefault>8000 Kbps</amdefault>.
837 The maximum network bandwidth allocated to Amanda, in Kbytes per second.
839 <emphasis remap='B'>interface</emphasis>
844 <term><amkeyword>inparallel</amkeyword> <amtype>int</amtype></term>
847 <amdefault>10</amdefault>.
848 The maximum number of backups that Amanda will attempt to run in parallel.
849 Amanda will stay within the constraints of network bandwidth and
850 holding disk space available, so it doesn't hurt to set
851 this number a bit high. Some contention can occur with larger numbers
852 of backups, but this effect is relatively small on most systems.</para>
857 <term><amkeyword>displayunit</amkeyword> "k|m|g|t"</term>
860 <amdefault>"k"</amdefault>.
861 The unit used to print many numbers, k=kilo, m=mega, g=giga, t=tera.
867 <term><amkeyword>dumporder</amkeyword> <amtype>string</amtype></term>
870 <amdefault>"tttTTTTTTT"</amdefault>.
871 The priority order of each dumper:
878 b: smallest bandwidth
880 </programlisting></para>
886 <term><amkeyword>maxdumps</amkeyword> <amtype>int</amtype></term>
889 <amdefault>1</amdefault>.
890 The maximum number of backups from a single host that Amanda will
891 attempt to run in parallel. See also the
892 <emphasis remap='B'>inparallel</emphasis>
895 <para>Note that this parameter may also be set in a specific
896 <amkeyword>dumptype</amkeyword>
898 This value sets the default for all
899 <amkeyword>dumptype</amkeyword>s
901 <emphasis remap='B'>amanda.conf</emphasis>
903 <amkeyword>dumptype</amkeyword>s
909 <term><amkeyword>bumpsize</amkeyword> <amtype>int</amtype></term>
912 <amdefault>10 Mbytes</amdefault>.
913 The minimum savings required to trigger an automatic
914 bump from one incremental level to the next, expressed as size.
915 If Amanda determines that the next higher backup level
916 will be this much smaller than the current level,
917 it will do the next level.
918 The value of this parameter is used only if the parameter
919 <emphasis>bumppercent</emphasis> is set to 0.
921 <para>The default unit is Kbytes if it is not specified.</para>
923 The global setting of this parameter can be overwritten inside of a
928 <amkeyword>bumppercent</amkeyword>,
929 <amkeyword>bumpmult</amkeyword> and
930 <amkeyword>bumpdays</amkeyword>.</para>
935 <term><amkeyword>bumppercent</amkeyword> <amtype>int</amtype></term>
938 <amdefault>0</amdefault>.
939 The minimum savings required to trigger an automatic
940 bump from one incremental level to the next, expressed as percentage of the
941 current size of the DLE (size of current level 0).
942 If Amanda determines that the next higher backup level
943 will be this much smaller than the current level,
944 it will do the next level.
947 If this parameter is set to 0, the value of the
948 parameter <emphasis>bumpsize</emphasis> is used to trigger bumping.
951 The global setting of this parameter can be overwritten inside of a
956 <amkeyword>bumpsize</amkeyword>,
957 <amkeyword>bumpmult</amkeyword> and
958 <amkeyword>bumpdays</amkeyword>.</para>
963 <term><amkeyword>bumpmult</amkeyword> <amtype>float</amtype></term>
966 <amdefault>1.5</amdefault>.
967 The bump size multiplier.
969 <amkeyword>bumpsize</amkeyword>
970 by this factor for each level.
971 This prevents active filesystems from
972 bumping too much by making it harder to bump to the next level.
973 For example, with the default
974 <amkeyword>bumpsize</amkeyword>
976 <amkeyword>bumpmult</amkeyword>
977 set to 2.0, the bump threshold will be 10 Mbytes for level one, 20
978 Mbytes for level two, 40 Mbytes for level three, and so on.</para>
980 The global setting of this parameter can be overwritten inside of a
986 <term><amkeyword>bumpdays</amkeyword> <amtype>int</amtype></term>
989 <amdefault>2 days</amdefault>.
990 To insure redundancy in the dumps, Amanda keeps filesystems at the
991 same incremental level for at least
992 <amkeyword>bumpdays</amkeyword>
993 days, even if the other bump threshold criteria are met.</para>
995 The global setting of this parameter can be overwritten inside of a
1002 <term><amkeyword>diskfile</amkeyword> <amtype>string</amtype></term>
1005 <amdefault>"disklist"</amdefault>.
1006 The file name for the
1007 <emphasis remap='I'>disklist</emphasis>
1008 file holding client hosts, disks and other client dumping information.</para>
1012 <term><amkeyword>infofile</amkeyword> <amtype>string</amtype></term>
1015 <amdefault>"/usr/adm/amanda/curinfo"</amdefault>.
1016 The file or directory name for the historical information database.
1017 If Amanda was configured to use DBM databases, this is the base file
1019 If it was configured to use text formated databases (the default),
1020 this is the base directory and within here will be a directory per
1021 client, then a directory per disk, then a text file of data.</para>
1025 <term><amkeyword>logdir</amkeyword> <amtype>string</amtype></term>
1028 <amdefault>"/usr/adm/amanda"</amdefault>.
1029 The directory for the
1030 <command>amdump</command>
1032 <emphasis remap='B'>log</emphasis>
1037 <term><amkeyword>indexdir</amkeyword> <amtype>string</amtype></term>
1040 <amdefault>"/usr/adm/amanda/index"</amdefault>.
1041 The directory where index files (backup image catalogues) are stored.
1043 only generated for filesystems whose
1044 <amkeyword>dumptype</amkeyword>
1046 <amkeyword>index</amkeyword>
1047 option enabled.</para>
1051 <term><amkeyword>tapelist</amkeyword> <amtype>string</amtype></term>
1054 <amdefault>"tapelist"</amdefault>.
1055 The file name for the active &tapelist;.
1056 Amanda maintains this file with information about the active set of tapes.</para>
1060 <term><amkeyword>device-output-buffer-size</amkeyword> <amtype>int</amtype></term>
1063 <amdefault>1280k</amdefault>.
1064 Controls the amount of memory used by Amanda
1065 to hold data as it is read from the network or disk before it is written to
1066 the output device. Higher values may be
1067 useful on fast tape drives and optical media.</para>
1068 <para>The default unit is bytes if it is not specified.</para>
1072 <term><amkeyword>tapebufs</amkeyword> <amtype>int</amtype></term>
1075 <amdefault>20</amdefault>.
1076 This option is deprecated; use
1077 the <amkeyword>device-output-buffer-size</amkeyword> directive
1078 instead. <amkeyword>tapebufs</amkeyword> works the same way,
1079 but the number specified is multiplied by the device blocksize prior
1084 <term><amkeyword>reserve</amkeyword> <amtype>int</amtype></term>
1087 <amdefault>100</amdefault>.
1088 The part of holding-disk space that should be reserved for incremental
1089 backups if no tape is available, expressed as a percentage of the
1090 available holding-disk space (0-100).
1091 By default, when there is no tape to write to, degraded mode (incremental) backups
1092 will be performed to the holding disk. If full backups should also be allowed in this case,
1093 the amount of holding disk space reserved for incrementals should be lowered.</para>
1097 <term><amkeyword>autoflush</amkeyword> <amkeyword>no</amkeyword>|<amkeyword>yes</amkeyword>|<amkeyword>all</amkeyword></term>
1100 <amkeyword>no</amkeyword>.
1101 Whether an amdump run will flush the dumps from holding disk to tape.
1102 With <amkeyword>yes</amkeyword>, only dump matching the command line argument are flushed.
1103 With <amkeyword>all</amkeyword>, all dump are flushed.</para>
1107 <term><amkeyword>amrecover-do-fsf</amkeyword> <amtype>bool</amtype></term>
1109 <para>Deprecated; amrecover always uses fsf, and does not invoke amrestore.</para>
1111 <amkeyword>on</amkeyword>.
1112 Amrecover will call amrestore with the -f flag for faster positioning of the tape.</para>
1116 <term><amkeyword>amrecover-check-label</amkeyword> <amtype>bool</amtype></term>
1118 <para>Deprecated; amrecover always checks the label, and does not invoke amrestore.</para>
1120 <amkeyword>on</amkeyword>.
1121 Amrecover will call amrestore with the -l flag to check the label.</para>
1125 <term><amkeyword>amrecover-changer</amkeyword> <amtype>string</amtype></term>
1127 <para>Default: not set.
1128 Amrecover will use the changer if you use 'settape <string>' and that string
1129 is the same as the <amkeyword>amrecover-changer</amkeyword> setting.</para>
1133 <term><amkeyword>columnspec</amkeyword> <amtype>string</amtype></term>
1135 <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>
1136 <para>Defines the width of columns <emphasis remap='B'>amreport</emphasis>
1138 <emphasis remap='I'>String</emphasis>
1139 is a comma (',') separated list of triples. Each triple consists
1140 of three parts which are separated by a equal sign ('=') and a colon (':') (see the example).
1141 These four parts specify:
1145 <para>the name of the column, which may be:
1148 Compress (compression ratio)
1149 Disk (client disk name)
1150 DumpRate (dump rate in KBytes/sec)
1151 DumpTime (total dump time in hours:minutes)
1152 HostName (client host name)
1154 OrigKB (original image size in KBytes)
1155 OutKB (output image size in KBytes)
1156 TapeRate (tape writing rate in KBytes/sec)
1157 TapeTime (total tape time in hours:minutes)
1158 </programlisting></para>
1163 <para>the amount of space to display before the column (used to get whitespace between columns).</para>
1166 <para>the width of the column itself.
1167 If set to a negative value, the width will be calculated on demand to fit the largest entry in
1171 <para>the precision of the column, number of digit after the decimal point for number.</para>
1173 </orderedlist></para>
1175 <para>Here is an example:
1177 columnspec "Disk=1:18,HostName=0:10,OrigKB=::2,OutKB=1:7"
1178 </programlisting></para>
1180 The above will display the disk information in 18 characters
1181 and put one space before it. The hostname column will be 10 characters wide with
1182 no space to the left. The Original KBytes print 2 decimal digit. The output KBytes column is seven characters wide
1183 with one space before it.</para>
1188 <term><amkeyword>includefile</amkeyword> <amtype>string</amtype></term>
1191 <amdefault>no default</amdefault>.
1192 The name of an Amanda configuration file to include within the current file.
1193 Useful for sharing dumptypes, tapetypes and interface definitions among several configurations.
1194 Relative pathnames are relative to the configuration directory.
1200 <term><amkeyword>debug-days</amkeyword> <amtype>int</amtype></term>
1203 <amdefault>3</amdefault>.
1204 The number of days the debug files are kept.</para>
1209 <term><amkeyword>debug-auth</amkeyword> <amtype>int</amtype></term>
1212 <amdefault>0</amdefault>.
1213 Debug level of the auth module</para>
1218 <term><amkeyword>debug-event</amkeyword> <amtype>int</amtype></term>
1221 <amdefault>0</amdefault>.
1222 Debug level of the event module</para>
1227 <term><amkeyword>debug-holding</amkeyword> <amtype>int</amtype></term>
1230 <amdefault>0</amdefault>.
1231 Debug level of the holdingdisk module</para>
1236 <term><amkeyword>debug-protocol</amkeyword> <amtype>int</amtype></term>
1239 <amdefault>0</amdefault>.
1240 Debug level of the protocol module</para>
1245 <term><amkeyword>debug-planner</amkeyword> <amtype>int</amtype></term>
1248 <amdefault>0</amdefault>.
1249 Debug level of the planner process</para>
1254 <term><amkeyword>debug-driver</amkeyword> <amtype>int</amtype></term>
1257 <amdefault>0</amdefault>.
1258 Debug level of the driver process</para>
1263 <term><amkeyword>debug-dumper</amkeyword> <amtype>int</amtype></term>
1266 <amdefault>0</amdefault>.
1267 Debug level of the dumper process</para>
1272 <term><amkeyword>debug-chunker</amkeyword> <amtype>int</amtype></term>
1275 <amdefault>0</amdefault>.
1276 Debug level of the chunker process</para>
1281 <term><amkeyword>debug-taper</amkeyword> <amtype>int</amtype></term>
1284 <amdefault>0</amdefault>.
1285 Debug level of the taper process</para>
1290 <term><amkeyword>debug-recovery</amkeyword> <amtype>int</amtype></term>
1293 <amdefault>1</amdefault>.
1294 Debug level of all recovery process</para>
1299 <term><amkeyword>flush-threshold-dumped</amkeyword> <amtype>int</amtype></term>
1301 <para>Default: <amdefault>0</amdefault>.
1302 Amanda will not begin writing data to a new volume until the amount of
1303 data on the holding disk is at least this percentage of the volume
1304 size. In other words, Amanda will not begin until the
1305 amount of data on the holding disk is greater than the tape
1306 length times this parameter.
1307 This parameter may be larger than 100%, for example to keep
1308 more recent dumps on the holding disk for faster recovery.</para>
1309 <para> Needless to say, your holding disk must be big enough
1310 that this criterion could be satisfied. If the holding disk cannot
1311 be used for a particular dump (because, for example, there is no
1312 remaining holding space) then Amanda will disregard the constraint
1313 specified by this setting and start a new volume anyway. Once
1314 writing to a volume has begun, this constraint is not applied unless
1315 and until a new volume is needed.</para>
1316 <para> The value of this parameter may not exceed than that of
1317 the <amkeyword>flush-threshold-scheduled</amkeyword>
1323 <term><amkeyword>flush-threshold-scheduled</amkeyword> <amtype>int</amtype></term>
1325 <para>Default: <amdefault>0</amdefault>.
1326 Amanda will not begin writing data to a new volume until the sum of the
1327 amount of data on the holding disk and the estimated amount of data
1328 remaining to be dumped during this run is at least this percentage
1329 of the volume size. In other words, Amanda will not begin until the
1330 inequality <inlineequation><mathphrase>h + s > t ×
1331 d</mathphrase></inlineequation> is satisfied,
1332 where <mathphrase>h</mathphrase> is the amount of data on the
1333 holding disk, <mathphrase>s</mathphrase> is the total amount of
1334 data scheduled for this run but not dumped
1335 yet, <mathphrase>t</mathphrase> is the capacity of a volume,
1336 and <mathphrase>d</mathphrase> is this parameter, expressed as a
1337 percentage. This parameter may be larger than 100%.</para>
1338 <para> Needless to say, your holding disk must be big enough
1339 that this criterion could be satisfied. If the holding disk cannot
1340 be used for a particular dump (because, for example, there is no
1341 remaining holding space) then Amanda will disregard the constraint
1342 specified by this setting and start a new volume anyway. Once
1343 writing to a volume has begun, this constraint is not applied unless
1344 and until a new volume is needed.</para>
1345 <para> The value of this parameter may not be less than that of
1346 the <amkeyword>flush-threshold-dumped</amkeyword>
1347 or <amkeyword>taperflush</amkeyword> parameters.</para>
1351 <!-- the entity '#215' below is U+00D7 MULTIPLICATION SIGN; the 'times' entity
1352 is not as portable as one might hope. -->
1354 <term><amkeyword>taperflush</amkeyword> <amtype>int</amtype></term>
1356 <para>Default: <amdefault>0</amdefault>.
1357 At the end of a run, Amanda will start a new tape to flush remaining
1358 data if there is more data on the holding disk at the end of a run
1359 than this setting allows; the amount is specified as a percentage of
1360 the capacity of a single
1361 volume. In other words, at the end of a run, Amanda will begin
1363 inequality <inlineequation><mathphrase>h > t ×
1364 f</mathphrase></inlineequation> is satisfied,
1365 where <mathphrase>h</mathphrase> is the amount of data remaining on the
1366 holding disk from this or previous runs, <mathphrase>t</mathphrase>
1367 is the capacity of a volume,
1368 and <mathphrase>f</mathphrase> is this parameter, expressed as a
1369 percentage. This parameter may be greater than 100%.</para>
1370 <para> The value of this parameter may not exceed that of
1371 the <amkeyword>flush-threshold-scheduled</amkeyword>
1372 parameter.; <amkeyword>autoflush</amkeyword> must be set to 'yes' if
1373 <amkeyword>taperflush</amkeyword> is greater than 0.</para>
1378 <term><amkeyword>reserved-udp-port</amkeyword> <amtype>int</amtype>,<amtype>int</amtype></term>
1380 <para>Default: --with-udpportrange or
1381 <amdefault>512,1023</amdefault>.
1382 Reserved udp port that will be used (bsd, bsdudp).
1383 Range is inclusive.</para>
1388 <term><amkeyword>reserved-tcp-port</amkeyword> <amtype>int</amtype>,<amtype>int</amtype></term>
1390 <para>Default: --with-low-tcpportrange or
1391 <amdefault>512,1023</amdefault>.
1392 Reserved tcp port that will be used (bsdtcp).
1393 Range is inclusive.</para>
1398 <term><amkeyword>unreserved-tcp-port</amkeyword> <amtype>int</amtype>,<amtype>int</amtype></term>
1400 <para>Default: --with-tcpportrange or
1401 <amdefault>1024,65535</amdefault>.
1402 Unreserved tcp port that will be used (bsd, bsdudp).
1403 Range is inclusive.</para>
1408 <term><amkeyword>recovery-limit</amkeyword> [ <amtype>string</amtype> | <amkeyword>same-host</amkeyword> | <amkeyword>server</amkeyword>]</term>
1410 <para>Default: none (no limitations). This parameter limits the hosts
1411 that may do recoveries. Hosts are identified by their authenticated
1412 peer name, as described in <manref name="amanda-auth" vol="7"/>; if this is
1413 not available and the recovery-limit parameter is present, recovery will be
1414 denied. The arguments to the parameter are strings giving host match
1415 expressions (see <manref name="amanda-match" vol="7"/>) or the special
1416 keywords <amkeyword>same-host</amkeyword> or <amkeyword>server</amkeyword>.
1417 The <amkeyword>same-host</amkeyword> keyword requires an exact
1418 match to the hostname of the DLE being recovered.
1419 The <amkeyword>server</amkeyword> keyword require the connection come from
1420 the fqdn of the server.
1421 Specifying no arguments at all will disable all
1422 recoveries from any host.</para>
1424 <para>Note that match expressions can be constructed to be
1425 forgiving of e.g., fully-qualified vs. unqualified hostnames, but
1426 <amkeyword>same-host</amkeyword> requires an exact match.</para>
1428 <para>The error messages that appear in amrecover are intentionally vague to
1429 avoid information leakage. Consult the amindexd debug log for more details
1430 on the reasons a recovery was rejected.</para>
1432 <para>Recovery limits can be refined on a per-DLE basis using the dumptype
1433 parameter of the same name. Note that the default value will apply to any
1434 dumpfiles for disks which no longer appear in the disklist; thus leaving the
1435 global parameter at its default value but setting it for all DLEs is not
1436 sufficient to maintain secure backups.</para>
1444 <refsect1><title>HOLDINGDISK SECTION</title>
1445 <para>The <emphasis remap='B'>amanda.conf</emphasis>
1446 file may define one or more holding disks used as buffers to hold
1447 backup images before they are written to tape.
1448 The syntax is:</para>
1451 define holdingdisk <emphasis remap='I'>name</emphasis> {
1452 <emphasis remap='I'>holdingdisk-option</emphasis> <emphasis remap='I'>holdingdisk-value</emphasis>
1453 <literal>...</literal>
1457 <para>The { must appear at the end of a line, and the } on its own line.</para>
1458 <para><emphasis remap='I'>Name</emphasis>
1459 is a logical name for this holding disk.</para>
1461 <para>The options and values are:</para>
1463 <variablelist remap='TP'>
1465 <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
1467 <para>Default: not set.
1468 A comment string describing this holding disk.</para>
1473 <term><amkeyword>directory</amkeyword> <amtype>string</amtype></term>
1476 <amdefault>"/dumps/amanda"</amdefault>.
1477 The path to this holding area.</para>
1482 <term><amkeyword>use</amkeyword> <amtype>int</amtype></term>
1485 <amdefault>0 Gb</amdefault>.
1486 Amount of space that can be used in this holding disk area.
1487 If the value is zero, all available space on the file system is used.
1488 If the value is negative, Amanda will use all available space minus that value.</para>
1493 <term><amkeyword>chunksize</amkeyword> <amtype>int</amtype></term>
1496 <amdefault>1 Gb</amdefault>.
1497 Holding disk chunk size. Dumps larger than the specified size will be stored in multiple
1498 holding disk files. The size of each chunk will not exceed the specified value.
1499 However, even though dump images are split in the holding disk, they are concatenated as
1500 they are written to tape, so each dump image still corresponds to a single continuous
1501 tape section.</para>
1502 <para>The default unit is Kbytes if it is not specified.</para>
1504 <para>If 0 is specified, Amanda will create holding disk chunks as large as
1505 ((INT_MAX/1024)-64) Kbytes.</para>
1507 <para>Each holding disk chunk includes a 32 Kbyte header, so the minimum
1508 chunk size is 64 Kbytes (but that would be really silly).</para>
1510 <para>Operating systems that are limited to a maximum file size of 2 Gbytes
1511 actually cannot handle files that large.
1512 They must be at least one byte less than 2 Gbytes.
1513 Since Amanda works with 32 Kbyte blocks, and
1514 to handle the final read at the end of the chunk, the chunk size
1515 should be at least 64 Kbytes (2 * 32 Kbytes) smaller than the maximum
1516 file size, e.g. 2047 Mbytes.</para>
1522 <refsect1><title>DUMPTYPE SECTION</title>
1523 <para>The &amconf; file may define multiple sets of backup options
1524 and refer to them by name from the &disklist; file.
1525 For instance, one set of options might be defined for file systems
1526 that can benefit from high compression, another set that does not compress well,
1527 another set for file systems that should always get a full backup and so on.</para>
1529 <para>A set of backup options are entered in a
1530 <amkeyword>dumptype</amkeyword>
1531 section, which looks like this:</para>
1534 define dumptype "<emphasis remap='I'>name</emphasis>" {
1535 <emphasis remap='I'>dumptype-option</emphasis> <emphasis remap='I'>dumptype-value</emphasis>
1536 <literal>...</literal>
1540 <para>The { must appear at the end of a line, and the } on its own line.</para>
1541 <para><emphasis remap='I'>Name</emphasis>
1542 is the name of this set of backup options.
1543 It is referenced from the &disklist; file.</para>
1545 <para>Some of the options in a
1546 <amkeyword>dumptype</amkeyword>
1547 section are the same as those in the main part of &amconf;.
1548 The main option value is used to set the default for all
1549 <amkeyword>dumptype</amkeyword>
1550 sections. For instance, setting
1551 <amkeyword>dumpcycle</amkeyword>
1552 to 50 in the main part of the config file causes all following
1553 <amkeyword>dumptype</amkeyword>
1554 sections to start with that value,
1555 but the value may be changed on a section by section basis.
1556 Changes to variables in the main part of the config file must be
1557 done before (earlier in the file) any
1558 <amkeyword>dumptype</amkeyword>s
1561 <para>The dumptype options and values are:</para>
1563 <variablelist remap='TP'>
1565 <term><amkeyword>auth</amkeyword> <amtype>string</amtype></term>
1568 <amdefault>"bsdtcp"</amdefault>.
1569 Type of authorization to perform between tape server and backup client hosts. See <manref name="amanda-auth" vol="7"/> for more detail.</para>
1574 <term><amkeyword>amandad-path</amkeyword> <amtype>string</amtype></term>
1577 <amdefault>"$libexec/amandad"</amdefault>.
1578 Specify the amandad path of the client, only use with rsh/ssh authentification.
1584 <term><amkeyword>client-username</amkeyword> <amtype>string</amtype></term>
1587 <amdefault>CLIENT_LOGIN</amdefault>.
1588 Specify the username to connect on the client, only use with rsh/ssh authentification.
1594 <term><amkeyword>client-port</amkeyword> [ <amtype>int</amtype> | <amtype>string</amtype> ]</term>
1597 <amdefault>"amanda"</amdefault>.
1598 Specifies the port to connect to on the client. It can be a service name or a numeric port number.
1604 <!-- bumping parameters yanked from the global section above -->
1607 <term><amkeyword>bumpsize</amkeyword> <amtype>int</amtype></term>
1610 <amdefault>10 Mbytes</amdefault>.
1611 The minimum savings required to trigger an automatic
1612 bump from one incremental level to the next, expressed as size.
1613 If Amanda determines that the next higher backup level
1614 will be this much smaller than the current level,
1615 it will do the next level.
1616 The value of this parameter is used only if the parameter
1617 <emphasis>bumppercent</emphasis> is set to 0.
1619 <para>The default unit is Kbytes if it is not specified.</para>
1621 See also the options
1622 <amkeyword>bumppercent</amkeyword>,
1623 <amkeyword>bumpmult</amkeyword> and
1624 <amkeyword>bumpdays</amkeyword>.</para>
1629 <term><amkeyword>bumppercent</amkeyword> <amtype>int</amtype></term>
1632 <amdefault>0</amdefault>.
1633 The minimum savings required to trigger an automatic
1634 bump from one incremental level to the next, expressed as percentage of the
1635 current size of the DLE (size of current level 0).
1636 If Amanda determines that the next higher backup level
1637 will be this much smaller than the current level,
1638 it will do the next level.
1641 If this parameter is set to 0, the value of the
1642 parameter <emphasis>bumpsize</emphasis> is used to trigger bumping.
1645 See also the options
1646 <amkeyword>bumpsize</amkeyword>,
1647 <amkeyword>bumpmult</amkeyword> and
1648 <amkeyword>bumpdays</amkeyword>.</para>
1653 <term><amkeyword>bumpmult</amkeyword> <amtype>float</amtype></term>
1656 <amdefault>1.5</amdefault>.
1657 The bump size multiplier.
1659 <amkeyword>bumpsize</amkeyword>
1660 by this factor for each level.
1661 This prevents active filesystems from
1662 bumping too much by making it harder to bump to the next level.
1663 For example, with the default
1664 <amkeyword>bumpsize</amkeyword>
1666 <amkeyword>bumpmult</amkeyword>
1667 set to 2.0, the bump threshold will be 10 Mbytes for level one, 20
1668 Mbytes for level two, 40 Mbytes for level three, and so on.</para>
1672 <term><amkeyword>bumpdays</amkeyword> <amtype>int</amtype></term>
1675 <amdefault>2 days</amdefault>.
1676 To insure redundancy in the dumps, Amanda keeps filesystems at the
1677 same incremental level for at least
1678 <amkeyword>bumpdays</amkeyword>
1679 days, even if the other bump threshold criteria are met.</para>
1684 <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
1686 <para>Default: not set.
1687 A comment string describing this set of backup options.</para>
1691 <term><amkeyword>comprate</amkeyword> <amtype>float</amtype> [, <amtype>float</amtype> ]</term>
1694 <amdefault>0.50, 0.50</amdefault>.
1695 The expected full and incremental compression factor for dumps.
1696 It is only used if Amanda does not have any history information on
1697 compression rates for a filesystem, so should not usually need to be set.
1698 However, it may be useful for the first time a very large filesystem that
1699 compresses very little is backed up.</para>
1703 <term><amkeyword>compress</amkeyword> [ <amkeyword>none</amkeyword> | <amkeyword>client</amkeyword> | <amkeyword>server</amkeyword> ] [ <amkeyword>best</amkeyword> | <amkeyword>fast</amkeyword> | <amkeyword>custom</amkeyword> ]</term>
1706 <amkeyword>client fast</amkeyword>.
1707 If Amanda does compression of the backup images, it can do so either on the backup client
1708 host before it crosses the network or on the tape server host as it goes from the
1709 network into the holding disk or to tape. Which place to do compression (if at all) depends on how well the
1710 dump image usually compresses, the speed and load on the client or server, network capacity,
1711 holding disk capacity, availability of tape hardware compression, etc.</para>
1713 <para>For either type of compression, Amanda also allows the selection
1714 of three styles of compression.
1715 <amkeyword>best</amkeyword>
1716 is the best compression available, often at the expense of CPU overhead.
1717 <amkeyword>fast</amkeyword>
1718 is often not as good a compression as
1719 <amkeyword>best</amkeyword>,
1720 but usually less CPU overhead. Or to specify <amkeyword>custom</amkeyword>
1721 to use your own compression method. (See dumptype custom-compress in example/amanda.conf for reference)</para>
1723 <para>So the <amkeyword>compress</amkeyword> options line may be one of:</para>
1725 <variablelist remap='TP'>
1727 <term>compress none</term><listitem><para/></listitem>
1730 <term>compress client fast</term><listitem><para/></listitem>
1733 <term>compress client best</term><listitem><para/></listitem>
1736 <term>compress client custom</term>
1738 <para>Specify <amkeyword>client-custom-compress</amkeyword> "PROG"</para>
1739 <para>PROG must not contain white space and it must accept -d for uncompress.</para>
1743 <term>compress server fast</term><listitem><para/></listitem>
1746 <term>compress server best</term><listitem><para/></listitem>
1749 <term>compress server custom</term>
1751 <para>Specify <amkeyword>server-custom-compress</amkeyword> "PROG"</para>
1752 <para>PROG must not contain white space and it must accept -d for uncompress.</para>
1756 <para>Note that some tape devices do compression and this option has nothing
1757 to do with whether that is used. If hardware compression is used (usually via a particular tape device name
1758 or <emphasis remap='B'>mt</emphasis> option), Amanda (software) compression should be disabled.</para>
1763 <term><amkeyword>client-custom-compress</amkeyword> <amtype>string</amtype></term>
1765 <para>Default: none.
1766 The program to use to perform compression/decompression on the client; used with
1767 "compress client custom". Must not contain whitespace. Must accept -d to uncompress.</para>
1772 <term><amkeyword>server-custom-compress</amkeyword> <amtype>string</amtype></term>
1774 <para>Default: none.
1775 The program to use to perform compression/decompression on the server; used with
1776 "compress server custom". Must not contain whitespace. Must accept -d to uncompress.</para>
1781 <term><amkeyword>dumpcycle</amkeyword> <amtype>int</amtype></term>
1783 <para>Default: <amdefault>10 days</amdefault>.
1784 The number of days in the backup cycle. Each disk using this set of options will get a full
1785 backup at least this of
1786 ten. Setting this to zero tries to do a full backup each run.</para>
1791 <term><amkeyword>encrypt</amkeyword> [ <amkeyword>none</amkeyword> | <amkeyword>client</amkeyword> | <amkeyword>server</amkeyword> ]</term>
1793 <para>Default: not set.
1794 To encrypt backup images, it can do so either on the backup client host before it crosses the network or on the tape
1795 server host as it goes from the network into the holding disk or to tape.</para>
1797 <para>So the <amkeyword>encrypt</amkeyword> options line may be one
1800 <variablelist remap='TP'>
1802 <term>encrypt none</term><listitem><para/></listitem>
1805 <term>encrypt client</term>
1807 <para>Specify client-encrypt "PROG"</para>
1808 <para>PROG must not contain white space.</para>
1809 <para>Specify client-decrypt-option "decryption-parameter" Default: "-d"</para>
1810 <para>decryption-parameter must not contain white space.</para>
1811 <para>(See dumptype client-encrypt-nocomp in example/amanda.conf for reference)</para>
1815 <term>encrypt server</term>
1817 <para>Specify server-encrypt "PROG"</para>
1818 <para>PROG must not contain white space.</para>
1819 <para>Specify server-decrypt-option "decryption-parameter" Default: "-d"</para>
1820 <para>decryption-parameter must not contain white space.</para>
1821 <para>(See dumptype server-encrypt-fast in example/amanda.conf for reference)</para>
1825 <para>Note that current logic assumes compression then encryption during
1826 backup(thus decrypt then uncompress during restore). So specifying
1827 client-encryption AND server-compression is not supported.
1828 <emphasis remap='I'>amcrypt</emphasis> which is a wrapper of
1829 <emphasis remap='I'>aespipe</emphasis> is provided as a reference
1830 symmetric encryption program.</para>
1835 <term><amkeyword>client-encrypt</amkeyword> <amtype>string</amtype></term>
1837 <para>Default: none.
1838 The program to use to perform encryption/decryption on the client; used with
1839 "encrypt client". Must not contain whitespace.</para>
1844 <term><amkeyword>client-decrypt-option</amkeyword> <amtype>string</amtype></term>
1847 The option that can be passed to client-encrypt to make it decrypt instead.
1848 Must not contain whitespace.</para>
1853 <term><amkeyword>server-encrypt</amkeyword> <amtype>string</amtype></term>
1855 <para>Default: none.
1856 The program to use to perform encryption/decryption on the server; used with
1857 "encrypt server". Must not contain whitespace.</para>
1862 <term><amkeyword>server-decrypt-option</amkeyword> <amtype>string</amtype></term>
1865 The option that can be passed to server-encrypt to make it decrypt instead.
1866 Must not contain whitespace.</para>
1871 <term><amkeyword>estimate</amkeyword> [ <amkeyword>client</amkeyword> | <amkeyword>calcsize</amkeyword> | <amkeyword>server</amkeyword> ]+</term>
1873 <para>Default: <amkeyword>client</amkeyword>.
1874 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>
1875 <variablelist remap='TP'>
1879 <para>Use the same program as the dumping program. This is the most
1880 accurate method to do estimates, but it can take a long time.</para>
1884 <term>calcsize</term>
1886 <para>Use a faster program to do estimates, but the result is less
1893 <para>Use only statistics from the previous few runs to give an estimate.
1894 This very quick, but the result is not accurate if your disk
1895 usage changes from day to day. If this method is specified, but the
1896 server does not have enough data to make an estimate, then the option
1897 is internally moved to the end of the list, thereby preferring 'client'
1898 or 'calcsize' in this case.</para>
1907 <term><amkeyword>exclude</amkeyword> [ <amkeyword>list</amkeyword> | <amkeyword>file</amkeyword> ][[<amkeyword>optional</amkeyword>][<amkeyword>append</amkeyword>][ <amtype>string</amtype> ]+]</term>
1910 <amkeyword>file</amkeyword>. Exclude is the opposite of
1911 <amkeyword>include</amkeyword> and specifies files that will be excluded from
1912 the backup. The format of the exclude expressions depends on the application,
1913 and some applications do not support excluding files at all.</para>
1915 <para>There are two exclude parameters,
1916 <amkeyword>exclude</amkeyword> <amkeyword>file</amkeyword>
1918 <amkeyword>exclude</amkeyword> <amkeyword>list.</amkeyword>
1920 <amkeyword>exclude</amkeyword> <amkeyword>file</amkeyword>, the
1921 <amtype>string</amtype>
1922 is an exclude expression. With
1923 <amkeyword>exclude</amkeyword> <amkeyword>list</amkeyword>
1925 <amtype>string</amtype>
1926 is a file name on the client containing &gnutar; exclude expressions.
1927 The path to the specified exclude list file, if present (see description of
1928 'optional' below), must be readable by the Amanda user.</para>
1930 <para>All exclude expressions are concatenated in one file and passed to the
1931 application as an <option>--exclude-from</option> argument.</para>
1933 <para>For &gnutar;, exclude expressions must always be specified as relative to the
1934 top-level directory of the DLE, and must start with "./". See the manpages for individual
1935 applications for more information on supported exclude expressions.</para>
1938 <amkeyword>append</amkeyword> keyword, the
1939 <amtype>string</amtype> is appended to the current list, without it, the
1940 <amtype>string</amtype> overwrites the list.</para>
1942 <para>If <amkeyword>optional</amkeyword>
1943 is specified for <amkeyword>exclude</amkeyword> <amkeyword>list</amkeyword>,
1944 then amcheck will not complain if the file doesn't exist or is not readable.</para>
1946 <para>For <amkeyword>exclude</amkeyword> <amkeyword>list</amkeyword>,
1947 if the file name is relative, the disk name being backed up is prepended.
1948 So if this is entered:</para>
1951 exclude list ".amanda.excludes"
1954 <para>the actual file used would be
1955 <filename>/var/.amanda.excludes</filename>
1956 for a backup of <filename>/var</filename>,
1957 <filename>/usr/local/.amanda.excludes</filename> for a backup of
1958 <filename>/usr/local</filename>, and so on.</para>
1963 <term><amkeyword>holdingdisk</amkeyword> [ <amkeyword>never</amkeyword> | <amkeyword>auto</amkeyword> | <amkeyword>required</amkeyword> ]</term>
1966 <amkeyword>auto</amkeyword>.
1967 Whether a holding disk should be used for these backups or whether they should go directly to tape.
1968 If the holding disk is a portion of another file system that Amanda
1969 is backing up, that file system should refer to a dumptype with
1970 <amkeyword>holdingdisk</amkeyword>
1972 <emphasis remap='I'>never</emphasis>
1973 to avoid backing up the holding disk into itself.</para>
1975 <variablelist remap='TP'>
1977 <term><amkeyword>never</amkeyword>|no|false|off</term>
1979 <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>
1983 <term><amkeyword>auto</amkeyword>|yes|true|on</term>
1985 <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>
1989 <term><amkeyword>required</amkeyword></term>
1991 <para>Always dump to holdingdisk, never directly to tape. There will be no dump if it doesn't fit on holdingdisk</para>
2000 <term><amkeyword>ignore</amkeyword> <amtype>boolean</amtype></term>
2003 <amkeyword>no</amkeyword>.
2004 Whether disks associated with this backup type should be backed up or not.
2005 This option is useful when the
2006 <emphasis remap='I'>disklist</emphasis>
2007 file is shared among several configurations,
2008 some of which should not back up all the listed file systems.</para>
2012 <term><amkeyword>include</amkeyword> [ <amkeyword>list</amkeyword> | <amkeyword>file</amkeyword> ][[<amkeyword>optional</amkeyword>][<amkeyword>append</amkeyword>][ <amtype>string</amtype> ]+]</term>
2015 <amkeyword>file</amkeyword>
2017 There are two include lists,
2018 <amkeyword>include file</amkeyword>
2020 <amkeyword>include list.</amkeyword>
2022 <amkeyword>include file</amkeyword>
2024 <amtype>string</amtype>
2025 is a glob expression. With
2026 <amkeyword>include list</amkeyword>
2028 <amtype>string</amtype>
2029 is a file name on the client containing glob expressions.</para>
2031 <para>All include expressions are expanded by Amanda, concatenated in one file and passed to &gnutar; as a
2032 <option>--files-from</option> argument. They must start with "./" and contain no other "/".</para>
2034 <para>Include expressions must always be specified as relative to the
2035 head directory of the DLE.</para>
2037 <note><para>For globbing to work at all, even the limited single level,
2038 the top level directory of the DLE must be readable by the Amanda user.</para>
2041 <para>With the <amkeyword>append</amkeyword> keyword, the
2042 <amtype>string</amtype> is appended to the current list, without it, the
2043 <amtype>string</amtype> overwrites the list.</para>
2046 <amkeyword>optional</amkeyword> is specified for
2047 <amkeyword>include list</amkeyword>, then amcheck will not complain if the file
2048 doesn't exist or is not readable.</para>
2050 <para>For <amkeyword>include list</amkeyword>,
2051 If the file name is relative, the disk name being backed up is prepended.</para>
2056 <term><amkeyword>index</amkeyword> <amtype>boolean</amtype></term>
2058 <para>Default: <amkeyword>no</amkeyword>.
2059 Whether an index (catalogue) of the backup should be generated and saved in
2060 <amkeyword>indexdir</amkeyword>.
2061 These catalogues are used by the <emphasis remap='B'>amrecover</emphasis> utility.</para>
2066 <term><amkeyword>kencrypt</amkeyword> <amtype>boolean</amtype></term>
2069 <amkeyword>no</amkeyword>.
2070 Whether the backup image should be encrypted by Kerberos as it is sent
2071 across the network from the backup client host to the tape server host.</para>
2075 <term><amkeyword>maxdumps</amkeyword> <amtype>int</amtype></term>
2078 <amdefault>1</amdefault>.
2079 The maximum number of backups from a single host that Amanda will attempt to run in parallel.
2080 See also the main section parameter <amkeyword>inparallel</amkeyword>.</para>
2084 <term><amkeyword>maxpromoteday</amkeyword> <amtype>int</amtype></term>
2087 <amdefault>10000</amdefault>.
2088 The maximum number of day for a promotion, set it 0 if you don't want
2089 promotion, set it to 1 or 2 if your disks get overpromoted.</para>
2093 <term><amkeyword>priority</amkeyword> [ <amkeyword>low</amkeyword> | <amkeyword>medium</amkeyword> | <amkeyword>high</amkeyword> ]</term>
2095 <para>Default: <amkeyword>medium</amkeyword>.
2096 When there is no tape to write to, Amanda will do incremental backups
2097 in priority order to the holding disk. The priority may be
2098 high (2), medium (1), low (0) or a number of your choice.</para>
2102 <term><amkeyword>program</amkeyword> [ <amkeyword>"DUMP"</amkeyword> | <amkeyword>"GNUTAR"</amkeyword> | <amkeyword>"APPLICATION"</amkeyword> ]</term>
2105 <amdefault>"DUMP"</amdefault>.
2106 The type of backup to perform. Valid values are:</para>
2108 <variablelist remap='TP'>
2110 <term><amkeyword>"DUMP"</amkeyword></term>
2112 <para>The native operating system backup program.</para>
2116 <term><amkeyword>"GNUTAR"</amkeyword></term>
2118 <para>To use GNU-tar or to do PC backups using Samba.</para>
2122 <term><amkeyword>"APPLICATION"</amkeyword></term>
2124 <para>To use an application, see the <emphasis>application</emphasis> option.</para>
2131 <term><amkeyword>application</amkeyword> <amtype>string</amtype></term>
2133 <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>
2137 <term><amkeyword>script</amkeyword> <amtype>string</amtype></term>
2139 <para>No default. Must be the name of a script. You can have many script. See SCRIPT SECTION below.</para>
2143 <term><amkeyword>property</amkeyword> [<amkeyword>append</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
2145 <para>These options can set various properties, they can be used by third
2146 party software to store information in the configuration file.
2147 Both strings are quoted; the first string contains the name of
2148 the property to set, and the others contains its values.
2149 <amkeyword>append</amkeyword> keyword append the values to the list of values for that property.
2155 <term><amkeyword>record</amkeyword> <amtype>boolean</amtype></term>
2158 <amkeyword>yes</amkeyword>.
2159 Whether to ask the backup program to update its database (e.g. <filename>/etc/dumpdates</filename>
2160 for DUMP or <filename>/usr/local/var/amanda/gnutar-lists</filename> for GNUTAR) of time stamps.
2161 This is normally enabled for daily backups and turned off for periodic archival runs.</para>
2165 <term><amkeyword>skip-full</amkeyword> <amtype>boolean</amtype></term>
2168 <amkeyword>no</amkeyword>. If <amkeyword>true</amkeyword> and
2169 <emphasis remap='B'>planner</emphasis> has scheduled a full backup, these disks will be skipped, and
2170 full backups should be run off-line on these days. It was reported that Amanda only schedules
2171 level 1 incrementals in this configuration; this is probably a bug.</para>
2175 <term><amkeyword>skip-incr</amkeyword> <amtype>boolean</amtype></term>
2178 <amkeyword>no</amkeyword>. If <amkeyword>true</amkeyword> and
2179 <emphasis remap='B'>planner</emphasis> has scheduled an incremental backup, these disks will be skipped.</para>
2183 <term><amkeyword>ssh-keys</amkeyword> <amtype>string</amtype></term>
2185 <para>Default: not set.
2186 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>
2190 <term><amkeyword>starttime</amkeyword> <amtype>int</amtype></term>
2192 <para>Default: not set.
2193 Backup of these disks will not start until after this time of day.
2194 The value should be hh*100+mm, e.g. 6:30PM (18:30) would be entered as
2195 <literal>1830</literal>.</para>
2199 <term><amkeyword>strategy</amkeyword> [ <amkeyword>standard</amkeyword> | <amkeyword>nofull</amkeyword> | <amkeyword>noinc</amkeyword> | <amkeyword>skip</amkeyword> | <amkeyword>incronly</amkeyword> ]</term>
2201 <para>Default: <amkeyword>standard</amkeyword>.
2202 Strategy to use when planning what level of backup to run next. Values are:</para>
2204 <variablelist remap='TP'>
2206 <term><amkeyword>standard</amkeyword></term>
2208 <para>The standard Amanda schedule.</para>
2212 <term><amkeyword>nofull</amkeyword></term>
2214 <para>Never do full backups, only level 1 incrementals.</para>
2218 <term><amkeyword>noinc</amkeyword></term>
2220 <para>Never do incremental backups, only full dumps.</para>
2224 <term><amkeyword>skip</amkeyword></term>
2226 <para>Treat this DLE as if it doesn't exist (useful to disable DLEs
2227 when sharing the <emphasis remap='I'>disklist</emphasis> file between
2228 multiple configurations). Skipped DLEs will not be checked or
2229 dumped, and will not be matched by disklist expressions.</para>
2233 <term><amkeyword>incronly</amkeyword></term>
2235 <para>Only do incremental dumps. <command>amadmin force</command> should be used to tell
2236 Amanda that a full dump has been performed off-line, so that it resets to level 1.</para>
2244 <term><amkeyword>allow-split</amkeyword> <amtype>bool</amtype></term>
2246 <para>Default: true.
2247 If true, then dumps with this dumptype can be split on the storage media. If false, then
2248 the dump will be written in a single file on the media. See "Dump Splitting Configuration"
2254 <term><amkeyword>tape-splitsize</amkeyword> <amtype>int</amtype></term>
2256 <para>Deprecated. See "Dump Splitting Configuration" below.</para>
2257 <para>Default: not set.
2258 Split dump file on tape into pieces of a specified size.
2259 The default unit is Kbytes if it is not specified.</para>
2264 <term><amkeyword>split-diskbuffer</amkeyword> <amtype>string</amtype></term>
2265 <para>Deprecated. See "Dump Splitting Configuration" below.</para>
2267 <para>Default: not set.
2268 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.
2274 <term><amkeyword>fallback-splitsize</amkeyword> <amtype>int</amtype></term>
2276 <para>Deprecated. See "Dump Splitting Configuration" below.</para>
2278 <amdefault>10M</amdefault>.
2279 This specifies the part size used when no <amkeyword>split-diskbuffer</amkeyword> is specified, or when it is too small or does not exist,
2280 and thus the maximum amount of memory consumed for in-memory splitting.
2281 The default unit is Kbytes if it is not specified.</para>
2286 <term><amkeyword>recovery-limit</amkeyword>
2287 [ <amkeyword>server</amkeyword> | <amkeyword>same-host</amkeyword> | <amtype>string</amtype> ]*</term>
2290 <para>Default: global value. This parameter overrides the global
2291 <amkeyword>recovery-limit</amkeyword> parameter for DLEs of this
2298 <term><amkeyword>dump-limit</amkeyword>
2299 [ <amkeyword>server</amkeyword> | <amkeyword>same-host</amkeyword> ]*</term>
2302 <para>Default: <amkeyword>server</amkeyword>. Specify which host can initiate
2303 a backup of the dle. With <amkeyword>server</amkeyword>, the server
2304 can initiate a backup with the <command>amdump</command> command.
2305 With <amkeyword>same-host</amkeyword>, the client can initiate a backup with
2306 the <command>amdump_client</command> command.</para>
2312 <para>The following <amkeyword>dumptype</amkeyword> entries are predefined by Amanda:</para>
2314 <programlisting remap='.nf'>
2315 define dumptype "no-compress" {
2318 define dumptype "compress-fast" {
2319 compress client fast
2321 define dumptype "compress-best" {
2322 compress client best
2324 define dumptype "srvcompress" {
2325 compress server fast
2327 define dumptype "bsd-auth" {
2330 define dumptype "bsdtcp-auth" {
2333 define dumptype "no-record" {
2336 define dumptype "no-hold" {
2339 define dumptype "no-full" {
2344 <para>In addition to options in a
2345 <amkeyword>dumptype</amkeyword>
2346 section, one or more other
2347 <amkeyword>dumptype</amkeyword>
2348 names may be supplied as identifiers, which make this
2349 <amkeyword>dumptype</amkeyword>
2350 inherit options from other previously defined
2351 <amkeyword>dumptype</amkeyword>s.
2352 For instance, two sections might be the same except for the
2353 <amkeyword>record</amkeyword> option:</para>
2355 <programlisting remap='.nf'>
2356 define dumptype "normal" {
2357 comment "Normal backup, no compression, do indexing"
2362 define dumptype "testing" {
2363 comment "Test backup, no compression, do indexing, no recording"
2369 <para>Amanda provides a
2370 <amkeyword>dumptype</amkeyword>
2372 <emphasis remap='I'>global</emphasis>
2374 <emphasis remap='B'>amanda.conf</emphasis>
2376 <amkeyword>dumptype</amkeyword>s
2378 This provides an easy place to make changes that will affect every
2379 <amkeyword>dumptype</amkeyword>, although you must be careful
2380 that every dumptype explicitly inherits from the
2381 <emphasis remap='I'>global</emphasis>
2382 dumptype - Amanda does not do so automatically.</para>
2385 <refsect1><title>TAPETYPE SECTION</title>
2386 <para>The <emphasis remap='B'>amanda.conf</emphasis>
2387 file may define multiple types of tape media and devices.
2388 The information is entered in a
2389 <amkeyword>tapetype</amkeyword>
2390 section, which looks like this in the config file:</para>
2393 define tapetype "<amtype>name</amtype>" {
2394 <emphasis remap='I'>tapetype-option</emphasis> <emphasis remap='I'>tapetype-value</emphasis>
2395 <literal>...</literal>
2399 <para>The { must appear at the end of a line, and the } on its own line.</para>
2400 <para><emphasis remap='I'>Name</emphasis>
2401 is the name of this type of tape medium/device.
2402 It is referenced from the
2403 <amkeyword>tapetype</amkeyword>
2404 option in the main part of the config file.</para>
2406 <para>The tapetype options and values are:</para>
2407 <variablelist remap='TP'>
2409 <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
2411 <para>Default: not set.
2412 A comment string describing this set of tape information.</para>
2416 <term><amkeyword>filemark</amkeyword> <amtype>int</amtype></term>
2419 <amdefault>1 kbytes</amdefault>.
2420 How large a file mark (tape mark) is, measured in kbytes.
2421 If the size is only known in some linear measurement (e.g. inches),
2422 convert it to kbytes using the device density.</para>
2426 <term><amkeyword>length</amkeyword> <amtype>int</amtype></term>
2429 <amdefault>2000 kbytes</amdefault>. How much data will fit on a tape, expressed in kbytes.</para>
2431 <para>Note that this value is only used by Amanda to schedule which backups will be run.
2432 Once the backups start, Amanda will continue to write to a tape until it gets an error,
2433 regardless of what value is entered for <amkeyword>length</amkeyword>
2434 (but see <manref name="amanda-devices" vol="7" /> for exceptions).
2440 <term><amkeyword>blocksize</amkeyword> <amtype>int</amtype></term>
2443 <amdefault>32 kbytes</amdefault>.
2444 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>
2448 <term><amkeyword>readblocksize</amkeyword> <amtype>int</amtype></term>
2450 <para>Default: <amdefault>32 kytes</amdefault>
2451 How much data will be read in each tape record. This can be used to override a
2452 device's block size for reads only. This may be useful, for example, in
2453 reading a tape written with a 256k block size when Amanda is configured to use
2454 128k blocks. This unusual feature is not supported by all operating systems and
2457 <para>The default unit is Kbytes if it is not specified.</para>
2462 <term><amkeyword>part-size</amkeyword> <amtype>int</amtype></term>
2464 <para>Default: none. This is the size (in KB if no units are specified) of
2465 each split part written to the volume. It is reduced to
2466 <amkeyword>part-cache-max-size</amkeyword> when part caching is required.
2467 If this is set to zero, then no splitting will take place; in this case,
2468 some devices can span dumps from volume to volume, while others will cause
2469 the entire dump to fail if they encounter end-of-medium before the dump is
2470 complete. See "Dump Splitting Configuration" below.</para>
2475 <term><amkeyword>part-cache-type</amkeyword> [ <amkeyword>none</amkeyword> | <amkeyword>disk</amkeyword> | <amkeyword>memory</amkeyword> ] </term>
2477 <para>Default: none. When part caching is required, this parameter specifies
2478 the type of caching that will be used. The options include no caching
2479 (<amkeyword>none</amkeyword>), in which case a failed part will cause the
2480 entire dump to fail; on-disk caching (<amkeyword>disk</amkeyword>), for
2481 which <amkeyword>part-cache-dir</amkeyword> must be set properly; and
2482 in-memory caching (<amkeyword>memory</amkeyword>), which on most systems
2483 severely restrains the size of the part that can be written. See "Dump
2484 Splitting Configuration" below.</para>
2489 <term><amkeyword>part-cache-dir</amkeyword> <amtype>string</amtype></term>
2491 <para>Default: none.
2492 The directory in which part-cache files can be written when caching on disk.
2493 See "Dump Splitting Configuration" below.</para>
2498 <term><amkeyword>part-cache-max-size</amkeyword> <amtype>int</amtype></term>
2500 <para>Default: none.
2501 The maximum part size to use when caching is in effect. This is used to limit
2502 the part size when disk or memory space for caching is constrained. This value
2503 must be greater than zero.</para>
2508 <term><amkeyword>speed</amkeyword> <amtype>int</amtype></term>
2511 <amdefault>200 bps</amdefault>.
2512 How fast the drive will accept data, in bytes per second.
2513 This parameter is NOT currently used by Amanda.</para>
2517 <term><amkeyword>lbl-templ</amkeyword> <amtype>string</amtype></term>
2519 <para>Default: not set.
2520 A PostScript template file used by
2521 <emphasis remap='B'>amreport</emphasis>
2522 to generate labels. Several sample files are provided with the Amanda sources in the
2523 <emphasis remap='I'>example</emphasis> directory.
2525 <manref name="amreport" vol="8"/>
2526 man page for more information.</para>
2531 <para>In addition to options, another
2532 <amkeyword>tapetype</amkeyword>
2533 name may be supplied as an identifier, which makes this
2534 <amkeyword>tapetype</amkeyword>
2535 inherit options from another
2536 <amkeyword>tapetype</amkeyword>.
2537 For instance, the only difference between a DLT4000 tape drive using
2538 Compact-III tapes and one using Compact-IV tapes is the length of the tape.
2539 So they could be entered as:</para>
2541 <programlisting remap='.nf'>
2542 define tapetype "DLT4000-III" {
2543 comment "DLT4000 tape drives with Compact-III tapes"
2544 length 12500 mbytes # 10 Gig tapes with some compression
2545 filemark 2000 kbytes
2548 define tapetype "DLT4000-IV" {
2550 comment "DLT4000 tape drives with Compact-IV tapes"
2551 length 25000 mbytes # 20 Gig tapes with some compression
2555 <!-- If anybody has read this, where do all those stupid
2556 pseudo-duplicate FOM-tapetype-entries come from??
2562 <refsect1><title>INTERFACE SECTION</title>
2564 <emphasis remap='B'>amanda.conf</emphasis>
2565 file may define multiple types of network interfaces.
2566 The information is entered in an <amkeyword>interface</amkeyword>
2567 section, which looks like this:</para>
2570 define interface "<emphasis remap='I'>name</emphasis>" {
2571 <emphasis remap='I'>interface-option</emphasis> <emphasis remap='I'>interface-value</emphasis>
2572 <literal>...</literal>
2576 <para>The { must appear at the end of a line, and the } on its own line.</para>
2577 <para><emphasis remap='I'>name</emphasis>
2578 is the name of this type of network interface. It is referenced from the
2579 <emphasis remap='I'>disklist</emphasis> file.</para>
2581 <para>Note that these sections define network interface characteristics,
2582 not the actual interface that will be used. Nor do they impose limits on the bandwidth that will
2583 actually be taken up by Amanda.
2584 Amanda computes the estimated bandwidth each file system backup will take
2585 based on the estimated size and time, then compares that plus any other running
2586 backups with the limit as another of the criteria when deciding whether
2587 to start the backup. Once a backup starts, Amanda will use as much of the network as it can
2588 leaving throttling up to the operating system and network hardware.</para>
2590 <para>The interface options and values are:</para>
2591 <variablelist remap='TP'>
2593 <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
2595 <para>Default: not set.
2596 A comment string describing this set of network information.</para>
2600 <term><amkeyword>use</amkeyword> <amtype>int</amtype></term>
2603 <amdefault>8000 Kbps</amdefault>.
2604 The speed of the interface in Kbytes per second.</para>
2609 <para>In addition to options, another
2610 <amkeyword>interface</amkeyword>
2611 name may be supplied as an identifier, which makes this
2612 <amkeyword>interface</amkeyword>
2613 inherit options from another
2614 <amkeyword>interface</amkeyword>.
2615 At the moment, this is of little use.</para>
2618 <refsect1><title>APPLICATION SECTION</title>
2620 <emphasis remap='B'>amanda.conf</emphasis>
2621 file may define multiple types of application.
2622 The information is entered in a <amkeyword>application</amkeyword>
2623 section, which looks like this:</para>
2626 define application "<emphasis remap='I'>name</emphasis>" {
2627 <emphasis remap='I'>application-option</emphasis> <emphasis remap='I'>application-value</emphasis>
2628 <literal>...</literal>
2631 <para>The { must appear at the end of a line, and the } on its own line.</para>
2633 <para><emphasis remap='I'>name</emphasis>
2634 is the name of this type of application. It is referenced from the
2635 <emphasis remap='I'>dumptype</emphasis></para>
2637 <para>The application options and values are:</para>
2638 <variablelist remap='TP'>
2640 <term><amkeyword>client-name</amkeyword> <amtype>string</amtype></term>
2643 specifies an application name that is in the amanda-client.conf on the client.
2644 The setting from that application will be merged with the current application.
2645 If <amkeyword>client-name</amkeyword> is set then it is an error
2646 if that application is not defined on the client.</para>
2647 <para>If <amkeyword>client-name</amkeyword> is not set then the
2648 merge is done with the application that have the name equal to the plugin.
2649 eg. if the plugin is 'amgtar', then the setting from the application 'amgtar'
2650 is used if it is defined.
2655 <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
2657 <para>Default: not set.
2658 A comment string describing this application.</para>
2662 <term><amkeyword>plugin</amkeyword> <amtype>string</amtype></term>
2664 <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>
2668 <term><amkeyword>property</amkeyword> [<amkeyword>append</amkeyword>] [<amkeyword>priority</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
2670 <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
2671 the property to set, and the others contains its values.
2672 <amkeyword>append</amkeyword> keyword append the values to the list of values for that property.
2673 <amkeyword>priority</amkeyword> keyword disallow the setting of that property on the client.
2680 <refsect1><title>SCRIPT SECTION</title>
2682 <emphasis remap='B'>amanda.conf</emphasis>
2683 file may define multiple types of script.
2684 The information is entered in a <amkeyword>script</amkeyword>
2685 section, which looks like this:</para>
2688 define script "<emphasis remap='I'>name</emphasis>" {
2689 <emphasis remap='I'>script-option</emphasis> <emphasis remap='I'>script-value</emphasis>
2690 <literal>...</literal>
2693 <para>The { must appear at the end of a line, and the } on its own line.</para>
2695 <para><emphasis remap='I'>name</emphasis>
2696 is the name of this type of script. It is referenced from the
2697 <emphasis remap='I'>dumptype</emphasis></para>
2699 <para>The script options and values are:</para>
2700 <variablelist remap='TP'>
2702 <term><amkeyword>client-name</amkeyword> <amtype>string</amtype></term>
2705 specifies a script name that is in the amanda-client.conf on the client.
2706 The setting from that script will be merged with the currect script.
2707 If <amkeyword>client-name</amkeyword> is set then it is an error if that script is not defined on the client.</para>
2708 <para>If <amkeyword>client-name</amkeyword> is not set then the
2709 merge is done with the script that have the name equal to the plugin.
2710 eg. if the plugin is 'amlog-script', then the setting from the script
2711 'amlog-script' is used.
2716 <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
2718 <para>Default: not set.
2719 A comment string describing this script.</para>
2723 <term><amkeyword>plugin</amkeyword> <amtype>string</amtype></term>
2725 <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>
2729 <term><amkeyword>order</amkeyword> <amtype>int</amtype></term>
2731 <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>
2735 <term><amkeyword>single-execution</amkeyword> <amtype>boolean</amtype></term>
2737 <para>Default: <amdefault>no</amdefault>. The script is executed for each dle. If <amdefault>yes</amdefault>, the script is executed one time only.</para>
2741 <term><amkeyword>execute-where</amkeyword> [ <amkeyword>client</amkeyword> | <amkeyword>server</amkeyword> ]</term>
2743 <para>Default: <amkeyword>client</amkeyword>. Where the script must be executed, on the client or server.</para>
2747 <term><amkeyword>execute-on</amkeyword> <amtype>execute_on</amtype> [,<amtype>execute_on</amtype>]*</term>
2749 <para>No default. When the script must be executed, you can specify many of them:</para>
2751 <variablelist remap='TP'>
2753 <term><amkeyword>pre-amcheck</amkeyword></term>
2755 <para>Execute before the amcheck command for all dle. Can only be run on server.</para>
2759 <term><amkeyword>pre-dle-amcheck</amkeyword></term>
2761 <para>Execute before the amcheck command for the dle.</para>
2765 <term><amkeyword>pre-host-amcheck</amkeyword></term>
2767 <para>Execute before the amcheck command for all dle for the client.</para>
2771 <term><amkeyword>post-amcheck</amkeyword></term>
2773 <para>Execute after the amcheck command for all dle. Can only be run on server.</para>
2777 <term><amkeyword>post-dle-amcheck</amkeyword></term>
2779 <para>Execute after the amcheck command for the dle.</para>
2783 <term><amkeyword>post-host-amcheck</amkeyword></term>
2785 <para>Execute after the amcheck command for all dle for the client.</para>
2789 <term><amkeyword>pre-estimate</amkeyword></term>
2791 <para>Execute before the estimate command for all dle. Can only be run on server.</para>
2795 <term><amkeyword>pre-dle-estimate</amkeyword></term>
2797 <para>Execute before the estimate command for the dle.</para>
2801 <term><amkeyword>pre-host-estimate</amkeyword></term>
2803 <para>Execute before the estimate command for all dle for the client.</para>
2807 <term><amkeyword>post-estimate</amkeyword></term>
2809 <para>Execute after the estimate command for all dle. Can only be run on server.</para>
2813 <term><amkeyword>post-dle-estimate</amkeyword></term>
2815 <para>Execute after the estimate command for the dle.</para>
2819 <term><amkeyword>post-host-estimate</amkeyword></term>
2821 <para>Execute after the estimate command for all dle for the client.</para>
2825 <term><amkeyword>pre-backup</amkeyword></term>
2827 <para>Execute before the backup command for all dle. Can only be run on server.</para>
2831 <term><amkeyword>pre-dle-backup</amkeyword></term>
2833 <para>Execute before the backup command for the dle.</para>
2837 <term><amkeyword>pre-host-backup</amkeyword></term>
2839 <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>
2843 <term><amkeyword>post-backup</amkeyword></term>
2845 <para>Execute after the backup command for all dle. Can only be run on server.</para>
2849 <term><amkeyword>post-dle-backup</amkeyword></term>
2851 <para>Execute after the backup command for the dle.</para>
2855 <term><amkeyword>post-host-backup</amkeyword></term>
2857 <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>
2861 <term><amkeyword>pre-recover</amkeyword></term>
2863 <para>Execute before any level is recovered.</para>
2867 <term><amkeyword>post-recover</amkeyword></term>
2869 <para>Execute after all levels are recovered.</para>
2873 <term><amkeyword>pre-level-recover</amkeyword></term>
2875 <para>Execute before each level recovery.</para>
2879 <term><amkeyword>post-level-recover</amkeyword></term>
2881 <para>Execute after each level recovery.</para>
2885 <term><amkeyword>inter-level-recover</amkeyword></term>
2887 <para>Execute between two levels of recovery.</para>
2891 <para>If you recover level 0 and 2 of the disk /usr with amrecover, it will execute:</para>
2893 script --pre-recover
2894 script --pre-level-recover --level 0
2896 script --post-level-recover --level 0
2897 script --inter-level-recover --level 0 --level 2
2898 script --pre-level-recover --level 2
2900 script --post-level-recover --level 2
2901 script --post-recover
2906 <term><amkeyword>property</amkeyword> [<amkeyword>append</amkeyword>] [<amkeyword>priority</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
2908 <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
2909 the property to set, and the others contains its values.
2910 <amkeyword>append</amkeyword> keyword append the values to the list of values for that property.
2911 <amkeyword>priority</amkeyword> keyword disallow the setting of that property on the client.
2918 <refsect1><title>DEVICE SECTION</title>
2919 <para>Backend storage devices are specified in
2920 <emphasis remap='B'>amanda.conf</emphasis>
2921 in the form of "device" sections, which look like this:</para>
2924 define device <emphasis remap='I'>name</emphasis> {
2925 commend "<emphasis remap='I'>comment (optional)</emphasis>"
2926 tapedev "<emphasis remap='I'>device-specifier</emphasis>"
2927 device-property "<emphasis remap='I'>prop-name</emphasis>" "<emphasis remap='I'>prop-value</emphasis>"
2928 <literal>...</literal>
2932 <para>The { must appear at the end of a line, and the } on its own line.</para>
2933 <para><emphasis remap='I'>name</emphasis> is the user-specified name of
2934 this device. It is referenced from the global <emphasis
2935 remap='I'>tapedev</emphasis> parameter. The <emphasis
2936 remap='I'>device-specifier</emphasis> specifies the device name to use;
2937 see <manref name="amanda-devices" vol="7"/>.
2938 As with most sections, the <emphasis remap='I'>comment</emphasis>
2939 parmeter is optional and only for the user's convenience.</para>
2941 <para>An arbitrary number of <emphasis
2942 remap='I'>device-property</emphasis> parameters can be specified.
2944 <manref name="amanda-devices" vol="7"/>
2945 for information on device properties.</para>
2949 <refsect1><title>CHANGER SECTION</title>
2950 <para>Changers are described in
2951 <emphasis remap='B'>amanda.conf</emphasis>
2952 in the form of "changer" sections, which look like this:</para>
2955 define changer <emphasis remap='I'>name</emphasis> {
2956 comment "<emphasis remap='I'>comment (optional)</emphasis>"
2957 tpchanger "<emphasis remap='I'>changer-spec</emphasis>"
2958 changerdev "<emphasis remap='I'>device-name</emphasis>"
2959 changerfile "<emphasis remap='I'>state-file</emphasis>"
2960 <literal>...</literal>
2964 <para>The { must appear at the end of a line, and the } on its own line.</para>
2965 <para><emphasis remap='I'>name</emphasis> is the user-specified name of this
2966 device. The remaining parameters are specific to the changer type selected.
2969 <para>See <manref name="amanda-changers" vol="7" /> for more information on configuring changers.</para>
2973 <refsect1><title>INTERACTIVITY SECTION</title>
2975 <emphasis remap='B'>amanda.conf</emphasis>
2976 file may define multiple interactivyt methods, although only one will be used - that specified
2977 by the <amkeyword>interactivity</amkeyword> parameter.
2978 The information is entered in a <amkeyword>interactivity</amkeyword>
2979 section, which looks like this:</para>
2982 define interactivity <emphasis remap='I'>name</emphasis> {
2983 <emphasis remap='I'>interactivity-option</emphasis> <emphasis remap='I'>interactivity-value</emphasis>
2984 <literal>...</literal>
2988 <para>The { must appear at the end of a line, and the } on its own line.</para>
2989 <para><emphasis remap='I'>name</emphasis> is the user-specified name of this
2990 interactivity. The remaining parameters are specific to the interactivity type
2994 <para>The interactivity options and values are:</para>
2995 <variablelist remap='TP'>
2997 <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
2999 <para>Default: not set.
3000 A comment string describing this interactivity.</para>
3004 <term><amkeyword>plugin</amkeyword> <amtype>string</amtype></term>
3006 <para>No default. Must be set to the name of the interactivity module, as described in <manref name="amanda-interactivity" vol="7" />.</para>
3010 <term><amkeyword>property</amkeyword> [<amkeyword>append</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
3012 <para>No default. You can set arbitrary properties for the interactivity. Each interactivity module has a different set of properties. The first string contains the name of
3013 the property to set, and the others contains its values. All strings should be quoted.
3014 The <amkeyword>append</amkeyword> keyword appends the given values to an existing list of values for that property.
3020 <para>See <manref name="amanda-interactivity" vol="7" /> for more information on configuring interactivity methods.</para>
3024 <refsect1><title>TAPERSCAN SECTION</title>
3026 <emphasis remap='B'>amanda.conf</emphasis>
3027 file may define multiple taperscan methods, although only one will be used - that specified
3028 by the <amkeyword>taperscan</amkeyword> parameter.
3029 The information is entered in a <amkeyword>taperscan</amkeyword>
3030 section, which looks like this:</para>
3033 define taperscan <emphasis remap='I'>name</emphasis> {
3034 <emphasis remap='I'>taperscan-option</emphasis> <emphasis remap='I'>taperscan-value</emphasis>
3035 <literal>...</literal>
3039 <para>The { must appear at the end of a line, and the } on its own line.</para>
3040 <para><emphasis remap='I'>name</emphasis> is the user-specified name of this
3041 taperscan. The remaining parameters are specific to the taperscan type
3045 <para>The taperscan options and values are:</para>
3046 <variablelist remap='TP'>
3048 <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
3050 <para>Default: not set.
3051 A comment string describing this taperscan.</para>
3055 <term><amkeyword>plugin</amkeyword> <amtype>string</amtype></term>
3057 <para>No default. Must be set to the name of the taperscan module. See <man name="amanda-taperscan" vol="7" /> for a list of defined taperscan modules.</para>
3061 <term><amkeyword>property</amkeyword> [<amkeyword>append</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
3063 <para>No default. Operates just like properties for interactivity methods, above.</para>
3068 <para>See <manref name="amanda-taperscan" vol="7" /> for more information on configuring taperscan.</para>
3072 <refsect1><title>Dump Splitting Configuration</title>
3074 <para>Amanda can "split" dumps into parts while writing them to storage
3075 media. This allows Amanda to recover gracefully from a failure while
3076 writing a part to a volume, by simply selecting a new volume and
3077 re-writing the dump from the beginning of the failed part. Parts also
3078 allow Amanda to seek directly to the required data, although this
3079 functionality is not yet used.</para>
3081 <para>In order to support re-writing from the beginning of a failed part,
3082 Amanda must have access to the contents of the part after it has been
3083 partially written. If the dump is being read from holding disk, then
3084 the part contents are availble there. Otherwise, the part must be
3085 cached, and this can be done memory or on disk. In either of the
3086 latter cases, the cache must have enough space to hold an entire
3089 <para>Because it is common for a single Amanda configuration to use both
3090 holding-disk (FILE-WRITE) and direct (known as PORT-WRITE) dumps, Amanda
3091 allows the configuration of different split sizes for the two cases. This
3092 allows, for example, for a part size appropriate to large tapes when
3093 performing FILE-WRITE dumps, with a part size limited by available disk
3094 or memory when performing PORT-WRITE dumps.</para>
3096 <para>Selecting a proper split size is a delicate matter. If the parts are
3097 too large, substantial storage space may be wasted in failed parts. If
3098 too small, large dumps will be split into innumerable tiny dumpfiles,
3099 adding to restoration complexity; furthermore, an excess of filemarks
3100 will cause slower tape drive operation and reduce the usable space on
3101 tape. A good rule of thumb is 1/10 of the size of a volume of storage
3104 <para>In versions of Amanda through 3.1.*, splitting was controlled by the
3105 dumptype parameters <amkeyword>tape-splitsize</amkeyword>,
3106 <amkeyword>split-diskbuffer</amkeyword>, and
3107 <amkeyword>fallback-splitsize</amkeyword>. These keywords had
3108 confusing and non-intuitive interactions, and have since been
3111 <para>If the deprecated keywords are not present, subsequent versions
3112 of Amanda use the dumptype parameter
3113 <amkeyword>allow-split</amkeyword> to control whether a DLE can be
3114 split, and the <emphasis>tapetype</emphasis> parameters
3115 <amkeyword>part-size</amkeyword>,
3116 <amkeyword>part-cache-type</amkeyword>,
3117 <amkeyword>part-cache-dir</amkeyword>, and
3118 <amkeyword>part-cache-max-size</amkeyword>. The
3119 <amkeyword>part-size</amkeyword> specifies the "normal" part size,
3120 while the <amkeyword>part-cache-*</amkeyword> parameters describe
3121 how to behave when caching is required (on PORT-WRITE). Full
3122 details on these parameters are given above.</para>
3127 <manref name="amanda-client.conf" vol="5"/>,
3128 <manref name="amanda-applications" vol="7"/>,
3129 <manref name="amanda-auth" vol="7"/>,
3130 <manref name="amanda-changers" vol="7"/>,
3131 <manref name="amanda-devices" vol="7"/>,
3132 <manref name="amanda-interactivity" vol="7"/>,
3133 <manref name="amanda-scripts" vol="7"/>
3134 <manref name="amanda-taperscan" vol="7"/>