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>
353 <term><amkeyword>max-dle-by-volume</amkeyword> <amtype>int</amtype></term>
356 <amdefault>1000000000</amdefault>.
357 The maximum number of dle written to a single volume.</para>
362 <term><amkeyword>dumpcycle</amkeyword> <amtype>int</amtype></term>
365 <amdefault>10 days</amdefault>.
366 The number of days in the backup cycle.
367 Each disk will get a full backup at least this often.
368 Setting this to zero tries to do a full backup each run.</para>
369 <note><para>This parameter may also be set in a specific
370 <amkeyword>dumptype</amkeyword>
372 This value sets the default for all
373 <amkeyword>dumptype</amkeyword>s
375 <emphasis remap='B'>amanda.conf</emphasis>
377 <amkeyword>dumptype</amkeyword>s
384 <term><amkeyword>runspercycle</amkeyword> <amtype>int</amtype></term>
387 <amdefault>same as dumpcycle</amdefault>.
388 The number of amdump runs in
389 <amkeyword>dumpcycle</amkeyword>
391 A value of 0 means the same value as
392 <amkeyword>dumpcycle</amkeyword>.
393 A value of -1 means guess the number of runs from the &tapelist; file,
394 which is the number of tapes used in the last
395 <amkeyword>dumpcycle</amkeyword>
397 <amkeyword>runtapes</amkeyword>.</para>
402 <term><amkeyword>tapecycle</amkeyword> <amtype>int</amtype></term>
405 <amdefault>15 tapes</amdefault>.
407 Specifies the number of "active" volumes - volumes that Amanda will not
408 overwrite. While Amanda is always willing to write to a new volume, it refuses
409 to overwrite a volume unless at least '<amkeyword>tapecycle</amkeyword> -1'
410 volumes have been written since.</para>
412 <para> It is considered good administrative practice to set the
413 <amkeyword>tapecycle</amkeyword> parameter slightly lower than the actual
414 number of tapes in use. This allows the administrator to more easily cope
415 with damaged or misplaced tapes or schedule adjustments that call for
416 slight adjustments in the rotation order.</para>
418 <para>Note: Amanda is commonly misconfigured with <amkeyword>tapecycle</amkeyword>
419 equal to the number of tapes per <amkeyword>dumpcycle</amkeyword>. In this
420 misconfiguration, amanda may erase a full dump before a new one is
421 completed. Recovery is then impossible. The
422 <amkeyword>tapecycle</amkeyword> must be at least one tape larger than the
423 number of tapes per dumpcycle.</para>
426 The number of tapes per dumpcycle is calculated by multiplying the number of
427 &amdump; runs per dump cycle <amkeyword>runspercycle</amkeyword> (the
428 number of &amdump; runs per dump cycle) and <emphasis
429 remap='B'>runtapes</emphasis> (the number of tapes used per run). Typically
430 <amkeyword>tapecycle</amkeyword> is set to two or four times the tapes
431 per dumpcycle.</para>
437 <term><amkeyword>usetimestamps</amkeyword>
438 <amtype>bool</amtype></term>
440 <para>Default: <amkeyword>Yes</amkeyword>.
441 This option allows Amanda to track multiple runs per calendar
442 day. The only reason one might disable it is that Amanda versions before 2.5.1
443 can't read logfiles written when this option was enabled.
449 <term><amkeyword>label-new-tapes</amkeyword>
450 <amtype>string</amtype></term>
452 <para>Deprecated, use <amkeyword>autolabel</amkeyword> option with options <amkeyword>volume-error empty</amkeyword> to get equivalent behavior.</para>
453 <para>Default: not set.
454 When set, this directive will cause Amanda to automatically write an Amanda
455 tape label to any blank tape she encounters.</para>
460 <term><amkeyword>autolabel</amkeyword>
461 <amtype>string</amtype>
462 [<amkeyword>any</amkeyword>]
463 [<amkeyword>other-config</amkeyword>]
464 [<amkeyword>non-amanda</amkeyword>]
465 [<amkeyword>volume-error</amkeyword>]
466 [<amkeyword>empty</amkeyword>]</term>
468 <para>Default: not set.
469 When set, this directive will cause Amanda to automatically write an Amanda
470 tape label to most volume she encounters. This option is DANGEROUS
471 because when set, Amanda may erase near-failing tapes or tapes accidentally
472 loaded in the wrong slot.</para>
473 <para>When using this directive, specify the template for new tape
474 labels. The template can contains many variables that are substituted by their
478 $o : org configuration
479 $b : barcode of the volume
480 $s : slot number, can specify a minimun number of digit:
483 </programlisting></para>
484 <para>The template can contain some number of contiguous '%'
485 characters, which will be replaced with a generated number. Be sure to
486 specify enough '%' characters that you do not run out of tape labels.
488 <markup>"DailySet1-%%%"</markup>,
489 <markup>"$c-%%%"</markup>,
490 <markup>"$m-%%%"</markup>,
491 <markup>"$m-$b"</markup>
493 <para>The generared label can be used only if it match the
494 <amkeyword>labelstr</amkeyword> setting. The volume will not be used if the
495 generated label doesn't match the <amkeyword>labelstr</amkeyword> setting.
497 <para>Note that many devices cannot distinguish an empty tape from an error
498 condition, so it may is often necessary to include
499 <amkeyword>volume-error</amkeyword> as an autolabel condition.</para>
500 <variablelist remap='TP'>
502 <term><amkeyword>any</amkeyword></term>
503 <listitem>equivalent to '<amkeyword>other-config non-amanda volume-error empty</amkeyword>'
507 <term><amkeyword>other-config</amkeyword></term>
508 <listitem>Label volumes with a valid Amanda label that do not match our
509 <amkeyword>labelstr</amkeyword>. Danger: this may erase volumes
510 from other Amanda configurations without warning!
514 <term><amkeyword>non-amanda</amkeyword></term>
515 <listitem>Label volumes which do not start with data that resembles an
516 Amanda header. Danger: this may erase volumes from other backup applications
521 <term><amkeyword>volume-error</amkeyword></term>
522 <listitem>Label volumes where an error occurs while trying to read the label.
523 Danger: this may erase arbitrary volumes due to transient errors.
527 <term><amkeyword>empty</amkeyword></term>
528 <listitem>Label volumes where a read returns 0 bytes.
536 <term><amkeyword>meta-autolabel</amkeyword>
537 <amtype>string</amtype></term>
539 <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>
540 <para>A meta-volume is a containers that contains many volumes, eg. a removable
541 hard-disk for use with chg-disk, each hard disk have many slots (volume).
542 The meta-label is the label to put on the meta-volume.</para>
543 <para>When using this directive, specify the template for new meta
544 labels. The template can contains many variables that are substituted by their
548 $o : org configuration
549 </programlisting></para>
550 <para>The template should contain some number of contiguous '%'
551 characters, which will be replaced with a generated number. Be sure to
552 specify enough '%' characters that you do not run out of meta labels.
554 <markup>"DailySet1-%%%"</markup>,
555 <markup>"$o-%%%"</markup>,
561 <term><amkeyword>dumpuser</amkeyword> <amtype>string</amtype></term>
564 <amdefault>"amanda"</amdefault>.
565 The login name Amanda uses to run the backups.
566 The backup client hosts must allow access
567 from the tape server host as this user via
568 <markup>.rhosts</markup>
570 <markup>.amandahosts</markup>,
571 depending on how the Amanda software was built.</para>
575 <term><amkeyword>printer</amkeyword> <amtype>string</amtype></term>
577 <para>Printer to use when doing tape labels.
579 <amkeyword>lbl-templ</amkeyword>
580 <amkeyword>tapetype</amkeyword>
586 <term><amkeyword>tapedev</amkeyword> <amtype>string</amtype></term>
589 <amdefault>"null:"</amdefault>.
590 This parameter can either specify a device (explicitly or by referencing a device definition - see <manref name="amanda-devices" vol="7" />)
591 or a tape changer (explicitly or by referencing a device definition - see <manref name="amanda-changers" vol="7" />).</para>
597 <term><amkeyword>device-property</amkeyword> <amtype>string</amtype> <amtype>string</amtype></term>
599 <para>These options can set various device properties. See
600 <manref name="amanda-devices" vol="7"/>
601 for more information on device properties and their syntax.
602 Both strings are always quoted; the first string contains the name of
603 the property to set, and the second contains its value. For example, to set
604 a fixed block size of 128k, write:</para>
606 device-property "BLOCK_SIZE" "128k"
613 <term><amkeyword>property</amkeyword> [<amkeyword>append</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
615 <para>These options can set various properties, they can be used by third
616 party software to store information in the configuration file.
617 Both strings are quoted; the first string contains the name of
618 the property to set, and the others contains its values.
619 <amkeyword>append</amkeyword> keyword append the values to the list of values for that property.
625 <term><amkeyword>tpchanger</amkeyword> <amtype>string</amtype></term>
627 <para>Default: not set. The tape changer to use. In most cases, only one of
628 <amkeyword>tpchanger</amkeyword> or <amkeyword>tapedev</amkeyword> is
629 specified, although for backward compatibility both may be specified if
630 <amkeyword>tpchanger</amkeyword> gives the name of an old changer script.
631 See <manref name="amanda-changers" vol="7" /> for more information on
632 configuring changers.</para>
637 <term><amkeyword>interactivity</amkeyword> <amtype>string</amtype></term>
639 <para>Default: not set. The interactivity module Amanda should use to interact with
640 the user. See <manref name="amanda-interactivity" vol="7" /> for a list of
646 <term><amkeyword>taperscan</amkeyword> <amtype>string</amtype></term>
648 <para>Default: traditional. The taperscan module amanda should use to find a tape
649 to write to. See <manref name="amanda-taperscan" vol="7" /> for a list of
655 <term><amkeyword>changerdev</amkeyword> <amtype>string</amtype></term>
658 <amdefault>"dev/null"</amdefault>.
659 A tape changer configuration parameter.
660 Usage depends on the particular changer defined with the
661 <amkeyword>tpchanger</amkeyword>
666 <term><amkeyword>changerfile</amkeyword> <amtype>string</amtype></term>
669 <amdefault>"/usr/adm/amanda/log/changer-status"</amdefault>.
670 A tape changer configuration parameter.
671 Usage depends on the particular changer defined with the
672 <amkeyword>tpchanger</amkeyword>
677 <term><amkeyword>runtapes</amkeyword> <amtype>int</amtype></term>
680 <amdefault>1</amdefault>.
681 The maximum number of tapes used in a single run.
682 If a tape changer is not configured, this option is not used
683 and should be commented out of the configuration file.</para>
684 <para>If a tape changer is configured, this may be set larger than one to
685 let Amanda write to more than one tape.</para>
686 <para>Note that this is an upper bound on the number of tapes,
687 and Amanda may use less.</para>
692 <term><amkeyword>maxdumpsize</amkeyword> <amtype>int</amtype></term>
695 <amdefault><amkeyword>runtapes</amkeyword>*<amkeyword>tape-length</amkeyword></amdefault>.
696 Maximum number of bytes the planner will schedule for a run.</para>
697 <para>The default unit is Kbytes if it is not specified.</para>
701 <term><amkeyword>taperalgo</amkeyword> [ <amkeyword>first</amkeyword> | <amkeyword>firstfit</amkeyword> | <amkeyword>largest</amkeyword> | <amkeyword>largestfit</amkeyword> | <amkeyword>smallest</amkeyword> | <amkeyword>last</amkeyword> ]</term>
704 <amkeyword>first</amkeyword>.
705 The algorithm used to choose which dump image to send to the taper.</para>
707 <variablelist remap='TP'>
709 <term><amkeyword>first</amkeyword></term>
711 <para>First in, first out.</para>
715 <term><amkeyword>firstfit</amkeyword></term>
717 <para>The first dump image that will fit on the current tape.</para>
721 <term><amkeyword>largest</amkeyword></term>
723 <para>The largest dump image.</para>
727 <term><amkeyword>largestfit</amkeyword></term>
729 <para>The largest dump image that will fit on the current tape.</para>
733 <term><amkeyword>smallest</amkeyword></term>
735 <para>The smallest dump image.</para>
739 <term><amkeyword>last</amkeyword></term>
741 <para>Last in, first out.</para>
749 <term><amkeyword>taper-parallel-write</amkeyword> <amtype>int</amtype></term>
751 <para>Default: <amdefault>1</amdefault>.
752 Amanda can write simultaneously up to that number of volume at any given
753 time. The changer must have as many drives.</para>
758 <term><amkeyword>eject-volume</amkeyword> <amtype>int</amtype></term>
760 <para>Default: <amdefault>no</amdefault>.
761 Set to <amkeyword>yes</amkeyword> if you want the volume to be ejected
762 after Amanda wrote data to it. It works only with some changer and device.</para>
767 <term><amkeyword>labelstr</amkeyword> <amtype>string</amtype></term>
770 <amdefault>".*"</amdefault>.
771 The tape label constraint regular expression.
772 All tape labels generated (see
773 <manref name="amlabel" vol="8"/>)
774 and used by this configuration must match the regular expression.
775 If multiple configurations are run from the same tape server host,
776 it is helpful to set their labels to different strings
777 (for example, "DAILY[0-9][0-9]*" vs.
778 "ARCHIVE[0-9][0-9]*")
779 to avoid overwriting each other's tapes.</para>
783 <term><amkeyword>tapetype</amkeyword> <amtype>string</amtype></term>
786 <amdefault>no default</amdefault>.
787 The type of tape drive associated with
788 <amkeyword>tapedev</amkeyword>
790 <amkeyword>tpchanger</amkeyword>.
791 This refers to one of the defined <amkeyword>tapetype</amkeyword>s
792 in the config file (see below), which specify various tape parameters,
794 <amkeyword>length</amkeyword>,
795 <amkeyword>filemark</amkeyword>
797 <amkeyword>speed</amkeyword>
798 of the tape media and device.</para>
802 <term><amkeyword>ctimeout</amkeyword> <amtype>int</amtype></term>
805 <amdefault>30 seconds</amdefault>.
806 Maximum amount of time that
807 <emphasis remap='B'>amcheck</emphasis>
808 will wait for each client host.</para>
812 <term><amkeyword>dtimeout</amkeyword> <amtype>int</amtype></term>
815 <amdefault>1800 seconds</amdefault>.
816 Amount of idle time per disk on a given client that a
817 <emphasis remap='B'>dumper</emphasis>
819 <command>amdump</command>
820 will wait before it fails with a data timeout error.</para>
825 <term><amkeyword>etimeout</amkeyword> <amtype>int</amtype></term>
828 <amdefault>300 seconds</amdefault>.
829 Amount of time per estimate on a given client that the
830 <emphasis remap='B'>planner</emphasis> step of
831 <command>amdump</command> will wait to get the dump size estimates
832 (note: Amanda runs up to 3 estimates for each DLE). For instance,
833 with the default of 300 seconds and four DLE's, each estimating level
834 0 and level 1 on client A, <emphasis remap='B'>planner</emphasis>
835 will wait up to 40 minutes for that machine. A negative value will
836 be interpreted as a total amount of time to wait
837 per client instead of per disk.</para>
842 <term><amkeyword>connect-tries</amkeyword> <amtype>int</amtype></term>
845 <amdefault>3</amdefault>.
846 How many times the server will try a connection.</para>
851 <term><amkeyword>req-tries</amkeyword> <amtype>int</amtype></term>
854 <amdefault>3</amdefault>.
855 How many times the server will resend a REQ packet if it doesn't get the ACK packet.</para>
860 <term><amkeyword>netusage</amkeyword> <amtype>int</amtype></term>
863 <amdefault>80000 Kbps</amdefault>.
864 The maximum network bandwidth allocated to Amanda, in Kbytes per second.
866 <emphasis remap='B'>interface</emphasis>
871 <term><amkeyword>inparallel</amkeyword> <amtype>int</amtype></term>
874 <amdefault>10</amdefault>.
875 The maximum number of backups that Amanda will attempt to run in parallel.
876 Amanda will stay within the constraints of network bandwidth and
877 holding disk space available, so it doesn't hurt to set
878 this number a bit high. Some contention can occur with larger numbers
879 of backups, but this effect is relatively small on most systems.</para>
884 <term><amkeyword>displayunit</amkeyword> "k|m|g|t"</term>
887 <amdefault>"k"</amdefault>.
888 The unit used to print many numbers, k=kilo, m=mega, g=giga, t=tera.
894 <term><amkeyword>dumporder</amkeyword> <amtype>string</amtype></term>
897 <amdefault>"tttTTTTTTT"</amdefault>.
898 The priority order of each dumper:
905 b: smallest bandwidth
907 </programlisting></para>
913 <term><amkeyword>maxdumps</amkeyword> <amtype>int</amtype></term>
916 <amdefault>1</amdefault>.
917 The maximum number of backups from a single host that Amanda will
918 attempt to run in parallel. See also the
919 <emphasis remap='B'>inparallel</emphasis>
922 <para>Note that this parameter may also be set in a specific
923 <amkeyword>dumptype</amkeyword>
925 This value sets the default for all
926 <amkeyword>dumptype</amkeyword>s
928 <emphasis remap='B'>amanda.conf</emphasis>
930 <amkeyword>dumptype</amkeyword>s
936 <term><amkeyword>bumpsize</amkeyword> <amtype>int</amtype></term>
939 <amdefault>10 Mbytes</amdefault>.
940 The minimum savings required to trigger an automatic
941 bump from one incremental level to the next, expressed as size.
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.
945 The value of this parameter is used only if the parameter
946 <emphasis>bumppercent</emphasis> is set to 0.
948 <para>The default unit is Kbytes if it is not specified.</para>
950 The global setting of this parameter can be overwritten inside of a
955 <amkeyword>bumppercent</amkeyword>,
956 <amkeyword>bumpmult</amkeyword> and
957 <amkeyword>bumpdays</amkeyword>.</para>
962 <term><amkeyword>bumppercent</amkeyword> <amtype>int</amtype></term>
965 <amdefault>0</amdefault>.
966 The minimum savings required to trigger an automatic
967 bump from one incremental level to the next, expressed as percentage of the
968 current size of the DLE (size of current level 0).
969 If Amanda determines that the next higher backup level
970 will be this much smaller than the current level,
971 it will do the next level.
974 If this parameter is set to 0, the value of the
975 parameter <emphasis>bumpsize</emphasis> is used to trigger bumping.
978 The global setting of this parameter can be overwritten inside of a
983 <amkeyword>bumpsize</amkeyword>,
984 <amkeyword>bumpmult</amkeyword> and
985 <amkeyword>bumpdays</amkeyword>.</para>
990 <term><amkeyword>bumpmult</amkeyword> <amtype>float</amtype></term>
993 <amdefault>1.5</amdefault>.
994 The bump size multiplier.
996 <amkeyword>bumpsize</amkeyword>
997 by this factor for each level.
998 This prevents active filesystems from
999 bumping too much by making it harder to bump to the next level.
1000 For example, with the default
1001 <amkeyword>bumpsize</amkeyword>
1003 <amkeyword>bumpmult</amkeyword>
1004 set to 2.0, the bump threshold will be 10 Mbytes for level one, 20
1005 Mbytes for level two, 40 Mbytes for level three, and so on.</para>
1007 The global setting of this parameter can be overwritten inside of a
1008 dumptype-definition.
1013 <term><amkeyword>bumpdays</amkeyword> <amtype>int</amtype></term>
1016 <amdefault>2 days</amdefault>.
1017 To insure redundancy in the dumps, Amanda keeps filesystems at the
1018 same incremental level for at least
1019 <amkeyword>bumpdays</amkeyword>
1020 days, even if the other bump threshold criteria are met.</para>
1022 The global setting of this parameter can be overwritten inside of a
1023 dumptype-definition.
1029 <term><amkeyword>diskfile</amkeyword> <amtype>string</amtype></term>
1032 <amdefault>"disklist"</amdefault>.
1033 The file name for the
1034 <emphasis remap='I'>disklist</emphasis>
1035 file holding client hosts, disks and other client dumping information.</para>
1039 <term><amkeyword>infofile</amkeyword> <amtype>string</amtype></term>
1042 <amdefault>"/usr/adm/amanda/curinfo"</amdefault>.
1043 The file or directory name for the historical information database.
1044 If Amanda was configured to use DBM databases, this is the base file
1046 If it was configured to use text formated databases (the default),
1047 this is the base directory and within here will be a directory per
1048 client, then a directory per disk, then a text file of data.</para>
1052 <term><amkeyword>logdir</amkeyword> <amtype>string</amtype></term>
1055 <amdefault>"/usr/adm/amanda"</amdefault>.
1056 The directory for the
1057 <command>amdump</command>
1059 <emphasis remap='B'>log</emphasis>
1064 <term><amkeyword>indexdir</amkeyword> <amtype>string</amtype></term>
1067 <amdefault>"/usr/adm/amanda/index"</amdefault>.
1068 The directory where index files (backup image catalogues) are stored.
1070 only generated for filesystems whose
1071 <amkeyword>dumptype</amkeyword>
1073 <amkeyword>index</amkeyword>
1074 option enabled.</para>
1078 <term><amkeyword>tapelist</amkeyword> <amtype>string</amtype></term>
1081 <amdefault>"tapelist"</amdefault>.
1082 The file name for the active &tapelist;.
1083 Amanda maintains this file with information about the active set of tapes.</para>
1087 <term><amkeyword>device-output-buffer-size</amkeyword> <amtype>int</amtype></term>
1090 <amdefault>1280k</amdefault>.
1091 Controls the amount of memory used by Amanda
1092 to hold data as it is read from the network or disk before it is written to
1093 the output device. Higher values may be
1094 useful on fast tape drives and optical media.</para>
1095 <para>The default unit is bytes if it is not specified.</para>
1099 <term><amkeyword>tapebufs</amkeyword> <amtype>int</amtype></term>
1102 <amdefault>20</amdefault>.
1103 This option is deprecated; use
1104 the <amkeyword>device-output-buffer-size</amkeyword> directive
1105 instead. <amkeyword>tapebufs</amkeyword> works the same way,
1106 but the number specified is multiplied by the device blocksize prior
1111 <term><amkeyword>reserve</amkeyword> <amtype>int</amtype></term>
1114 <amdefault>100</amdefault>.
1115 The part of holding-disk space that should be reserved for incremental
1116 backups if no tape is available, expressed as a percentage of the
1117 available holding-disk space (0-100).
1118 By default, when there is no tape to write to, degraded mode (incremental) backups
1119 will be performed to the holding disk. If full backups should also be allowed in this case,
1120 the amount of holding disk space reserved for incrementals should be lowered.</para>
1124 <term><amkeyword>autoflush</amkeyword> <amkeyword>no</amkeyword>|<amkeyword>yes</amkeyword>|<amkeyword>all</amkeyword></term>
1127 <amkeyword>no</amkeyword>.
1128 Whether an amdump run will flush the dumps from holding disk to tape.
1129 With <amkeyword>yes</amkeyword>, only dump matching the command line argument are flushed.
1130 With <amkeyword>all</amkeyword>, all dump are flushed.</para>
1134 <term><amkeyword>amrecover-do-fsf</amkeyword> <amtype>bool</amtype></term>
1136 <para>Deprecated; amrecover always uses fsf, and does not invoke amrestore.</para>
1138 <amkeyword>on</amkeyword>.
1139 Amrecover will call amrestore with the -f flag for faster positioning of the tape.</para>
1143 <term><amkeyword>amrecover-check-label</amkeyword> <amtype>bool</amtype></term>
1145 <para>Deprecated; amrecover always checks the label, and does not invoke amrestore.</para>
1147 <amkeyword>on</amkeyword>.
1148 Amrecover will call amrestore with the -l flag to check the label.</para>
1152 <term><amkeyword>amrecover-changer</amkeyword> <amtype>string</amtype></term>
1154 <para>Default: not set.
1155 Amrecover will use the changer if you use 'settape <string>' and that string
1156 is the same as the <amkeyword>amrecover-changer</amkeyword> setting.</para>
1160 <term><amkeyword>columnspec</amkeyword> <amtype>string</amtype></term>
1162 <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>
1163 <para>Defines the width of columns <emphasis remap='B'>amreport</emphasis>
1165 <emphasis remap='I'>String</emphasis>
1166 is a comma (',') separated list of triples. Each triple consists
1167 of three parts which are separated by a equal sign ('=') and a colon (':') (see the example).
1168 These four parts specify:
1172 <para>the name of the column, which may be:
1175 Compress (compression ratio)
1176 Disk (client disk name)
1177 DumpRate (dump rate in KBytes/sec)
1178 DumpTime (total dump time in hours:minutes)
1179 HostName (client host name)
1181 OrigKB (original image size in KBytes)
1182 OutKB (output image size in KBytes)
1183 TapeRate (tape writing rate in KBytes/sec)
1184 TapeTime (total tape time in hours:minutes)
1185 </programlisting></para>
1190 <para>the amount of space to display before the column (used to get whitespace between columns).</para>
1193 <para>the width of the column itself.
1194 If set to a negative value, the width will be calculated on demand to fit the largest entry in
1198 <para>the precision of the column, number of digit after the decimal point for number.</para>
1200 </orderedlist></para>
1202 <para>Here is an example:
1204 columnspec "Disk=1:18,HostName=0:10,OrigKB=::2,OutKB=1:7"
1205 </programlisting></para>
1207 The above will display the disk information in 18 characters
1208 and put one space before it. The hostname column will be 10 characters wide with
1209 no space to the left. The Original KBytes print 2 decimal digit. The output KBytes column is seven characters wide
1210 with one space before it.</para>
1215 <term><amkeyword>includefile</amkeyword> <amtype>string</amtype></term>
1218 <amdefault>no default</amdefault>.
1219 The name of an Amanda configuration file to include within the current file.
1220 Useful for sharing dumptypes, tapetypes and interface definitions among several configurations.
1221 Relative pathnames are relative to the configuration directory.
1227 <term><amkeyword>debug-days</amkeyword> <amtype>int</amtype></term>
1230 <amdefault>3</amdefault>.
1231 The number of days the debug files are kept.</para>
1236 <term><amkeyword>debug-auth</amkeyword> <amtype>int</amtype></term>
1239 <amdefault>0</amdefault>.
1240 Debug level of the auth module</para>
1245 <term><amkeyword>debug-event</amkeyword> <amtype>int</amtype></term>
1248 <amdefault>0</amdefault>.
1249 Debug level of the event module</para>
1254 <term><amkeyword>debug-holding</amkeyword> <amtype>int</amtype></term>
1257 <amdefault>0</amdefault>.
1258 Debug level of the holdingdisk module</para>
1263 <term><amkeyword>debug-protocol</amkeyword> <amtype>int</amtype></term>
1266 <amdefault>0</amdefault>.
1267 Debug level of the protocol module</para>
1272 <term><amkeyword>debug-planner</amkeyword> <amtype>int</amtype></term>
1275 <amdefault>0</amdefault>.
1276 Debug level of the planner process</para>
1281 <term><amkeyword>debug-driver</amkeyword> <amtype>int</amtype></term>
1284 <amdefault>0</amdefault>.
1285 Debug level of the driver process</para>
1290 <term><amkeyword>debug-dumper</amkeyword> <amtype>int</amtype></term>
1293 <amdefault>0</amdefault>.
1294 Debug level of the dumper process</para>
1299 <term><amkeyword>debug-chunker</amkeyword> <amtype>int</amtype></term>
1302 <amdefault>0</amdefault>.
1303 Debug level of the chunker process</para>
1308 <term><amkeyword>debug-taper</amkeyword> <amtype>int</amtype></term>
1311 <amdefault>0</amdefault>.
1312 Debug level of the taper process</para>
1317 <term><amkeyword>debug-recovery</amkeyword> <amtype>int</amtype></term>
1320 <amdefault>1</amdefault>.
1321 Debug level of all recovery process</para>
1326 <term><amkeyword>flush-threshold-dumped</amkeyword> <amtype>int</amtype></term>
1328 <para>Default: <amdefault>0</amdefault>.
1329 Amanda will not begin writing data to a new volume until the amount of
1330 data on the holding disk is at least this percentage of the volume
1331 size. In other words, Amanda will not begin until the
1332 amount of data on the holding disk is greater than the tape
1333 length times this parameter.
1334 This parameter may be larger than 100%, for example to keep
1335 more recent dumps on the holding disk for faster recovery.</para>
1336 <para> Needless to say, your holding disk must be big enough
1337 that this criterion could be satisfied. If the holding disk cannot
1338 be used for a particular dump (because, for example, there is no
1339 remaining holding space) then Amanda will disregard the constraint
1340 specified by this setting and start a new volume anyway. Once
1341 writing to a volume has begun, this constraint is not applied unless
1342 and until a new volume is needed.</para>
1343 <para> The value of this parameter may not exceed than that of
1344 the <amkeyword>flush-threshold-scheduled</amkeyword>
1350 <term><amkeyword>flush-threshold-scheduled</amkeyword> <amtype>int</amtype></term>
1352 <para>Default: <amdefault>0</amdefault>.
1353 Amanda will not begin writing data to a new volume until the sum of the
1354 amount of data on the holding disk and the estimated amount of data
1355 remaining to be dumped during this run is at least this percentage
1356 of the volume size. In other words, Amanda will not begin until the
1357 inequality <inlineequation><mathphrase>h + s > t ×
1358 d</mathphrase></inlineequation> is satisfied,
1359 where <mathphrase>h</mathphrase> is the amount of data on the
1360 holding disk, <mathphrase>s</mathphrase> is the total amount of
1361 data scheduled for this run but not dumped
1362 yet, <mathphrase>t</mathphrase> is the capacity of a volume,
1363 and <mathphrase>d</mathphrase> is this parameter, expressed as a
1364 percentage. This parameter may be larger than 100%.</para>
1365 <para> Needless to say, your holding disk must be big enough
1366 that this criterion could be satisfied. If the holding disk cannot
1367 be used for a particular dump (because, for example, there is no
1368 remaining holding space) then Amanda will disregard the constraint
1369 specified by this setting and start a new volume anyway. Once
1370 writing to a volume has begun, this constraint is not applied unless
1371 and until a new volume is needed.</para>
1372 <para> The value of this parameter may not be less than that of
1373 the <amkeyword>flush-threshold-dumped</amkeyword>
1374 or <amkeyword>taperflush</amkeyword> parameters.</para>
1378 <!-- the entity '#215' below is U+00D7 MULTIPLICATION SIGN; the 'times' entity
1379 is not as portable as one might hope. -->
1381 <term><amkeyword>taperflush</amkeyword> <amtype>int</amtype></term>
1383 <para>Default: <amdefault>0</amdefault>.
1384 At the end of a run, Amanda will start a new tape to flush remaining
1385 data if there is more data on the holding disk at the end of a run
1386 than this setting allows; the amount is specified as a percentage of
1387 the capacity of a single
1388 volume. In other words, at the end of a run, Amanda will begin
1390 inequality <inlineequation><mathphrase>h > t ×
1391 f</mathphrase></inlineequation> is satisfied,
1392 where <mathphrase>h</mathphrase> is the amount of data remaining on the
1393 holding disk from this or previous runs, <mathphrase>t</mathphrase>
1394 is the capacity of a volume,
1395 and <mathphrase>f</mathphrase> is this parameter, expressed as a
1396 percentage. This parameter may be greater than 100%.</para>
1397 <para> The value of this parameter may not exceed that of
1398 the <amkeyword>flush-threshold-scheduled</amkeyword>
1399 parameter.; <amkeyword>autoflush</amkeyword> must be set to 'yes' if
1400 <amkeyword>taperflush</amkeyword> is greater than 0.</para>
1405 <term><amkeyword>reserved-udp-port</amkeyword> <amtype>int</amtype>,<amtype>int</amtype></term>
1407 <para>Default: --with-udpportrange or
1408 <amdefault>512,1023</amdefault>.
1409 Reserved udp port that will be used (bsd, bsdudp).
1410 Range is inclusive.</para>
1415 <term><amkeyword>reserved-tcp-port</amkeyword> <amtype>int</amtype>,<amtype>int</amtype></term>
1417 <para>Default: --with-low-tcpportrange or
1418 <amdefault>512,1023</amdefault>.
1419 Reserved tcp port that will be used (bsdtcp).
1420 Range is inclusive.</para>
1425 <term><amkeyword>unreserved-tcp-port</amkeyword> <amtype>int</amtype>,<amtype>int</amtype></term>
1427 <para>Default: --with-tcpportrange or
1428 <amdefault>1024,65535</amdefault>.
1429 Unreserved tcp port that will be used (bsd, bsdudp).
1430 Range is inclusive.</para>
1435 <term><amkeyword>recovery-limit</amkeyword> [ <amtype>string</amtype> | <amkeyword>same-host</amkeyword> | <amkeyword>server</amkeyword>]</term>
1437 <para>Default: none (no limitations). This parameter limits the hosts
1438 that may do recoveries. Hosts are identified by their authenticated
1439 peer name, as described in <manref name="amanda-auth" vol="7"/>; if this is
1440 not available and the recovery-limit parameter is present, recovery will be
1441 denied. The arguments to the parameter are strings giving host match
1442 expressions (see <manref name="amanda-match" vol="7"/>) or the special
1443 keywords <amkeyword>same-host</amkeyword> or <amkeyword>server</amkeyword>.
1444 The <amkeyword>same-host</amkeyword> keyword requires an exact
1445 match to the hostname of the DLE being recovered.
1446 The <amkeyword>server</amkeyword> keyword require the connection come from
1447 the fqdn of the server.
1448 Specifying no arguments at all will disable all
1449 recoveries from any host.</para>
1451 <para>Note that match expressions can be constructed to be
1452 forgiving of e.g., fully-qualified vs. unqualified hostnames, but
1453 <amkeyword>same-host</amkeyword> requires an exact match.</para>
1455 <para>The error messages that appear in amrecover are intentionally vague to
1456 avoid information leakage. Consult the amindexd debug log for more details
1457 on the reasons a recovery was rejected.</para>
1459 <para>Recovery limits can be refined on a per-DLE basis using the dumptype
1460 parameter of the same name. Note that the default value will apply to any
1461 dumpfiles for disks which no longer appear in the disklist; thus leaving the
1462 global parameter at its default value but setting it for all DLEs is not
1463 sufficient to maintain secure backups.</para>
1469 <term><amkeyword>tmpdir</amkeyword> <amtype>string</amtype></term>
1471 <para>Default: none (system default). Set it to a directory with lots of free
1472 space if sort in amindexd fail with 'No space left on device'.</para>
1478 <refsect1><title>HOLDINGDISK SECTION</title>
1479 <para>The <emphasis remap='B'>amanda.conf</emphasis>
1480 file may define one or more holding disks used as buffers to hold
1481 backup images before they are written to tape.
1482 The syntax is:</para>
1485 define holdingdisk <emphasis remap='I'>name</emphasis> {
1486 <emphasis remap='I'>holdingdisk-option</emphasis> <emphasis remap='I'>holdingdisk-value</emphasis>
1487 <literal>...</literal>
1491 <para>The { must appear at the end of a line, and the } on its own line.</para>
1492 <para><emphasis remap='I'>Name</emphasis>
1493 is a logical name for this holding disk.</para>
1495 <para>The options and values are:</para>
1497 <variablelist remap='TP'>
1499 <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
1501 <para>Default: not set.
1502 A comment string describing this holding disk.</para>
1507 <term><amkeyword>directory</amkeyword> <amtype>string</amtype></term>
1510 <amdefault>"/dumps/amanda"</amdefault>.
1511 The path to this holding area.</para>
1516 <term><amkeyword>use</amkeyword> <amtype>int</amtype></term>
1519 <amdefault>0 Gb</amdefault>.
1520 Amount of space that can be used in this holding disk area.
1521 If the value is zero, all available space on the file system is used.
1522 If the value is negative, Amanda will use all available space minus that value.</para>
1527 <term><amkeyword>chunksize</amkeyword> <amtype>int</amtype></term>
1530 <amdefault>1 Gb</amdefault>.
1531 Holding disk chunk size. Dumps larger than the specified size will be stored in multiple
1532 holding disk files. The size of each chunk will not exceed the specified value.
1533 However, even though dump images are split in the holding disk, they are concatenated as
1534 they are written to tape, so each dump image still corresponds to a single continuous
1535 tape section.</para>
1536 <para>The default unit is Kbytes if it is not specified.</para>
1538 <para>If 0 is specified, Amanda will create holding disk chunks as large as
1539 ((INT_MAX/1024)-64) Kbytes.</para>
1541 <para>Each holding disk chunk includes a 32 Kbyte header, so the minimum
1542 chunk size is 64 Kbytes (but that would be really silly).</para>
1544 <para>Operating systems that are limited to a maximum file size of 2 Gbytes
1545 actually cannot handle files that large.
1546 They must be at least one byte less than 2 Gbytes.
1547 Since Amanda works with 32 Kbyte blocks, and
1548 to handle the final read at the end of the chunk, the chunk size
1549 should be at least 64 Kbytes (2 * 32 Kbytes) smaller than the maximum
1550 file size, e.g. 2047 Mbytes.</para>
1556 <refsect1><title>DUMPTYPE SECTION</title>
1557 <para>The &amconf; file may define multiple sets of backup options
1558 and refer to them by name from the &disklist; file.
1559 For instance, one set of options might be defined for file systems
1560 that can benefit from high compression, another set that does not compress well,
1561 another set for file systems that should always get a full backup and so on.</para>
1563 <para>A set of backup options are entered in a
1564 <amkeyword>dumptype</amkeyword>
1565 section, which looks like this:</para>
1568 define dumptype "<emphasis remap='I'>name</emphasis>" {
1569 <emphasis remap='I'>dumptype-option</emphasis> <emphasis remap='I'>dumptype-value</emphasis>
1570 <literal>...</literal>
1574 <para>The { must appear at the end of a line, and the } on its own line.</para>
1575 <para><emphasis remap='I'>Name</emphasis>
1576 is the name of this set of backup options.
1577 It is referenced from the &disklist; file.</para>
1579 <para>Some of the options in a
1580 <amkeyword>dumptype</amkeyword>
1581 section are the same as those in the main part of &amconf;.
1582 The main option value is used to set the default for all
1583 <amkeyword>dumptype</amkeyword>
1584 sections. For instance, setting
1585 <amkeyword>dumpcycle</amkeyword>
1586 to 50 in the main part of the config file causes all following
1587 <amkeyword>dumptype</amkeyword>
1588 sections to start with that value,
1589 but the value may be changed on a section by section basis.
1590 Changes to variables in the main part of the config file must be
1591 done before (earlier in the file) any
1592 <amkeyword>dumptype</amkeyword>s
1595 <para>The dumptype options and values are:</para>
1597 <variablelist remap='TP'>
1599 <term><amkeyword>auth</amkeyword> <amtype>string</amtype></term>
1602 <amdefault>"bsdtcp"</amdefault>.
1603 Type of authorization to perform between tape server and backup client hosts. See <manref name="amanda-auth" vol="7"/> for more detail.</para>
1608 <term><amkeyword>amandad-path</amkeyword> <amtype>string</amtype></term>
1611 <amdefault>"$libexec/amandad"</amdefault>.
1612 Specify the amandad path of the client, only use with rsh/ssh authentification.
1618 <term><amkeyword>client-username</amkeyword> <amtype>string</amtype></term>
1621 <amdefault>CLIENT_LOGIN</amdefault>.
1622 Specify the username to connect on the client, only use with rsh/ssh authentification.
1628 <term><amkeyword>client-port</amkeyword> [ <amtype>int</amtype> | <amtype>string</amtype> ]</term>
1631 <amdefault>"amanda"</amdefault>.
1632 Specifies the port to connect to on the client. It can be a service name or a numeric port number.
1638 <!-- bumping parameters yanked from the global section above -->
1641 <term><amkeyword>bumpsize</amkeyword> <amtype>int</amtype></term>
1644 <amdefault>10 Mbytes</amdefault>.
1645 The minimum savings required to trigger an automatic
1646 bump from one incremental level to the next, expressed as size.
1647 If Amanda determines that the next higher backup level
1648 will be this much smaller than the current level,
1649 it will do the next level.
1650 The value of this parameter is used only if the parameter
1651 <emphasis>bumppercent</emphasis> is set to 0.
1653 <para>The default unit is Kbytes if it is not specified.</para>
1655 See also the options
1656 <amkeyword>bumppercent</amkeyword>,
1657 <amkeyword>bumpmult</amkeyword> and
1658 <amkeyword>bumpdays</amkeyword>.</para>
1663 <term><amkeyword>bumppercent</amkeyword> <amtype>int</amtype></term>
1666 <amdefault>0</amdefault>.
1667 The minimum savings required to trigger an automatic
1668 bump from one incremental level to the next, expressed as percentage of the
1669 current size of the DLE (size of current level 0).
1670 If Amanda determines that the next higher backup level
1671 will be this much smaller than the current level,
1672 it will do the next level.
1675 If this parameter is set to 0, the value of the
1676 parameter <emphasis>bumpsize</emphasis> is used to trigger bumping.
1679 See also the options
1680 <amkeyword>bumpsize</amkeyword>,
1681 <amkeyword>bumpmult</amkeyword> and
1682 <amkeyword>bumpdays</amkeyword>.</para>
1687 <term><amkeyword>bumpmult</amkeyword> <amtype>float</amtype></term>
1690 <amdefault>1.5</amdefault>.
1691 The bump size multiplier.
1693 <amkeyword>bumpsize</amkeyword>
1694 by this factor for each level.
1695 This prevents active filesystems from
1696 bumping too much by making it harder to bump to the next level.
1697 For example, with the default
1698 <amkeyword>bumpsize</amkeyword>
1700 <amkeyword>bumpmult</amkeyword>
1701 set to 2.0, the bump threshold will be 10 Mbytes for level one, 20
1702 Mbytes for level two, 40 Mbytes for level three, and so on.</para>
1706 <term><amkeyword>bumpdays</amkeyword> <amtype>int</amtype></term>
1709 <amdefault>2 days</amdefault>.
1710 To insure redundancy in the dumps, Amanda keeps filesystems at the
1711 same incremental level for at least
1712 <amkeyword>bumpdays</amkeyword>
1713 days, even if the other bump threshold criteria are met.</para>
1718 <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
1720 <para>Default: not set.
1721 A comment string describing this set of backup options.</para>
1725 <term><amkeyword>comprate</amkeyword> <amtype>float</amtype> [, <amtype>float</amtype> ]</term>
1728 <amdefault>0.50, 0.50</amdefault>.
1729 The expected full and incremental compression factor for dumps.
1730 It is only used if Amanda does not have any history information on
1731 compression rates for a filesystem, so should not usually need to be set.
1732 However, it may be useful for the first time a very large filesystem that
1733 compresses very little is backed up.</para>
1737 <term><amkeyword>compress</amkeyword> [ <amkeyword>none</amkeyword> | <amkeyword>client</amkeyword> | <amkeyword>server</amkeyword> ] [ <amkeyword>best</amkeyword> | <amkeyword>fast</amkeyword> | <amkeyword>custom</amkeyword> ]</term>
1740 <amkeyword>client fast</amkeyword>.
1741 If Amanda does compression of the backup images, it can do so either on the backup client
1742 host before it crosses the network or on the tape server host as it goes from the
1743 network into the holding disk or to tape. Which place to do compression (if at all) depends on how well the
1744 dump image usually compresses, the speed and load on the client or server, network capacity,
1745 holding disk capacity, availability of tape hardware compression, etc.</para>
1747 <para>For either type of compression, Amanda also allows the selection
1748 of three styles of compression.
1749 <amkeyword>best</amkeyword>
1750 is the best compression available, often at the expense of CPU overhead.
1751 <amkeyword>fast</amkeyword>
1752 is often not as good a compression as
1753 <amkeyword>best</amkeyword>,
1754 but usually less CPU overhead. Or to specify <amkeyword>custom</amkeyword>
1755 to use your own compression method. (See dumptype custom-compress in example/amanda.conf for reference)</para>
1757 <para>So the <amkeyword>compress</amkeyword> options line may be one of:</para>
1759 <variablelist remap='TP'>
1761 <term>compress none</term><listitem><para/></listitem>
1764 <term>compress client fast</term><listitem><para/></listitem>
1767 <term>compress client best</term><listitem><para/></listitem>
1770 <term>compress client custom</term>
1772 <para>Specify <amkeyword>client-custom-compress</amkeyword> "PROG"</para>
1773 <para>PROG must not contain white space and it must accept -d for uncompress.</para>
1777 <term>compress server fast</term><listitem><para/></listitem>
1780 <term>compress server best</term><listitem><para/></listitem>
1783 <term>compress server custom</term>
1785 <para>Specify <amkeyword>server-custom-compress</amkeyword> "PROG"</para>
1786 <para>PROG must not contain white space and it must accept -d for uncompress.</para>
1790 <para>Note that some tape devices do compression and this option has nothing
1791 to do with whether that is used. If hardware compression is used (usually via a particular tape device name
1792 or <emphasis remap='B'>mt</emphasis> option), Amanda (software) compression should be disabled.</para>
1797 <term><amkeyword>client-custom-compress</amkeyword> <amtype>string</amtype></term>
1799 <para>Default: none.
1800 The program to use to perform compression/decompression on the client; used with
1801 "compress client custom". Must not contain whitespace. Must accept -d to uncompress.</para>
1806 <term><amkeyword>server-custom-compress</amkeyword> <amtype>string</amtype></term>
1808 <para>Default: none.
1809 The program to use to perform compression/decompression on the server; used with
1810 "compress server custom". Must not contain whitespace. Must accept -d to uncompress.</para>
1815 <term><amkeyword>dumpcycle</amkeyword> <amtype>int</amtype></term>
1817 <para>Default: <amdefault>10 days</amdefault>.
1818 The number of days in the backup cycle. Each disk using this set of options will get a full
1819 backup at least this of
1820 ten. Setting this to zero tries to do a full backup each run.</para>
1825 <term><amkeyword>encrypt</amkeyword> [ <amkeyword>none</amkeyword> | <amkeyword>client</amkeyword> | <amkeyword>server</amkeyword> ]</term>
1827 <para>Default: not set.
1828 To encrypt backup images, it can do so either on the backup client host before it crosses the network or on the tape
1829 server host as it goes from the network into the holding disk or to tape.</para>
1831 <para>So the <amkeyword>encrypt</amkeyword> options line may be one
1834 <variablelist remap='TP'>
1836 <term>encrypt none</term><listitem><para/></listitem>
1839 <term>encrypt client</term>
1841 <para>Specify client-encrypt "PROG"</para>
1842 <para>PROG must not contain white space.</para>
1843 <para>Specify client-decrypt-option "decryption-parameter" Default: "-d"</para>
1844 <para>decryption-parameter must not contain white space.</para>
1845 <para>(See dumptype client-encrypt-nocomp in example/amanda.conf for reference)</para>
1849 <term>encrypt server</term>
1851 <para>Specify server-encrypt "PROG"</para>
1852 <para>PROG must not contain white space.</para>
1853 <para>Specify server-decrypt-option "decryption-parameter" Default: "-d"</para>
1854 <para>decryption-parameter must not contain white space.</para>
1855 <para>(See dumptype server-encrypt-fast in example/amanda.conf for reference)</para>
1859 <para>Note that current logic assumes compression then encryption during
1860 backup(thus decrypt then uncompress during restore). So specifying
1861 client-encryption AND server-compression is not supported.
1862 <emphasis remap='I'>amcrypt</emphasis> which is a wrapper of
1863 <emphasis remap='I'>aespipe</emphasis> is provided as a reference
1864 symmetric encryption program.</para>
1869 <term><amkeyword>client-encrypt</amkeyword> <amtype>string</amtype></term>
1871 <para>Default: none.
1872 The program to use to perform encryption/decryption on the client; used with
1873 "encrypt client". Must not contain whitespace.</para>
1878 <term><amkeyword>client-decrypt-option</amkeyword> <amtype>string</amtype></term>
1881 The option that can be passed to client-encrypt to make it decrypt instead.
1882 Must not contain whitespace.</para>
1887 <term><amkeyword>server-encrypt</amkeyword> <amtype>string</amtype></term>
1889 <para>Default: none.
1890 The program to use to perform encryption/decryption on the server; used with
1891 "encrypt server". Must not contain whitespace.</para>
1896 <term><amkeyword>server-decrypt-option</amkeyword> <amtype>string</amtype></term>
1899 The option that can be passed to server-encrypt to make it decrypt instead.
1900 Must not contain whitespace.</para>
1905 <term><amkeyword>estimate</amkeyword> [ <amkeyword>client</amkeyword> | <amkeyword>calcsize</amkeyword> | <amkeyword>server</amkeyword> ]+</term>
1907 <para>Default: <amkeyword>client</amkeyword>.
1908 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>
1909 <variablelist remap='TP'>
1913 <para>Use the same program as the dumping program. This is the most
1914 accurate method to do estimates, but it can take a long time.</para>
1918 <term>calcsize</term>
1920 <para>Use a faster program to do estimates, but the result is less
1927 <para>Use only statistics from the previous few runs to give an estimate.
1928 This very quick, but the result is not accurate if your disk
1929 usage changes from day to day. If this method is specified, but the
1930 server does not have enough data to make an estimate, then the option
1931 is internally moved to the end of the list, thereby preferring 'client'
1932 or 'calcsize' in this case.</para>
1941 <term><amkeyword>exclude</amkeyword> [ <amkeyword>list</amkeyword> | <amkeyword>file</amkeyword> ][[<amkeyword>optional</amkeyword>][<amkeyword>append</amkeyword>][ <amtype>string</amtype> ]+]</term>
1944 <amkeyword>file</amkeyword>. Exclude is the opposite of
1945 <amkeyword>include</amkeyword> and specifies files that will be excluded from
1946 the backup. The format of the exclude expressions depends on the application,
1947 and some applications do not support excluding files at all.</para>
1949 <para>There are two exclude parameters,
1950 <amkeyword>exclude</amkeyword> <amkeyword>file</amkeyword>
1952 <amkeyword>exclude</amkeyword> <amkeyword>list.</amkeyword>
1954 <amkeyword>exclude</amkeyword> <amkeyword>file</amkeyword>, the
1955 <amtype>string</amtype>
1956 is an exclude expression. With
1957 <amkeyword>exclude</amkeyword> <amkeyword>list</amkeyword>
1959 <amtype>string</amtype>
1960 is a file name on the client containing &gnutar; exclude expressions.
1961 The path to the specified exclude list file, if present (see description of
1962 'optional' below), must be readable by the Amanda user.</para>
1964 <para>All exclude expressions are concatenated in one file and passed to the
1965 application as an <option>--exclude-from</option> argument.</para>
1967 <para>For &gnutar;, exclude expressions must always be specified as relative to the
1968 top-level directory of the DLE, and must start with "./". See the manpages for individual
1969 applications for more information on supported exclude expressions.</para>
1972 <amkeyword>append</amkeyword> keyword, the
1973 <amtype>string</amtype> is appended to the current list, without it, the
1974 <amtype>string</amtype> overwrites the list.</para>
1976 <para>If <amkeyword>optional</amkeyword>
1977 is specified for <amkeyword>exclude</amkeyword> <amkeyword>list</amkeyword>,
1978 then amcheck will not complain if the file doesn't exist or is not readable.</para>
1980 <para>For <amkeyword>exclude</amkeyword> <amkeyword>list</amkeyword>,
1981 if the file name is relative, the disk name being backed up is prepended.
1982 So if this is entered:</para>
1985 exclude list ".amanda.excludes"
1988 <para>the actual file used would be
1989 <filename>/var/.amanda.excludes</filename>
1990 for a backup of <filename>/var</filename>,
1991 <filename>/usr/local/.amanda.excludes</filename> for a backup of
1992 <filename>/usr/local</filename>, and so on.</para>
1997 <term><amkeyword>holdingdisk</amkeyword> [ <amkeyword>never</amkeyword> | <amkeyword>auto</amkeyword> | <amkeyword>required</amkeyword> ]</term>
2000 <amkeyword>auto</amkeyword>.
2001 Whether a holding disk should be used for these backups or whether they should go directly to tape.
2002 If the holding disk is a portion of another file system that Amanda
2003 is backing up, that file system should refer to a dumptype with
2004 <amkeyword>holdingdisk</amkeyword>
2006 <emphasis remap='I'>never</emphasis>
2007 to avoid backing up the holding disk into itself.</para>
2009 <variablelist remap='TP'>
2011 <term><amkeyword>never</amkeyword>|no|false|off</term>
2013 <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>
2017 <term><amkeyword>auto</amkeyword>|yes|true|on</term>
2019 <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>
2023 <term><amkeyword>required</amkeyword></term>
2025 <para>Always dump to holdingdisk, never directly to tape. There will be no dump if it doesn't fit on holdingdisk</para>
2034 <term><amkeyword>ignore</amkeyword> <amtype>boolean</amtype></term>
2037 <amkeyword>no</amkeyword>.
2038 Whether disks associated with this backup type should be backed up or not.
2039 This option is useful when the
2040 <emphasis remap='I'>disklist</emphasis>
2041 file is shared among several configurations,
2042 some of which should not back up all the listed file systems.</para>
2046 <term><amkeyword>include</amkeyword> [ <amkeyword>list</amkeyword> | <amkeyword>file</amkeyword> ][[<amkeyword>optional</amkeyword>][<amkeyword>append</amkeyword>][ <amtype>string</amtype> ]+]</term>
2049 <amkeyword>file</amkeyword>
2051 There are two include lists,
2052 <amkeyword>include file</amkeyword>
2054 <amkeyword>include list.</amkeyword>
2056 <amkeyword>include file</amkeyword>
2058 <amtype>string</amtype>
2059 is a glob expression. With
2060 <amkeyword>include list</amkeyword>
2062 <amtype>string</amtype>
2063 is a file name on the client containing glob expressions.</para>
2065 <para>All include expressions are expanded by Amanda, concatenated in one file and passed to &gnutar; as a
2066 <option>--files-from</option> argument. They must start with "./" and contain no other "/".</para>
2068 <para>Include expressions must always be specified as relative to the
2069 head directory of the DLE.</para>
2071 <note><para>For globbing to work at all, even the limited single level,
2072 the top level directory of the DLE must be readable by the Amanda user.</para>
2075 <para>With the <amkeyword>append</amkeyword> keyword, the
2076 <amtype>string</amtype> is appended to the current list, without it, the
2077 <amtype>string</amtype> overwrites the list.</para>
2080 <amkeyword>optional</amkeyword> is specified for
2081 <amkeyword>include list</amkeyword>, then amcheck will not complain if the file
2082 doesn't exist or is not readable.</para>
2084 <para>For <amkeyword>include list</amkeyword>,
2085 If the file name is relative, the disk name being backed up is prepended.</para>
2090 <term><amkeyword>index</amkeyword> <amtype>boolean</amtype></term>
2092 <para>Default: <amkeyword>no</amkeyword>.
2093 Whether an index (catalogue) of the backup should be generated and saved in
2094 <amkeyword>indexdir</amkeyword>.
2095 These catalogues are used by the <emphasis remap='B'>amrecover</emphasis> utility.</para>
2100 <term><amkeyword>kencrypt</amkeyword> <amtype>boolean</amtype></term>
2103 <amkeyword>no</amkeyword>.
2104 Whether the backup image should be encrypted by Kerberos as it is sent
2105 across the network from the backup client host to the tape server host.</para>
2109 <term><amkeyword>maxdumps</amkeyword> <amtype>int</amtype></term>
2112 <amdefault>1</amdefault>.
2113 The maximum number of backups from a single host that Amanda will attempt to run in parallel.
2114 See also the main section parameter <amkeyword>inparallel</amkeyword>.</para>
2118 <term><amkeyword>maxpromoteday</amkeyword> <amtype>int</amtype></term>
2121 <amdefault>10000</amdefault>.
2122 The maximum number of day for a promotion, set it 0 if you don't want
2123 promotion, set it to 1 or 2 if your disks get overpromoted.</para>
2127 <term><amkeyword>max-warnings</amkeyword> <amtype>int</amtype></term>
2130 <amdefault>20</amdefault>.
2131 The maximum number of error lines in the report for a dle. A value of '0'
2132 means unlimited. This is useful to reduce the size of the log file and the
2133 size of the report. All errors are put in separate files if a dle have more
2138 <term><amkeyword>priority</amkeyword> [ <amkeyword>low</amkeyword> | <amkeyword>medium</amkeyword> | <amkeyword>high</amkeyword> ]</term>
2140 <para>Default: <amkeyword>medium</amkeyword>.
2141 When there is no tape to write to, Amanda will do incremental backups
2142 in priority order to the holding disk. The priority may be
2143 high (2), medium (1), low (0) or a number of your choice.</para>
2147 <term><amkeyword>program</amkeyword> [ <amkeyword>"DUMP"</amkeyword> | <amkeyword>"GNUTAR"</amkeyword> | <amkeyword>"APPLICATION"</amkeyword> ]</term>
2150 <amdefault>"DUMP"</amdefault>.
2151 The type of backup to perform. Valid values are:</para>
2153 <variablelist remap='TP'>
2155 <term><amkeyword>"DUMP"</amkeyword></term>
2157 <para>The native operating system backup program.</para>
2161 <term><amkeyword>"GNUTAR"</amkeyword></term>
2163 <para>To use GNU-tar or to do PC backups using Samba.</para>
2167 <term><amkeyword>"APPLICATION"</amkeyword></term>
2169 <para>To use an application, see the <emphasis>application</emphasis> option.</para>
2176 <term><amkeyword>application</amkeyword> <amtype>string</amtype></term>
2178 <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>
2182 <term><amkeyword>script</amkeyword> <amtype>string</amtype></term>
2184 <para>No default. Must be the name of a script. You can have many script. See SCRIPT SECTION below.</para>
2188 <term><amkeyword>property</amkeyword> [<amkeyword>append</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
2190 <para>These options can set various properties, they can be used by third
2191 party software to store information in the configuration file.
2192 Both strings are quoted; the first string contains the name of
2193 the property to set, and the others contains its values.
2194 <amkeyword>append</amkeyword> keyword append the values to the list of values for that property.
2200 <term><amkeyword>record</amkeyword> <amtype>boolean</amtype></term>
2203 <amkeyword>yes</amkeyword>.
2204 Whether to ask the backup program to update its database (e.g. <filename>/etc/dumpdates</filename>
2205 for DUMP or <filename>/usr/local/var/amanda/gnutar-lists</filename> for GNUTAR) of time stamps.
2206 This is normally enabled for daily backups and turned off for periodic archival runs.</para>
2210 <term><amkeyword>skip-full</amkeyword> <amtype>boolean</amtype></term>
2213 <amkeyword>no</amkeyword>. If <amkeyword>true</amkeyword> and
2214 <emphasis remap='B'>planner</emphasis> has scheduled a full backup, these disks will be skipped, and
2215 full backups should be run off-line on these days. It was reported that Amanda only schedules
2216 level 1 incrementals in this configuration; this is probably a bug.</para>
2220 <term><amkeyword>skip-incr</amkeyword> <amtype>boolean</amtype></term>
2223 <amkeyword>no</amkeyword>. If <amkeyword>true</amkeyword> and
2224 <emphasis remap='B'>planner</emphasis> has scheduled an incremental backup, these disks will be skipped.</para>
2228 <term><amkeyword>ssh-keys</amkeyword> <amtype>string</amtype></term>
2230 <para>Default: not set.
2231 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>
2235 <term><amkeyword>starttime</amkeyword> <amtype>int</amtype></term>
2237 <para>Default: not set.
2238 Backup of these disks will not start until after this time of day.
2239 The value should be hh*100+mm, e.g. 6:30PM (18:30) would be entered as
2240 <literal>1830</literal>.</para>
2244 <term><amkeyword>strategy</amkeyword> [ <amkeyword>standard</amkeyword> | <amkeyword>nofull</amkeyword> | <amkeyword>noinc</amkeyword> | <amkeyword>skip</amkeyword> | <amkeyword>incronly</amkeyword> ]</term>
2246 <para>Default: <amkeyword>standard</amkeyword>.
2247 Strategy to use when planning what level of backup to run next. Values are:</para>
2249 <variablelist remap='TP'>
2251 <term><amkeyword>standard</amkeyword></term>
2253 <para>The standard Amanda schedule.</para>
2257 <term><amkeyword>nofull</amkeyword></term>
2259 <para>Never do full backups, only level 1 incrementals.</para>
2263 <term><amkeyword>noinc</amkeyword></term>
2265 <para>Never do incremental backups, only full dumps.</para>
2269 <term><amkeyword>skip</amkeyword></term>
2271 <para>Treat this DLE as if it doesn't exist (useful to disable DLEs
2272 when sharing the <emphasis remap='I'>disklist</emphasis> file between
2273 multiple configurations). Skipped DLEs will not be checked or
2274 dumped, and will not be matched by disklist expressions.</para>
2278 <term><amkeyword>incronly</amkeyword></term>
2280 <para>Only do incremental dumps. <command>amadmin force</command> should be used to tell
2281 Amanda that a full dump has been performed off-line, so that it resets to level 1.</para>
2289 <term><amkeyword>allow-split</amkeyword> <amtype>bool</amtype></term>
2291 <para>Default: true.
2292 If true, then dumps with this dumptype can be split on the storage media. If false, then
2293 the dump will be written in a single file on the media. See "Dump Splitting Configuration"
2299 <term><amkeyword>tape-splitsize</amkeyword> <amtype>int</amtype></term>
2301 <para>Deprecated. See "Dump Splitting Configuration" below.</para>
2302 <para>Default: not set.
2303 Split dump file on tape into pieces of a specified size.
2304 The default unit is Kbytes if it is not specified.</para>
2309 <term><amkeyword>split-diskbuffer</amkeyword> <amtype>string</amtype></term>
2310 <para>Deprecated. See "Dump Splitting Configuration" below.</para>
2312 <para>Default: not set.
2313 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.
2319 <term><amkeyword>fallback-splitsize</amkeyword> <amtype>int</amtype></term>
2321 <para>Deprecated. See "Dump Splitting Configuration" below.</para>
2323 <amdefault>10M</amdefault>.
2324 This specifies the part size used when no <amkeyword>split-diskbuffer</amkeyword> is specified, or when it is too small or does not exist,
2325 and thus the maximum amount of memory consumed for in-memory splitting.
2326 The default unit is Kbytes if it is not specified.</para>
2331 <term><amkeyword>recovery-limit</amkeyword>
2332 [ <amkeyword>server</amkeyword> | <amkeyword>same-host</amkeyword> | <amtype>string</amtype> ]*</term>
2335 <para>Default: global value. This parameter overrides the global
2336 <amkeyword>recovery-limit</amkeyword> parameter for DLEs of this
2343 <term><amkeyword>dump-limit</amkeyword>
2344 [ <amkeyword>server</amkeyword> | <amkeyword>same-host</amkeyword> ]*</term>
2347 <para>Default: <amkeyword>server</amkeyword>. Specify which host can initiate
2348 a backup of the dle. With <amkeyword>server</amkeyword>, the server
2349 can initiate a backup with the <command>amdump</command> command.
2350 With <amkeyword>same-host</amkeyword>, the client can initiate a backup with
2351 the <command>amdump_client</command> command.</para>
2357 <para>The following <amkeyword>dumptype</amkeyword> entries are predefined by Amanda:</para>
2359 <programlisting remap='.nf'>
2360 define dumptype "no-compress" {
2363 define dumptype "compress-fast" {
2364 compress client fast
2366 define dumptype "compress-best" {
2367 compress client best
2369 define dumptype "srvcompress" {
2370 compress server fast
2372 define dumptype "bsd-auth" {
2375 define dumptype "bsdtcp-auth" {
2378 define dumptype "no-record" {
2381 define dumptype "no-hold" {
2384 define dumptype "no-full" {
2389 <para>In addition to options in a
2390 <amkeyword>dumptype</amkeyword>
2391 section, one or more other
2392 <amkeyword>dumptype</amkeyword>
2393 names may be supplied as identifiers, which make this
2394 <amkeyword>dumptype</amkeyword>
2395 inherit options from other previously defined
2396 <amkeyword>dumptype</amkeyword>s.
2397 For instance, two sections might be the same except for the
2398 <amkeyword>record</amkeyword> option:</para>
2400 <programlisting remap='.nf'>
2401 define dumptype "normal" {
2402 comment "Normal backup, no compression, do indexing"
2407 define dumptype "testing" {
2408 comment "Test backup, no compression, do indexing, no recording"
2414 <para>Amanda provides a
2415 <amkeyword>dumptype</amkeyword>
2417 <emphasis remap='I'>global</emphasis>
2419 <emphasis remap='B'>amanda.conf</emphasis>
2421 <amkeyword>dumptype</amkeyword>s
2423 This provides an easy place to make changes that will affect every
2424 <amkeyword>dumptype</amkeyword>, although you must be careful
2425 that every dumptype explicitly inherits from the
2426 <emphasis remap='I'>global</emphasis>
2427 dumptype - Amanda does not do so automatically.</para>
2430 <refsect1><title>TAPETYPE SECTION</title>
2431 <para>The <emphasis remap='B'>amanda.conf</emphasis>
2432 file may define multiple types of tape media and devices.
2433 The information is entered in a
2434 <amkeyword>tapetype</amkeyword>
2435 section, which looks like this in the config file:</para>
2438 define tapetype "<amtype>name</amtype>" {
2439 <emphasis remap='I'>tapetype-option</emphasis> <emphasis remap='I'>tapetype-value</emphasis>
2440 <literal>...</literal>
2444 <para>The { must appear at the end of a line, and the } on its own line.</para>
2445 <para><emphasis remap='I'>Name</emphasis>
2446 is the name of this type of tape medium/device.
2447 It is referenced from the
2448 <amkeyword>tapetype</amkeyword>
2449 option in the main part of the config file.</para>
2451 <para>The tapetype options and values are:</para>
2452 <variablelist remap='TP'>
2454 <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
2456 <para>Default: not set.
2457 A comment string describing this set of tape information.</para>
2461 <term><amkeyword>filemark</amkeyword> <amtype>int</amtype></term>
2464 <amdefault>1 kbytes</amdefault>.
2465 How large a file mark (tape mark) is, measured in kbytes.
2466 If the size is only known in some linear measurement (e.g. inches),
2467 convert it to kbytes using the device density.</para>
2471 <term><amkeyword>length</amkeyword> <amtype>int</amtype></term>
2474 <amdefault>2000 kbytes</amdefault>. How much data will fit on a tape, expressed in kbytes.</para>
2476 <para>Note that this value is only used by Amanda to schedule which backups will be run.
2477 Once the backups start, Amanda will continue to write to a tape until it gets an error,
2478 regardless of what value is entered for <amkeyword>length</amkeyword>
2479 (but see <manref name="amanda-devices" vol="7" /> for exceptions).
2485 <term><amkeyword>blocksize</amkeyword> <amtype>int</amtype></term>
2488 <amdefault>32 kbytes</amdefault>.
2489 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>
2493 <term><amkeyword>readblocksize</amkeyword> <amtype>int</amtype></term>
2495 <para>Default: <amdefault>32 kytes</amdefault>
2496 How much data will be read in each tape record. This can be used to override a
2497 device's block size for reads only. This may be useful, for example, in
2498 reading a tape written with a 256k block size when Amanda is configured to use
2499 128k blocks. This unusual feature is not supported by all operating systems and
2502 <para>The default unit is Kbytes if it is not specified.</para>
2507 <term><amkeyword>part-size</amkeyword> <amtype>int</amtype></term>
2509 <para>Default: none. This is the size (in KB if no units are specified) of
2510 each split part written to the volume. It is reduced to
2511 <amkeyword>part-cache-max-size</amkeyword> when part caching is required.
2512 If this is set to zero, then no splitting will take place; in this case,
2513 some devices can span dumps from volume to volume, while others will cause
2514 the entire dump to fail if they encounter end-of-medium before the dump is
2515 complete. See "Dump Splitting Configuration" below.</para>
2520 <term><amkeyword>part-cache-type</amkeyword> [ <amkeyword>none</amkeyword> | <amkeyword>disk</amkeyword> | <amkeyword>memory</amkeyword> ] </term>
2522 <para>Default: none. When part caching is required, this parameter specifies
2523 the type of caching that will be used. The options include no caching
2524 (<amkeyword>none</amkeyword>), in which case a failed part will cause the
2525 entire dump to fail; on-disk caching (<amkeyword>disk</amkeyword>), for
2526 which <amkeyword>part-cache-dir</amkeyword> must be set properly; and
2527 in-memory caching (<amkeyword>memory</amkeyword>), which on most systems
2528 severely restrains the size of the part that can be written. See "Dump
2529 Splitting Configuration" below.</para>
2534 <term><amkeyword>part-cache-dir</amkeyword> <amtype>string</amtype></term>
2536 <para>Default: none.
2537 The directory in which part-cache files can be written when caching on disk.
2538 See "Dump Splitting Configuration" below.</para>
2543 <term><amkeyword>part-cache-max-size</amkeyword> <amtype>int</amtype></term>
2545 <para>Default: none.
2546 The maximum part size to use when caching is in effect. This is used to limit
2547 the part size when disk or memory space for caching is constrained. This value
2548 must be greater than zero.</para>
2553 <term><amkeyword>speed</amkeyword> <amtype>int</amtype></term>
2556 <amdefault>200 bps</amdefault>.
2557 How fast the drive will accept data, in bytes per second.
2558 This parameter is NOT currently used by Amanda.</para>
2562 <term><amkeyword>lbl-templ</amkeyword> <amtype>string</amtype></term>
2564 <para>Default: not set.
2565 A PostScript template file used by
2566 <emphasis remap='B'>amreport</emphasis>
2567 to generate labels. Several sample files are provided with the Amanda sources in the
2568 <emphasis remap='I'>example</emphasis> directory.
2570 <manref name="amreport" vol="8"/>
2571 man page for more information.</para>
2576 <para>In addition to options, another
2577 <amkeyword>tapetype</amkeyword>
2578 name may be supplied as an identifier, which makes this
2579 <amkeyword>tapetype</amkeyword>
2580 inherit options from another
2581 <amkeyword>tapetype</amkeyword>.
2582 For instance, the only difference between a DLT4000 tape drive using
2583 Compact-III tapes and one using Compact-IV tapes is the length of the tape.
2584 So they could be entered as:</para>
2586 <programlisting remap='.nf'>
2587 define tapetype "DLT4000-III" {
2588 comment "DLT4000 tape drives with Compact-III tapes"
2589 length 12500 mbytes # 10 Gig tapes with some compression
2590 filemark 2000 kbytes
2593 define tapetype "DLT4000-IV" {
2595 comment "DLT4000 tape drives with Compact-IV tapes"
2596 length 25000 mbytes # 20 Gig tapes with some compression
2600 <!-- If anybody has read this, where do all those stupid
2601 pseudo-duplicate FOM-tapetype-entries come from??
2607 <refsect1><title>INTERFACE SECTION</title>
2609 <emphasis remap='B'>amanda.conf</emphasis>
2610 file may define multiple types of network interfaces.
2611 The information is entered in an <amkeyword>interface</amkeyword>
2612 section, which looks like this:</para>
2615 define interface "<emphasis remap='I'>name</emphasis>" {
2616 <emphasis remap='I'>interface-option</emphasis> <emphasis remap='I'>interface-value</emphasis>
2617 <literal>...</literal>
2621 <para>The { must appear at the end of a line, and the } on its own line.</para>
2622 <para><emphasis remap='I'>name</emphasis>
2623 is the name of this type of network interface. It is referenced from the
2624 <emphasis remap='I'>disklist</emphasis> file.</para>
2626 <para>Note that these sections define network interface characteristics,
2627 not the actual interface that will be used. Nor do they impose limits on the bandwidth that will
2628 actually be taken up by Amanda.
2629 Amanda computes the estimated bandwidth each file system backup will take
2630 based on the estimated size and time, then compares that plus any other running
2631 backups with the limit as another of the criteria when deciding whether
2632 to start the backup. Once a backup starts, Amanda will use as much of the network as it can
2633 leaving throttling up to the operating system and network hardware.</para>
2635 <para>The interface options and values are:</para>
2636 <variablelist remap='TP'>
2638 <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
2640 <para>Default: not set.
2641 A comment string describing this set of network information.</para>
2645 <term><amkeyword>use</amkeyword> <amtype>int</amtype></term>
2648 <amdefault>80000 Kbps</amdefault>.
2649 The speed of the interface in Kbytes per second.</para>
2654 <para>In addition to options, another
2655 <amkeyword>interface</amkeyword>
2656 name may be supplied as an identifier, which makes this
2657 <amkeyword>interface</amkeyword>
2658 inherit options from another
2659 <amkeyword>interface</amkeyword>.
2660 At the moment, this is of little use.</para>
2663 <refsect1><title>APPLICATION SECTION</title>
2665 <emphasis remap='B'>amanda.conf</emphasis>
2666 file may define multiple types of application.
2667 The information is entered in a <amkeyword>application</amkeyword>
2668 section, which looks like this:</para>
2671 define application "<emphasis remap='I'>name</emphasis>" {
2672 <emphasis remap='I'>application-option</emphasis> <emphasis remap='I'>application-value</emphasis>
2673 <literal>...</literal>
2676 <para>The { must appear at the end of a line, and the } on its own line.</para>
2678 <para><emphasis remap='I'>name</emphasis>
2679 is the name of this type of application. It is referenced from the
2680 <emphasis remap='I'>dumptype</emphasis></para>
2682 <para>The application options and values are:</para>
2683 <variablelist remap='TP'>
2685 <term><amkeyword>client-name</amkeyword> <amtype>string</amtype></term>
2688 specifies an application name that is in the amanda-client.conf on the client.
2689 The setting from that application will be merged with the current application.
2690 If <amkeyword>client-name</amkeyword> is set then it is an error
2691 if that application is not defined on the client.</para>
2692 <para>If <amkeyword>client-name</amkeyword> is not set then the
2693 merge is done with the application that have the name equal to the plugin.
2694 eg. if the plugin is 'amgtar', then the setting from the application 'amgtar'
2695 is used if it is defined.
2700 <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
2702 <para>Default: not set.
2703 A comment string describing this application.</para>
2707 <term><amkeyword>plugin</amkeyword> <amtype>string</amtype></term>
2709 <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>
2713 <term><amkeyword>property</amkeyword> [<amkeyword>append</amkeyword>] [<amkeyword>priority</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
2715 <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
2716 the property to set, and the others contains its values.
2717 <amkeyword>append</amkeyword> keyword append the values to the list of values for that property.
2718 <amkeyword>priority</amkeyword> keyword disallow the setting of that property on the client.
2725 <refsect1><title>SCRIPT SECTION</title>
2727 <emphasis remap='B'>amanda.conf</emphasis>
2728 file may define multiple types of script.
2729 The information is entered in a <amkeyword>script</amkeyword>
2730 section, which looks like this:</para>
2733 define script "<emphasis remap='I'>name</emphasis>" {
2734 <emphasis remap='I'>script-option</emphasis> <emphasis remap='I'>script-value</emphasis>
2735 <literal>...</literal>
2738 <para>The { must appear at the end of a line, and the } on its own line.</para>
2740 <para><emphasis remap='I'>name</emphasis>
2741 is the name of this type of script. It is referenced from the
2742 <emphasis remap='I'>dumptype</emphasis></para>
2744 <para>The script options and values are:</para>
2745 <variablelist remap='TP'>
2747 <term><amkeyword>client-name</amkeyword> <amtype>string</amtype></term>
2750 specifies a script name that is in the amanda-client.conf on the client.
2751 The setting from that script will be merged with the currect script.
2752 If <amkeyword>client-name</amkeyword> is set then it is an error if that script is not defined on the client.</para>
2753 <para>If <amkeyword>client-name</amkeyword> is not set then the
2754 merge is done with the script that have the name equal to the plugin.
2755 eg. if the plugin is 'amlog-script', then the setting from the script
2756 'amlog-script' is used.
2761 <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
2763 <para>Default: not set.
2764 A comment string describing this script.</para>
2768 <term><amkeyword>plugin</amkeyword> <amtype>string</amtype></term>
2770 <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>
2774 <term><amkeyword>order</amkeyword> <amtype>int</amtype></term>
2776 <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>
2780 <term><amkeyword>single-execution</amkeyword> <amtype>boolean</amtype></term>
2782 <para>Default: <amdefault>no</amdefault>. The script is executed for each dle. If <amdefault>yes</amdefault>, the script is executed one time only.</para>
2786 <term><amkeyword>execute-where</amkeyword> [ <amkeyword>client</amkeyword> | <amkeyword>server</amkeyword> ]</term>
2788 <para>Default: <amkeyword>client</amkeyword>. Where the script must be executed, on the client or server.</para>
2792 <term><amkeyword>execute-on</amkeyword> <amtype>execute_on</amtype> [,<amtype>execute_on</amtype>]*</term>
2794 <para>No default. When the script must be executed, you can specify many of them:</para>
2796 <variablelist remap='TP'>
2798 <term><amkeyword>pre-amcheck</amkeyword></term>
2800 <para>Execute before the amcheck command for all dle. Can only be run on server.</para>
2804 <term><amkeyword>pre-dle-amcheck</amkeyword></term>
2806 <para>Execute before the amcheck command for the dle.</para>
2810 <term><amkeyword>pre-host-amcheck</amkeyword></term>
2812 <para>Execute before the amcheck command for all dle for the client.</para>
2816 <term><amkeyword>post-amcheck</amkeyword></term>
2818 <para>Execute after the amcheck command for all dle. Can only be run on server.</para>
2822 <term><amkeyword>post-dle-amcheck</amkeyword></term>
2824 <para>Execute after the amcheck command for the dle.</para>
2828 <term><amkeyword>post-host-amcheck</amkeyword></term>
2830 <para>Execute after the amcheck command for all dle for the client.</para>
2834 <term><amkeyword>pre-estimate</amkeyword></term>
2836 <para>Execute before the estimate command for all dle. Can only be run on server.</para>
2840 <term><amkeyword>pre-dle-estimate</amkeyword></term>
2842 <para>Execute before the estimate command for the dle.</para>
2846 <term><amkeyword>pre-host-estimate</amkeyword></term>
2848 <para>Execute before the estimate command for all dle for the client.</para>
2852 <term><amkeyword>post-estimate</amkeyword></term>
2854 <para>Execute after the estimate command for all dle. Can only be run on server.</para>
2858 <term><amkeyword>post-dle-estimate</amkeyword></term>
2860 <para>Execute after the estimate command for the dle.</para>
2864 <term><amkeyword>post-host-estimate</amkeyword></term>
2866 <para>Execute after the estimate command for all dle for the client.</para>
2870 <term><amkeyword>pre-backup</amkeyword></term>
2872 <para>Execute before the backup command for all dle. Can only be run on server.</para>
2876 <term><amkeyword>pre-dle-backup</amkeyword></term>
2878 <para>Execute before the backup command for the dle.</para>
2882 <term><amkeyword>pre-host-backup</amkeyword></term>
2884 <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>
2888 <term><amkeyword>post-backup</amkeyword></term>
2890 <para>Execute after the backup command for all dle. Can only be run on server.</para>
2894 <term><amkeyword>post-dle-backup</amkeyword></term>
2896 <para>Execute after the backup command for the dle.</para>
2900 <term><amkeyword>post-host-backup</amkeyword></term>
2902 <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>
2906 <term><amkeyword>pre-recover</amkeyword></term>
2908 <para>Execute before any level is recovered.</para>
2912 <term><amkeyword>post-recover</amkeyword></term>
2914 <para>Execute after all levels are recovered.</para>
2918 <term><amkeyword>pre-level-recover</amkeyword></term>
2920 <para>Execute before each level recovery.</para>
2924 <term><amkeyword>post-level-recover</amkeyword></term>
2926 <para>Execute after each level recovery.</para>
2930 <term><amkeyword>inter-level-recover</amkeyword></term>
2932 <para>Execute between two levels of recovery.</para>
2936 <para>If you recover level 0 and 2 of the disk /usr with amrecover, it will execute:</para>
2938 script --pre-recover
2939 script --pre-level-recover --level 0
2941 script --post-level-recover --level 0
2942 script --inter-level-recover --level 0 --level 2
2943 script --pre-level-recover --level 2
2945 script --post-level-recover --level 2
2946 script --post-recover
2951 <term><amkeyword>property</amkeyword> [<amkeyword>append</amkeyword>] [<amkeyword>priority</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
2953 <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
2954 the property to set, and the others contains its values.
2955 <amkeyword>append</amkeyword> keyword append the values to the list of values for that property.
2956 <amkeyword>priority</amkeyword> keyword disallow the setting of that property on the client.
2963 <refsect1><title>DEVICE SECTION</title>
2964 <para>Backend storage devices are specified in
2965 <emphasis remap='B'>amanda.conf</emphasis>
2966 in the form of "device" sections, which look like this:</para>
2969 define device <emphasis remap='I'>name</emphasis> {
2970 commend "<emphasis remap='I'>comment (optional)</emphasis>"
2971 tapedev "<emphasis remap='I'>device-specifier</emphasis>"
2972 device-property "<emphasis remap='I'>prop-name</emphasis>" "<emphasis remap='I'>prop-value</emphasis>"
2973 <literal>...</literal>
2977 <para>The { must appear at the end of a line, and the } on its own line.</para>
2978 <para><emphasis remap='I'>name</emphasis> is the user-specified name of
2979 this device. It is referenced from the global <emphasis
2980 remap='I'>tapedev</emphasis> parameter. The <emphasis
2981 remap='I'>device-specifier</emphasis> specifies the device name to use;
2982 see <manref name="amanda-devices" vol="7"/>.
2983 As with most sections, the <emphasis remap='I'>comment</emphasis>
2984 parmeter is optional and only for the user's convenience.</para>
2986 <para>An arbitrary number of <emphasis
2987 remap='I'>device-property</emphasis> parameters can be specified.
2989 <manref name="amanda-devices" vol="7"/>
2990 for information on device properties.</para>
2994 <refsect1><title>CHANGER SECTION</title>
2995 <para>Changers are described in
2996 <emphasis remap='B'>amanda.conf</emphasis>
2997 in the form of "changer" sections, which look like this:</para>
3000 define changer <emphasis remap='I'>name</emphasis> {
3001 comment "<emphasis remap='I'>comment (optional)</emphasis>"
3002 tpchanger "<emphasis remap='I'>changer-spec</emphasis>"
3003 changerdev "<emphasis remap='I'>device-name</emphasis>"
3004 changerfile "<emphasis remap='I'>state-file</emphasis>"
3005 <literal>...</literal>
3009 <para>The { must appear at the end of a line, and the } on its own line.</para>
3010 <para><emphasis remap='I'>name</emphasis> is the user-specified name of this
3011 device. The remaining parameters are specific to the changer type selected.
3014 <para>See <manref name="amanda-changers" vol="7" /> for more information on configuring changers.</para>
3018 <refsect1><title>INTERACTIVITY SECTION</title>
3020 <emphasis remap='B'>amanda.conf</emphasis>
3021 file may define multiple interactivyt methods, although only one will be used - that specified
3022 by the <amkeyword>interactivity</amkeyword> parameter.
3023 The information is entered in a <amkeyword>interactivity</amkeyword>
3024 section, which looks like this:</para>
3027 define interactivity <emphasis remap='I'>name</emphasis> {
3028 <emphasis remap='I'>interactivity-option</emphasis> <emphasis remap='I'>interactivity-value</emphasis>
3029 <literal>...</literal>
3033 <para>The { must appear at the end of a line, and the } on its own line.</para>
3034 <para><emphasis remap='I'>name</emphasis> is the user-specified name of this
3035 interactivity. The remaining parameters are specific to the interactivity type
3039 <para>The interactivity options and values are:</para>
3040 <variablelist remap='TP'>
3042 <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
3044 <para>Default: not set.
3045 A comment string describing this interactivity.</para>
3049 <term><amkeyword>plugin</amkeyword> <amtype>string</amtype></term>
3051 <para>No default. Must be set to the name of the interactivity module, as described in <manref name="amanda-interactivity" vol="7" />.</para>
3055 <term><amkeyword>property</amkeyword> [<amkeyword>append</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
3057 <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
3058 the property to set, and the others contains its values. All strings should be quoted.
3059 The <amkeyword>append</amkeyword> keyword appends the given values to an existing list of values for that property.
3065 <para>See <manref name="amanda-interactivity" vol="7" /> for more information on configuring interactivity methods.</para>
3069 <refsect1><title>TAPERSCAN SECTION</title>
3071 <emphasis remap='B'>amanda.conf</emphasis>
3072 file may define multiple taperscan methods, although only one will be used - that specified
3073 by the <amkeyword>taperscan</amkeyword> parameter.
3074 The information is entered in a <amkeyword>taperscan</amkeyword>
3075 section, which looks like this:</para>
3078 define taperscan <emphasis remap='I'>name</emphasis> {
3079 <emphasis remap='I'>taperscan-option</emphasis> <emphasis remap='I'>taperscan-value</emphasis>
3080 <literal>...</literal>
3084 <para>The { must appear at the end of a line, and the } on its own line.</para>
3085 <para><emphasis remap='I'>name</emphasis> is the user-specified name of this
3086 taperscan. The remaining parameters are specific to the taperscan type
3090 <para>The taperscan options and values are:</para>
3091 <variablelist remap='TP'>
3093 <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
3095 <para>Default: not set.
3096 A comment string describing this taperscan.</para>
3100 <term><amkeyword>plugin</amkeyword> <amtype>string</amtype></term>
3102 <para>No default. Must be set to the name of the taperscan module. See <manref name="amanda-taperscan" vol="7" /> for a list of defined taperscan modules.</para>
3106 <term><amkeyword>property</amkeyword> [<amkeyword>append</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
3108 <para>No default. Operates just like properties for interactivity methods, above.</para>
3113 <para>See <manref name="amanda-taperscan" vol="7" /> for more information on configuring taperscan.</para>
3117 <refsect1><title>Dump Splitting Configuration</title>
3119 <para>Amanda can "split" dumps into parts while writing them to storage
3120 media. This allows Amanda to recover gracefully from a failure while
3121 writing a part to a volume, by simply selecting a new volume and
3122 re-writing the dump from the beginning of the failed part. Parts also
3123 allow Amanda to seek directly to the required data, although this
3124 functionality is not yet used.</para>
3126 <para>In order to support re-writing from the beginning of a failed part,
3127 Amanda must have access to the contents of the part after it has been
3128 partially written. If the dump is being read from holding disk, then
3129 the part contents are availble there. Otherwise, the part must be
3130 cached, and this can be done memory or on disk. In either of the
3131 latter cases, the cache must have enough space to hold an entire
3134 <para>Because it is common for a single Amanda configuration to use both
3135 holding-disk (FILE-WRITE) and direct (known as PORT-WRITE) dumps, Amanda
3136 allows the configuration of different split sizes for the two cases. This
3137 allows, for example, for a part size appropriate to large tapes when
3138 performing FILE-WRITE dumps, with a part size limited by available disk
3139 or memory when performing PORT-WRITE dumps.</para>
3141 <para>Selecting a proper split size is a delicate matter. If the parts are
3142 too large, substantial storage space may be wasted in failed parts. If
3143 too small, large dumps will be split into innumerable tiny dumpfiles,
3144 adding to restoration complexity; furthermore, an excess of filemarks
3145 will cause slower tape drive operation and reduce the usable space on
3146 tape. A good rule of thumb is 1/10 of the size of a volume of storage
3149 <para>In versions of Amanda through 3.1.*, splitting was controlled by the
3150 dumptype parameters <amkeyword>tape-splitsize</amkeyword>,
3151 <amkeyword>split-diskbuffer</amkeyword>, and
3152 <amkeyword>fallback-splitsize</amkeyword>. These keywords had
3153 confusing and non-intuitive interactions, and have since been
3156 <para>If the deprecated keywords are not present, subsequent versions
3157 of Amanda use the dumptype parameter
3158 <amkeyword>allow-split</amkeyword> to control whether a DLE can be
3159 split, and the <emphasis>tapetype</emphasis> parameters
3160 <amkeyword>part-size</amkeyword>,
3161 <amkeyword>part-cache-type</amkeyword>,
3162 <amkeyword>part-cache-dir</amkeyword>, and
3163 <amkeyword>part-cache-max-size</amkeyword>. The
3164 <amkeyword>part-size</amkeyword> specifies the "normal" part size,
3165 while the <amkeyword>part-cache-*</amkeyword> parameters describe
3166 how to behave when caching is required (on PORT-WRITE). Full
3167 details on these parameters are given above.</para>
3172 <manref name="amanda-client.conf" vol="5"/>,
3173 <manref name="amanda-applications" vol="7"/>,
3174 <manref name="amanda-auth" vol="7"/>,
3175 <manref name="amanda-changers" vol="7"/>,
3176 <manref name="amanda-devices" vol="7"/>,
3177 <manref name="amanda-interactivity" vol="7"/>,
3178 <manref name="amanda-scripts" vol="7"/>
3179 <manref name="amanda-taperscan" vol="7"/>