1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
5 <!-- entities files to use -->
6 <!ENTITY % global_entities SYSTEM 'global.entities'>
10 <refentry id='amanda.conf.5'>
13 <refentrytitle>amanda.conf</refentrytitle>
14 <manvolnum>5</manvolnum>
20 <refname>amanda.conf</refname>
21 <refpurpose>Main configuration file for Amanda, the Advanced Maryland Automatic Network Disk Archiver</refpurpose>
27 <!-- body begins here -->
29 <refsect1><title>DESCRIPTION</title>
30 <para>&amconf; is the main configuration file for Amanda. This manpage lists the
31 relevant sections and parameters of this file for quick reference.</para>
32 <para> The file <emphasis remap='B'><CONFIG_DIR>/<config>/amanda.conf</emphasis> is loaded.</para>
35 <refsect1><title>SYNTAX</title>
37 <para>There are a number of configuration parameters that control the
38 behavior of the Amanda programs.
39 All have default values,
40 so you need not specify the parameter in
41 <emphasis remap='B'>amanda.conf</emphasis>
42 if the default is suitable.</para>
44 <refsect2><title>COMMENTS</title>
46 <para>Lines starting with # are ignored, as are blank lines.
47 Comments may be placed on a line with a directive by starting
49 The remainder of the line is ignored.</para>
52 <refsect2><title>KEYWORDS AND IDENTIFIERS</title>
54 <para>Keywords are case insensitive, i.e.
55 <amkeyword>mailto</amkeyword>
57 <amkeyword>MailTo</amkeyword>
58 are treated the same. Also, the characters
59 '<amkeyword>-</amkeyword>' and '<amkeyword>_</amkeyword>'
60 are interchangeable in all predefined Amanda keywords:
61 <amkeyword>device_property</amkeyword>
63 <amkeyword>device-property</amkeyword>
64 have the same meaning. This manpage uses the dashed versions, but the
65 underscored versions will be accepted for backward compatibility</para>
67 <para>Identifiers are names which are defined in the configuration itself, such
68 as dumptypes or interfaces. Identifiers are are case-insensitive, but
70 '<amkeyword>-</amkeyword>' vs. '<amkeyword>_</amkeyword>'.
71 Identifiers should be quoted in the configuration file, although For historical
72 reasons, the quotes are optional.</para>
74 <para>Strings are always quoted with double quotes ("), and any double quotes
75 or backslashes within the string are escaped with a backslash:
77 tapelist "/path/to/tapelist"
78 property "escaped-string" "escaping: \\ (backslash) and \" (double-quote)"
82 <para>To summarize, then:
85 logdir "logs" # required sensitive sensitive
86 send-amreport-on strange # prohibited insensitive insensitive
87 tapetype "EXABYTE" # optional insensitive sensitive
89 define dumptype "dt" { # optional insensitive sensitive
90 "dumptype-common" # optional insensitive sensitive
91 strategy noinc # prohibited insensitive insensitive
98 <refsect2><title>VALUE SUFFIXES</title>
100 <para>Integer arguments may have one of the following (case insensitive) suffixes,
101 some of which have a multiplier effect:</para>
103 <variablelist remap='TP'>
105 <term><amkeyword>b byte bytes</amkeyword></term>
107 <para>Some number of bytes.</para>
111 <term><amkeyword>bps</amkeyword></term>
113 <para>Some number of bytes per second.</para>
117 <term><amkeyword>k kb kbyte kbytes kilobyte kilobytes</amkeyword></term>
119 <para>Some number of kilobytes (bytes*1024).</para>
123 <term><amkeyword>kps kbps</amkeyword></term>
125 <para>Some number of kilobytes per second (bytes*1024).</para>
126 <para>It is the default multiplier for all size options.</para>
130 <term><amkeyword>m mb meg mbyte mbytes megabyte megabytes</amkeyword></term>
132 <para>Some number of megabytes (bytes*1024*1024).</para>
136 <term><amkeyword>mps mbps</amkeyword></term>
138 <para>Some number of megabytes per second (bytes*1024*1024).</para>
142 <term><amkeyword>g gb gbyte gbytes gigabyte gigabytes</amkeyword></term>
144 <para>Some number of gigabytes (bytes*1024*1024*1024).</para>
148 <term><amkeyword>t tb tbyte tbytes terabyte terabytes</amkeyword></term>
150 <para>Some number of terabytes (bytes*1024*1024*1024*1024).</para>
154 <term><amkeyword>tape tapes</amkeyword></term>
156 <para>Some number of tapes.</para>
160 <term><amkeyword>day days</amkeyword></term>
162 <para>Some number of days.</para>
166 <term><amkeyword>week weeks</amkeyword></term>
168 <para>Some number of weeks (days*7).</para>
170 <note><para>The value
171 <amkeyword>inf</amkeyword>
172 may be used in most places where an integer is expected
173 to mean an infinite amount.</para>
175 <para>Boolean arguments may have any of the values
176 <amkeyword>1</amkeyword>,
177 <amkeyword>y</amkeyword>,
178 <amkeyword>yes</amkeyword>,
179 <amkeyword>t</amkeyword>,
180 <amkeyword>true</amkeyword>
182 <amkeyword>on</amkeyword>
183 to indicate a true state, or
184 <amkeyword>0</amkeyword>,
185 <amkeyword>n</amkeyword>,
186 <amkeyword>no</amkeyword>,
187 <amkeyword>f</amkeyword>,
188 <amkeyword>false</amkeyword>
190 <amkeyword>off</amkeyword>
191 to indicate a false state.
192 If no argument is given,
193 <amkeyword>true</amkeyword>
202 <refsect2><title>PARAMETER ORDER</title>
204 <para>In general, the order in which parameters occur in the configuration file
205 does not matter, with the exception of subsection inheritance. For example, if
206 dumptype "normal-encrypt" which inherits from dumptype "normal", then "normal"
207 must appear first in the configuration file.</para>
211 <refsect2><title>STRINGS</title>
212 <para>Quoted strings in Amanda follow a common, C-like syntax. Printable
213 characters and whitespace are kept as-is, except that the backslash character
214 (\) is used as an escape character, and a double-quote ends the string. The allowed
217 ESCAPE SEQUENCE BECOMES
226 \001 - \377 (character specified in octal)
228 Illegally quoted strings are handled on a "best-effort" basis, which may lead to
233 finserver "/data/finance/XYZ Corp's \"real\" finances" finance-high eth0 -1
234 property "syspath" "C:\\WINDOWS\\SYSTEM"
239 <refsect2><title>SUBSECTIONS AND INHERITANCE</title>
241 <para>Amanda configuration files may include various
242 <emphasis>subsections</emphasis>, each defining a set of configuration
243 directives. Each type of subsection is described below. Note that all types
244 of subsections can <emphasis>inherit</emphasis> from other subsections of the
245 same type by naming the "parent" section in the "child" subsection. For
249 define dumptype global {
254 define dumptype nocomp {
255 global # inherit the parameters in dumptype 'global'
258 </programlisting></para>
260 <para>Note that multiple inheritance is also supported by simply naming
261 multiple parent sections in a child. Parents are implicitly expanded in place
262 in a child, and the last occurrence of each parameter takes precedence. For
265 define tapetype par1 {
271 define tapetype par2 {
276 define tapetype child {
282 In this example, 'child' will have a filemark of 32k, a speed of 400bps, and a
283 length of 200M.</para>
289 <title>GLOBAL PARAMETERS</title>
291 <variablelist remap='TP'>
293 <term><amkeyword>org</amkeyword> <amtype>string</amtype></term>
296 <amdefault>"daily"</amdefault>.
297 A descriptive name for the configuration.
298 This string appears in the Subject line of mail reports.
299 Each Amanda configuration should have a different string to keep
300 mail reports distinct.</para>
304 <term><amkeyword>mailer</amkeyword> <amtype>string</amtype></term>
306 <para>Default found by configure. A mail program that can send mail with '<emphasis remap='I'>MAILER -s "subject" user < message_file</emphasis>'.</para>
310 <term><amkeyword>mailto</amkeyword> <amtype>string</amtype></term>
313 A space separated list of recipients for mail reports. If not specified, amdump will not send any mail.</para>
317 <term><amkeyword>send-amreport-on</amkeyword> [ <amkeyword>all</amkeyword> | <amkeyword>strange</amkeyword> | <amkeyword>error</amkeyword> | <amkeyword>never</amkeyword> ]</term>
320 <amkeyword>all</amkeyword>.
321 Specify which types of messages will trigger an email from amreport. amreport is used by amdump and amflush.</para>
323 <variablelist remap='TP'>
325 <term><amkeyword>all</amkeyword></term>
327 <para>Send an email on any message.</para>
331 <term><amkeyword>strange</amkeyword></term>
333 <para>Send an email on strange or error message. A strange message occurs when the dump succeeded, but returned one or more errors unknown to Amanda.</para>
337 <term><amkeyword>error</amkeyword></term>
339 <para>Send an email only on error messages.</para>
343 <term><amkeyword>never</amkeyword></term>
345 <para>Never send an email.</para>
352 <term><amkeyword>dumpcycle</amkeyword> <amtype>int</amtype></term>
355 <amdefault>10 days</amdefault>.
356 The number of days in the backup cycle.
357 Each disk will get a full backup at least this often.
358 Setting this to zero tries to do a full backup each run.</para>
359 <note><para>This parameter may also be set in a specific
360 <amkeyword>dumptype</amkeyword>
362 This value sets the default for all
363 <amkeyword>dumptype</amkeyword>s
365 <emphasis remap='B'>amanda.conf</emphasis>
367 <amkeyword>dumptype</amkeyword>s
374 <term><amkeyword>runspercycle</amkeyword> <amtype>int</amtype></term>
377 <amdefault>same as dumpcycle</amdefault>.
378 The number of amdump runs in
379 <amkeyword>dumpcycle</amkeyword>
381 A value of 0 means the same value as
382 <amkeyword>dumpcycle</amkeyword>.
383 A value of -1 means guess the number of runs from the &tapelist; file,
384 which is the number of tapes used in the last
385 <amkeyword>dumpcycle</amkeyword>
387 <amkeyword>runtapes</amkeyword>.</para>
391 <term><amkeyword>tapecycle</amkeyword> <amtype>int</amtype></term>
394 <amdefault>15 tapes</amdefault>.
396 Specifies the number of "active" volumes - volumes that Amanda will not
397 overwrite. While Amanda is always willing to write to a new volume, it refuses
398 to overwrite a volume unless at least '<amkeyword>tapecycle</amkeyword> -1'
399 volumes have been written since.</para>
401 <para> It is considered good administrative practice to set the
402 <amkeyword>tapecycle</amkeyword> parameter slightly lower than the actual
403 number of tapes in use. This allows the administrator to more easily cope
404 with damaged or misplaced tapes or schedule adjustments that call for
405 slight adjustments in the rotation order.</para>
407 <para>Note: Amanda is commonly misconfigured with <amkeyword>tapecycle</amkeyword>
408 equal to the number of tapes per <amkeyword>dumpcycle</amkeyword>. In this
409 misconfiguration, amanda may erase a full dump before a new one is
410 completed. Recovery is then impossible. The
411 <amkeyword>tapecycle</amkeyword> must be at least one tape larger than the
412 number of tapes per dumpcycle.</para>
415 The number of tapes per dumpcycle is calculated by multiplying the number of
416 &amdump; runs per dump cycle <amkeyword>runspercycle</amkeyword> (the
417 number of &amdump; runs per dump cycle) and <emphasis
418 remap='B'>runtapes</emphasis> (the number of tapes used per run). Typically
419 <amkeyword>tapecycle</amkeyword> is set to two or four times the tapes
420 per dumpcycle.</para>
426 <term><amkeyword>usetimestamps</amkeyword>
427 <amtype>bool</amtype></term>
429 <para>Default: <amkeyword>Yes</amkeyword>.
430 This option allows Amanda to track multiple runs per calendar
431 day. The only reason one might disable it is that Amanda versions before 2.5.1
432 can't read logfiles written when this option was enabled.
438 <term><amkeyword>label-new-tapes</amkeyword>
439 <amtype>string</amtype></term>
441 <para>Deprecated, use <amkeyword>autolabel</amkeyword> option with options <amkeyword>volume-error empty</amkeyword> to get equivalent behavior.</para>
442 <para>Default: not set.
443 When set, this directive will cause Amanda to automatically write an Amanda
444 tape label to any blank tape she encounters.</para>
449 <term><amkeyword>autolabel</amkeyword>
450 <amtype>string</amtype>
451 [<amkeyword>any</amkeyword>]
452 [<amkeyword>other-config</amkeyword>]
453 [<amkeyword>non-amanda</amkeyword>]
454 [<amkeyword>volume-error</amkeyword>]
455 [<amkeyword>empty</amkeyword>]</term>
457 <para>Default: not set.
458 When set, this directive will cause Amanda to automatically write an Amanda
459 tape label to most volume she encounters. This option is DANGEROUS
460 because when set, Amanda may erase near-failing tapes or tapes accidentally
461 loaded in the wrong slot.</para>
462 <para>When using this directive, specify the template for new tape
463 labels. The template should contain some number of contiguous '%'
464 characters, which will be replaced with a generated number. Be sure to
465 specify enough '%' characters that you do not run out of tape labels.
467 <markup>autolabel "DailySet1-%%%" empty</markup>
469 <para>Note that many devices cannot distinguish an empty tape from an error
470 condition, so it may is often necessary to include
471 <amkeyword>volume-error</amkeyword> as an autolabel condition.</para>
472 <variablelist remap='TP'>
474 <term><amkeyword>any</amkeyword></term>
475 <listitem>equivalent to '<amkeyword>other-config non-amanda volume-error empty</amkeyword>'
479 <term><amkeyword>other-config</amkeyword></term>
480 <listitem>Label volumes with a valid Amanda label that do not match our
481 <amkeyword>labelstr</amkeyword>. Danger: this may erase volumes
482 from other Amanda configurations without warning!
486 <term><amkeyword>non-amanda</amkeyword></term>
487 <listitem>Label volumes which do not start with data that resembles an
488 Amanda header. Danger: this may erase volumes from other backup applications
493 <term><amkeyword>volume-error</amkeyword></term>
494 <listitem>Label volumes where an error occurs while trying to read the label.
495 Danger: this may erase arbitrary volumes due to transient errors.
499 <term><amkeyword>empty</amkeyword></term>
500 <listitem>Label volumes where a read returns 0 bytes.
508 <term><amkeyword>dumpuser</amkeyword> <amtype>string</amtype></term>
511 <amdefault>"amanda"</amdefault>.
512 The login name Amanda uses to run the backups.
513 The backup client hosts must allow access
514 from the tape server host as this user via
515 <markup>.rhosts</markup>
517 <markup>.amandahosts</markup>,
518 depending on how the Amanda software was built.</para>
522 <term><amkeyword>printer</amkeyword> <amtype>string</amtype></term>
524 <para>Printer to use when doing tape labels.
526 <amkeyword>lbl-templ</amkeyword>
527 <amkeyword>tapetype</amkeyword>
533 <term><amkeyword>tapedev</amkeyword> <amtype>string</amtype></term>
536 <amdefault>"null:"</amdefault>.
537 This parameter can either specify a device (explicitly or by referencing a device definition - see <manref name="amanda-devices" vol="7" />)
538 or a tape changer (explicitly or by referencing a device definition - see <manref name="amanda-changers" vol="7" />).</para>
544 <term><amkeyword>device-property</amkeyword> <amtype>string</amtype> <amtype>string</amtype></term>
546 <para>These options can set various device properties. See
547 <manref name="amanda-devices" vol="7"/>
548 for more information on device properties and their syntax.
549 Both strings are always quoted; the first string contains the name of
550 the property to set, and the second contains its value. For example, to set
551 a fixed block size of 128k, write:</para>
553 device-property "BLOCK_SIZE" "128k"
560 <term><amkeyword>property</amkeyword> [<amkeyword>append</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
562 <para>These options can set various properties, they can be used by third
563 party software to store information in the configuration file.
564 Both strings are quoted; the first string contains the name of
565 the property to set, and the others contains its values.
566 <amkeyword>append</amkeyword> keyword append the values to the list of values for that property.
572 <term><amkeyword>tpchanger</amkeyword> <amtype>string</amtype></term>
574 <para>Default: not set. The tape changer to use. In most cases, only one of
575 <amkeyword>tpchanger</amkeyword> or <amkeyword>tapedev</amkeyword> is
576 specified, although for backward compatibility both may be specified if
577 <amkeyword>tpchanger</amkeyword> gives the name of an old changer script.
578 See <manref name="amanda-changers" vol="7" /> for more information on
579 configuring changers.</para>
584 <term><amkeyword>changerdev</amkeyword> <amtype>string</amtype></term>
587 <amdefault>"dev/null"</amdefault>.
588 A tape changer configuration parameter.
589 Usage depends on the particular changer defined with the
590 <amkeyword>tpchanger</amkeyword>
595 <term><amkeyword>changerfile</amkeyword> <amtype>string</amtype></term>
598 <amdefault>"/usr/adm/amanda/log/changer-status"</amdefault>.
599 A tape changer configuration parameter.
600 Usage depends on the particular changer defined with the
601 <amkeyword>tpchanger</amkeyword>
606 <term><amkeyword>runtapes</amkeyword> <amtype>int</amtype></term>
609 <amdefault>1</amdefault>.
610 The maximum number of tapes used in a single run.
611 If a tape changer is not configured, this option is not used
612 and should be commented out of the configuration file.</para>
613 <para>If a tape changer is configured, this may be set larger than one to
614 let Amanda write to more than one tape.</para>
615 <para>Note that this is an upper bound on the number of tapes,
616 and Amanda may use less.</para>
621 <term><amkeyword>maxdumpsize</amkeyword> <amtype>int</amtype></term>
624 <amdefault><amkeyword>runtapes</amkeyword>*<amkeyword>tape-length</amkeyword></amdefault>.
625 Maximum number of bytes the planner will schedule for a run.</para>
626 <para>The default unit is Kbytes if it is not specified.</para>
630 <term><amkeyword>taperalgo</amkeyword> [ <amkeyword>first</amkeyword> | <amkeyword>firstfit</amkeyword> | <amkeyword>largest</amkeyword> | <amkeyword>largestfit</amkeyword> | <amkeyword>smallest</amkeyword> | <amkeyword>last</amkeyword> ]</term>
633 <amkeyword>first</amkeyword>.
634 The algorithm used to choose which dump image to send to the taper.</para>
636 <variablelist remap='TP'>
638 <term><amkeyword>first</amkeyword></term>
640 <para>First in, first out.</para>
644 <term><amkeyword>firstfit</amkeyword></term>
646 <para>The first dump image that will fit on the current tape.</para>
650 <term><amkeyword>largest</amkeyword></term>
652 <para>The largest dump image.</para>
656 <term><amkeyword>largestfit</amkeyword></term>
658 <para>The largest dump image that will fit on the current tape.</para>
662 <term><amkeyword>smallest</amkeyword></term>
664 <para>The smallest dump image.</para>
668 <term><amkeyword>last</amkeyword></term>
670 <para>Last in, first out.</para>
678 <term><amkeyword>taper-parallel-write</amkeyword> <amtype>int</amtype></term>
681 <para>Default: <amdefault>1</amdefault>.
682 Amanda can write simultaneously up to that number of volume at any given
683 time. The changer must have as many drives.</para>
686 <term><amkeyword>labelstr</amkeyword> <amtype>string</amtype></term>
689 <amdefault>".*"</amdefault>.
690 The tape label constraint regular expression.
691 All tape labels generated (see
692 <manref name="amlabel" vol="8"/>)
693 and used by this configuration must match the regular expression.
694 If multiple configurations are run from the same tape server host,
695 it is helpful to set their labels to different strings
696 (for example, "DAILY[0-9][0-9]*" vs.
697 "ARCHIVE[0-9][0-9]*")
698 to avoid overwriting each other's tapes.</para>
702 <term><amkeyword>tapetype</amkeyword> <amtype>string</amtype></term>
705 <amdefault>no default</amdefault>.
706 The type of tape drive associated with
707 <amkeyword>tapedev</amkeyword>
709 <amkeyword>tpchanger</amkeyword>.
710 This refers to one of the defined <amkeyword>tapetype</amkeyword>s
711 in the config file (see below), which specify various tape parameters,
713 <amkeyword>length</amkeyword>,
714 <amkeyword>filemark</amkeyword>
716 <amkeyword>speed</amkeyword>
717 of the tape media and device.</para>
721 <term><amkeyword>ctimeout</amkeyword> <amtype>int</amtype></term>
724 <amdefault>30 seconds</amdefault>.
725 Maximum amount of time that
726 <emphasis remap='B'>amcheck</emphasis>
727 will wait for each client host.</para>
731 <term><amkeyword>dtimeout</amkeyword> <amtype>int</amtype></term>
734 <amdefault>1800 seconds</amdefault>.
735 Amount of idle time per disk on a given client that a
736 <emphasis remap='B'>dumper</emphasis>
738 <command>amdump</command>
739 will wait before it fails with a data timeout error.</para>
744 <term><amkeyword>etimeout</amkeyword> <amtype>int</amtype></term>
747 <amdefault>300 seconds</amdefault>.
748 Amount of time per estimate on a given client that the
749 <emphasis remap='B'>planner</emphasis> step of
750 <command>amdump</command> will wait to get the dump size estimates
751 (note: Amanda runs up to 3 estimates for each DLE). For instance,
752 with the default of 300 seconds and four DLE's, each estimating level
753 0 and level 1 on client A, <emphasis remap='B'>planner</emphasis>
754 will wait up to 40 minutes for that machine. A negative value will
755 be interpreted as a total amount of time to wait
756 per client instead of per disk.</para>
761 <term><amkeyword>connect-tries</amkeyword> <amtype>int</amtype></term>
764 <amdefault>3</amdefault>.
765 How many times the server will try a connection.</para>
770 <term><amkeyword>req-tries</amkeyword> <amtype>int</amtype></term>
773 <amdefault>3</amdefault>.
774 How many times the server will resend a REQ packet if it doesn't get the ACK packet.</para>
779 <term><amkeyword>netusage</amkeyword> <amtype>int</amtype></term>
782 <amdefault>8000 Kbps</amdefault>.
783 The maximum network bandwidth allocated to Amanda, in Kbytes per second.
785 <emphasis remap='B'>interface</emphasis>
790 <term><amkeyword>inparallel</amkeyword> <amtype>int</amtype></term>
793 <amdefault>10</amdefault>.
794 The maximum number of backups that Amanda will attempt to run in parallel.
795 Amanda will stay within the constraints of network bandwidth and
796 holding disk space available, so it doesn't hurt to set
797 this number a bit high. Some contention can occur with larger numbers
798 of backups, but this effect is relatively small on most systems.</para>
803 <term><amkeyword>displayunit</amkeyword> "k|m|g|t"</term>
806 <amdefault>"k"</amdefault>.
807 The unit used to print many numbers, k=kilo, m=mega, g=giga, t=tera.
813 <term><amkeyword>dumporder</amkeyword> <amtype>string</amtype></term>
816 <amdefault>"tttTTTTTTT"</amdefault>.
817 The priority order of each dumper:
824 b: smallest bandwidth
826 </programlisting></para>
832 <term><amkeyword>maxdumps</amkeyword> <amtype>int</amtype></term>
835 <amdefault>1</amdefault>.
836 The maximum number of backups from a single host that Amanda will
837 attempt to run in parallel. See also the
838 <emphasis remap='B'>inparallel</emphasis>
841 <para>Note that this parameter may also be set in a specific
842 <amkeyword>dumptype</amkeyword>
844 This value sets the default for all
845 <amkeyword>dumptype</amkeyword>s
847 <emphasis remap='B'>amanda.conf</emphasis>
849 <amkeyword>dumptype</amkeyword>s
855 <term><amkeyword>bumpsize</amkeyword> <amtype>int</amtype></term>
858 <amdefault>10 Mbytes</amdefault>.
859 The minimum savings required to trigger an automatic
860 bump from one incremental level to the next, expressed as size.
861 If Amanda determines that the next higher backup level
862 will be this much smaller than the current level,
863 it will do the next level.
864 The value of this parameter is used only if the parameter
865 <emphasis>bumppercent</emphasis> is set to 0.
867 <para>The default unit is Kbytes if it is not specified.</para>
869 The global setting of this parameter can be overwritten inside of a
874 <amkeyword>bumppercent</amkeyword>,
875 <amkeyword>bumpmult</amkeyword> and
876 <amkeyword>bumpdays</amkeyword>.</para>
881 <term><amkeyword>bumppercent</amkeyword> <amtype>int</amtype></term>
884 <amdefault>0</amdefault>.
885 The minimum savings required to trigger an automatic
886 bump from one incremental level to the next, expressed as percentage of the
887 current size of the DLE (size of current level 0).
888 If Amanda determines that the next higher backup level
889 will be this much smaller than the current level,
890 it will do the next level.
893 If this parameter is set to 0, the value of the
894 parameter <emphasis>bumpsize</emphasis> is used to trigger bumping.
897 The global setting of this parameter can be overwritten inside of a
902 <amkeyword>bumpsize</amkeyword>,
903 <amkeyword>bumpmult</amkeyword> and
904 <amkeyword>bumpdays</amkeyword>.</para>
909 <term><amkeyword>bumpmult</amkeyword> <amtype>float</amtype></term>
912 <amdefault>1.5</amdefault>.
913 The bump size multiplier.
915 <amkeyword>bumpsize</amkeyword>
916 by this factor for each level.
917 This prevents active filesystems from
918 bumping too much by making it harder to bump to the next level.
919 For example, with the default
920 <amkeyword>bumpsize</amkeyword>
922 <amkeyword>bumpmult</amkeyword>
923 set to 2.0, the bump threshold will be 10 Mbytes for level one, 20
924 Mbytes for level two, 40 Mbytes for level three, and so on.</para>
926 The global setting of this parameter can be overwritten inside of a
932 <term><amkeyword>bumpdays</amkeyword> <amtype>int</amtype></term>
935 <amdefault>2 days</amdefault>.
936 To insure redundancy in the dumps, Amanda keeps filesystems at the
937 same incremental level for at least
938 <amkeyword>bumpdays</amkeyword>
939 days, even if the other bump threshold criteria are met.</para>
941 The global setting of this parameter can be overwritten inside of a
948 <term><amkeyword>diskfile</amkeyword> <amtype>string</amtype></term>
951 <amdefault>"disklist"</amdefault>.
952 The file name for the
953 <emphasis remap='I'>disklist</emphasis>
954 file holding client hosts, disks and other client dumping information.</para>
958 <term><amkeyword>infofile</amkeyword> <amtype>string</amtype></term>
961 <amdefault>"/usr/adm/amanda/curinfo"</amdefault>.
962 The file or directory name for the historical information database.
963 If Amanda was configured to use DBM databases, this is the base file
965 If it was configured to use text formated databases (the default),
966 this is the base directory and within here will be a directory per
967 client, then a directory per disk, then a text file of data.</para>
971 <term><amkeyword>logdir</amkeyword> <amtype>string</amtype></term>
974 <amdefault>"/usr/adm/amanda"</amdefault>.
975 The directory for the
976 <command>amdump</command>
978 <emphasis remap='B'>log</emphasis>
983 <term><amkeyword>indexdir</amkeyword> <amtype>string</amtype></term>
986 <amdefault>"/usr/adm/amanda/index"</amdefault>.
987 The directory where index files (backup image catalogues) are stored.
989 only generated for filesystems whose
990 <amkeyword>dumptype</amkeyword>
992 <amkeyword>index</amkeyword>
993 option enabled.</para>
997 <term><amkeyword>tapelist</amkeyword> <amtype>string</amtype></term>
1000 <amdefault>"tapelist"</amdefault>.
1001 The file name for the active &tapelist;.
1002 Amanda maintains this file with information about the active set of tapes.</para>
1006 <term><amkeyword>device-output-buffer-size</amkeyword> <amtype>int</amtype></term>
1009 <amdefault>1280k</amdefault>.
1010 Controls the amount of memory used by Amanda
1011 to hold data as it is read from the network or disk before it is written to
1012 the output device. Higher values may be
1013 useful on fast tape drives and optical media.</para>
1014 <para>The default unit is bytes if it is not specified.</para>
1018 <term><amkeyword>tapebufs</amkeyword> <amtype>int</amtype></term>
1021 <amdefault>20</amdefault>.
1022 This option is deprecated; use
1023 the <amkeyword>device-output-buffer-size</amkeyword> directive
1024 instead. <amkeyword>tapebufs</amkeyword> works the same way,
1025 but the number specified is multiplied by the device blocksize prior
1030 <term><amkeyword>reserve</amkeyword> <amtype>int</amtype></term>
1033 <amdefault>100</amdefault>.
1034 The part of holding-disk space that should be reserved for incremental
1035 backups if no tape is available, expressed as a percentage of the
1036 available holding-disk space (0-100).
1037 By default, when there is no tape to write to, degraded mode (incremental) backups
1038 will be performed to the holding disk. If full backups should also be allowed in this case,
1039 the amount of holding disk space reserved for incrementals should be lowered.</para>
1043 <term><amkeyword>autoflush</amkeyword> <amtype>bool</amtype></term>
1046 <amkeyword>off</amkeyword>.
1047 Whether an amdump run will flush the dumps from holding disk to tape.</para>
1051 <term><amkeyword>amrecover-do-fsf</amkeyword> <amtype>bool</amtype></term>
1053 <para>Deprecated; amrecover always uses fsf, and does not invoke amrestore.</para>
1055 <amkeyword>on</amkeyword>.
1056 Amrecover will call amrestore with the -f flag for faster positioning of the tape.</para>
1060 <term><amkeyword>amrecover-check-label</amkeyword> <amtype>bool</amtype></term>
1062 <para>Deprecated; amrecover always checks the label, and does not invoke amrestore.</para>
1064 <amkeyword>on</amkeyword>.
1065 Amrecover will call amrestore with the -l flag to check the label.</para>
1069 <term><amkeyword>amrecover-changer</amkeyword> <amtype>string</amtype></term>
1071 <para>Default: not set.
1072 Amrecover will use the changer if you use 'settape <string>' and that string
1073 is the same as the <amkeyword>amrecover-changer</amkeyword> setting.</para>
1077 <term><amkeyword>columnspec</amkeyword> <amtype>string</amtype></term>
1079 <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>
1080 <para>Defines the width of columns <emphasis remap='B'>amreport</emphasis>
1082 <emphasis remap='I'>String</emphasis>
1083 is a comma (',') separated list of triples. Each triple consists
1084 of three parts which are separated by a equal sign ('=') and a colon (':') (see the example).
1085 These four parts specify:
1089 <para>the name of the column, which may be:
1092 Compress (compression ratio)
1093 Disk (client disk name)
1094 DumpRate (dump rate in KBytes/sec)
1095 DumpTime (total dump time in hours:minutes)
1096 HostName (client host name)
1098 OrigKB (original image size in KBytes)
1099 OutKB (output image size in KBytes)
1100 TapeRate (tape writing rate in KBytes/sec)
1101 TapeTime (total tape time in hours:minutes)
1102 </programlisting></para>
1107 <para>the amount of space to display before the column (used to get whitespace between columns).</para>
1110 <para>the width of the column itself.
1111 If set to a negative value, the width will be calculated on demand to fit the largest entry in
1115 <para>the precision of the column, number of digit after the decimal point for number.</para>
1117 </orderedlist></para>
1119 <para>Here is an example:
1121 columnspec "Disk=1:18,HostName=0:10,OrigKB=::2,OutKB=1:7"
1122 </programlisting></para>
1124 The above will display the disk information in 18 characters
1125 and put one space before it. The hostname column will be 10 characters wide with
1126 no space to the left. The Original KBytes print 2 decimal digit. The output KBytes column is seven characters wide
1127 with one space before it.</para>
1132 <term><amkeyword>includefile</amkeyword> <amtype>string</amtype></term>
1135 <amdefault>no default</amdefault>.
1136 The name of an Amanda configuration file to include within the current file.
1137 Useful for sharing dumptypes, tapetypes and interface definitions among several configurations.
1138 Relative pathnames are relative to the configuration directory.
1144 <term><amkeyword>debug-days</amkeyword> <amtype>int</amtype></term>
1147 <amdefault>3</amdefault>.
1148 The number of days the debug files are kept.</para>
1153 <term><amkeyword>debug-auth</amkeyword> <amtype>int</amtype></term>
1156 <amdefault>0</amdefault>.
1157 Debug level of the auth module</para>
1162 <term><amkeyword>debug-event</amkeyword> <amtype>int</amtype></term>
1165 <amdefault>0</amdefault>.
1166 Debug level of the event module</para>
1171 <term><amkeyword>debug-holding</amkeyword> <amtype>int</amtype></term>
1174 <amdefault>0</amdefault>.
1175 Debug level of the holdingdisk module</para>
1180 <term><amkeyword>debug-protocol</amkeyword> <amtype>int</amtype></term>
1183 <amdefault>0</amdefault>.
1184 Debug level of the protocol module</para>
1189 <term><amkeyword>debug-planner</amkeyword> <amtype>int</amtype></term>
1192 <amdefault>0</amdefault>.
1193 Debug level of the planner process</para>
1198 <term><amkeyword>debug-driver</amkeyword> <amtype>int</amtype></term>
1201 <amdefault>0</amdefault>.
1202 Debug level of the driver process</para>
1207 <term><amkeyword>debug-dumper</amkeyword> <amtype>int</amtype></term>
1210 <amdefault>0</amdefault>.
1211 Debug level of the dumper process</para>
1216 <term><amkeyword>debug-chunker</amkeyword> <amtype>int</amtype></term>
1219 <amdefault>0</amdefault>.
1220 Debug level of the chunker process</para>
1225 <term><amkeyword>debug-taper</amkeyword> <amtype>int</amtype></term>
1228 <amdefault>0</amdefault>.
1229 Debug level of the taper process</para>
1234 <term><amkeyword>debug-recovery</amkeyword> <amtype>int</amtype></term>
1237 <amdefault>1</amdefault>.
1238 Debug level of all recovery process</para>
1243 <term><amkeyword>flush-threshold-dumped</amkeyword> <amtype>int</amtype></term>
1245 <para>Default: <amdefault>0</amdefault>.
1246 Amanda will not begin writing data to a new volume until the amount of
1247 data on the holding disk is at least this percentage of the volume
1248 size. In other words, Amanda will not begin until the
1249 amount of data on the holding disk is greater than the tape
1250 length times this parameter.
1251 This parameter may be larger than 100%, for example to keep
1252 more recent dumps on the holding disk for faster recovery.</para>
1253 <para> Needless to say, your holding disk must be big enough
1254 that this criterion could be satisfied. If the holding disk cannot
1255 be used for a particular dump (because, for example, there is no
1256 remaining holding space) then Amanda will disregard the constraint
1257 specified by this setting and start a new volume anyway. Once
1258 writing to a volume has begun, this constraint is not applied unless
1259 and until a new volume is needed.</para>
1260 <para> The value of this parameter may not exceed than that of
1261 the <amkeyword>flush-threshold-scheduled</amkeyword>
1267 <term><amkeyword>flush-threshold-scheduled</amkeyword> <amtype>int</amtype></term>
1269 <para>Default: <amdefault>0</amdefault>.
1270 Amanda will not begin writing data to a new volume until the sum of the
1271 amount of data on the holding disk and the estimated amount of data
1272 remaining to be dumped during this run is at least this percentage
1273 of the volume size. In other words, Amanda will not begin until the
1274 inequality <inlineequation><mathphrase>h + s > t ×
1275 d</mathphrase></inlineequation> is satisfied,
1276 where <mathphrase>h</mathphrase> is the amount of data on the
1277 holding disk, <mathphrase>s</mathphrase> is the total amount of
1278 data scheduled for this run but not dumped
1279 yet, <mathphrase>t</mathphrase> is the capacity of a volume,
1280 and <mathphrase>d</mathphrase> is this parameter, expressed as a
1281 percentage. This parameter may be larger than 100%.</para>
1282 <para> Needless to say, your holding disk must be big enough
1283 that this criterion could be satisfied. If the holding disk cannot
1284 be used for a particular dump (because, for example, there is no
1285 remaining holding space) then Amanda will disregard the constraint
1286 specified by this setting and start a new volume anyway. Once
1287 writing to a volume has begun, this constraint is not applied unless
1288 and until a new volume is needed.</para>
1289 <para> The value of this parameter may not be less than that of
1290 the <amkeyword>flush-threshold-dumped</amkeyword>
1291 or <amkeyword>taperflush</amkeyword> parameters.</para>
1295 <!-- the entity '#215' below is U+00D7 MULTIPLICATION SIGN; the 'times' entity
1296 is not as portable as one might hope. -->
1298 <term><amkeyword>taperflush</amkeyword> <amtype>int</amtype></term>
1300 <para>Default: <amdefault>0</amdefault>.
1301 At the end of a run, Amanda will start a new tape to flush remaining
1302 data if there is more data on the holding disk at the end of a run
1303 than this setting allows; the amount is specified as a percentage of
1304 the capacity of a single
1305 volume. In other words, at the end of a run, Amanda will begin
1307 inequality <inlineequation><mathphrase>h > t ×
1308 f</mathphrase></inlineequation> is satisfied,
1309 where <mathphrase>h</mathphrase> is the amount of data remaining on the
1310 holding disk from this or previous runs, <mathphrase>t</mathphrase>
1311 is the capacity of a volume,
1312 and <mathphrase>f</mathphrase> is this parameter, expressed as a
1313 percentage. This parameter may be greater than 100%.</para>
1314 <para> The value of this parameter may not exceed that of
1315 the <amkeyword>flush-threshold-scheduled</amkeyword>
1316 parameter.; <amkeyword>autoflush</amkeyword> must be set to 'yes' if
1317 <amkeyword>taperflush</amkeyword> is greater than 0.</para>
1322 <term><amkeyword>reserved-udp-port</amkeyword> <amtype>int</amtype>,<amtype>int</amtype></term>
1324 <para>Default: --with-udpportrange or
1325 <amdefault>512,1023</amdefault>.
1326 Reserved udp port that will be used (bsd, bsdudp).
1327 Range is inclusive.</para>
1332 <term><amkeyword>reserved-tcp-port</amkeyword> <amtype>int</amtype>,<amtype>int</amtype></term>
1334 <para>Default: --with-low-tcpportrange or
1335 <amdefault>512,1023</amdefault>.
1336 Reserved tcp port that will be used (bsdtcp).
1337 Range is inclusive.</para>
1342 <term><amkeyword>unreserved-tcp-port</amkeyword> <amtype>int</amtype>,<amtype>int</amtype></term>
1344 <para>Default: --with-tcpportrange or
1345 <amdefault>1024,65535</amdefault>.
1346 Unreserved tcp port that will be used (bsd, bsdudp).
1347 Range is inclusive.</para>
1352 <term><amkeyword>recovery-limit</amkeyword> [ <amtype>string</amtype> | <amkeyword>same-host</amkeyword> ]</term>
1354 <para>Default: none (no limitations). This parameter limits the hosts
1355 that may do remote recoveries. Hosts are identified by their authenticated
1356 peer name, as described in <manref name="amanda-auth" vol="7"/>; if this is
1357 not available and the recovery-limit parameter is present, recovery will be
1358 denied. The arguments to the parameter are strings giving host match
1359 expressions (see <manref name="amanda-match" vol="7"/>) or the special
1360 keyword same-host, which requires an exact match to the hostname of the
1361 DLE being recovered. Specifying no arguments at all will disable all
1362 recoveries from any host.</para>
1364 <para>Note that match expressions can be constructed to be
1365 forgiving of e.g., fully-qualified vs. unqualified hostnames, but
1366 <amkeyword>same-host</amkeyword> requires an exact match.</para>
1368 <para>The error messages that appear in amrecover are intentionally vague to
1369 avoid information leakage. Consult the amindexd debug log for more details
1370 on the reasons a recovery was rejected.</para>
1372 <para>Recovery limits can be refined on a per-DLE basis using the dumptype
1373 parameter of the same name. Note that the default value will apply to any
1374 dumpfiles for disks which no longer appear in the disklist; thus leaving the
1375 global parameter at its default value but setting it for all DLEs is not
1376 sufficient to maintain secure backups.</para>
1384 <refsect1><title>HOLDINGDISK SECTION</title>
1385 <para>The <emphasis remap='B'>amanda.conf</emphasis>
1386 file may define one or more holding disks used as buffers to hold
1387 backup images before they are written to tape.
1388 The syntax is:</para>
1391 define holdingdisk <emphasis remap='I'>name</emphasis> {
1392 <emphasis remap='I'>holdingdisk-option</emphasis> <emphasis remap='I'>holdingdisk-value</emphasis>
1393 <literal>...</literal>
1397 <para>The { must appear at the end of a line, and the } on its own line.</para>
1398 <para><emphasis remap='I'>Name</emphasis>
1399 is a logical name for this holding disk.</para>
1401 <para>The options and values are:</para>
1403 <variablelist remap='TP'>
1405 <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
1407 <para>Default: not set.
1408 A comment string describing this holding disk.</para>
1413 <term><amkeyword>directory</amkeyword> <amtype>string</amtype></term>
1416 <amdefault>"/dumps/amanda"</amdefault>.
1417 The path to this holding area.</para>
1422 <term><amkeyword>use</amkeyword> <amtype>int</amtype></term>
1425 <amdefault>0 Gb</amdefault>.
1426 Amount of space that can be used in this holding disk area.
1427 If the value is zero, all available space on the file system is used.
1428 If the value is negative, Amanda will use all available space minus that value.</para>
1433 <term><amkeyword>chunksize</amkeyword> <amtype>int</amtype></term>
1436 <amdefault>1 Gb</amdefault>.
1437 Holding disk chunk size. Dumps larger than the specified size will be stored in multiple
1438 holding disk files. The size of each chunk will not exceed the specified value.
1439 However, even though dump images are split in the holding disk, they are concatenated as
1440 they are written to tape, so each dump image still corresponds to a single continuous
1441 tape section.</para>
1442 <para>The default unit is Kbytes if it is not specified.</para>
1444 <para>If 0 is specified, Amanda will create holding disk chunks as large as
1445 ((INT_MAX/1024)-64) Kbytes.</para>
1447 <para>Each holding disk chunk includes a 32 Kbyte header, so the minimum
1448 chunk size is 64 Kbytes (but that would be really silly).</para>
1450 <para>Operating systems that are limited to a maximum file size of 2 Gbytes
1451 actually cannot handle files that large.
1452 They must be at least one byte less than 2 Gbytes.
1453 Since Amanda works with 32 Kbyte blocks, and
1454 to handle the final read at the end of the chunk, the chunk size
1455 should be at least 64 Kbytes (2 * 32 Kbytes) smaller than the maximum
1456 file size, e.g. 2047 Mbytes.</para>
1462 <refsect1><title>DUMPTYPE SECTION</title>
1463 <para>The &amconf; file may define multiple sets of backup options
1464 and refer to them by name from the &disklist; file.
1465 For instance, one set of options might be defined for file systems
1466 that can benefit from high compression, another set that does not compress well,
1467 another set for file systems that should always get a full backup and so on.</para>
1469 <para>A set of backup options are entered in a
1470 <amkeyword>dumptype</amkeyword>
1471 section, which looks like this:</para>
1474 define dumptype "<emphasis remap='I'>name</emphasis>" {
1475 <emphasis remap='I'>dumptype-option</emphasis> <emphasis remap='I'>dumptype-value</emphasis>
1476 <literal>...</literal>
1480 <para>The { must appear at the end of a line, and the } on its own line.</para>
1481 <para><emphasis remap='I'>Name</emphasis>
1482 is the name of this set of backup options.
1483 It is referenced from the &disklist; file.</para>
1485 <para>Some of the options in a
1486 <amkeyword>dumptype</amkeyword>
1487 section are the same as those in the main part of &amconf;.
1488 The main option value is used to set the default for all
1489 <amkeyword>dumptype</amkeyword>
1490 sections. For instance, setting
1491 <amkeyword>dumpcycle</amkeyword>
1492 to 50 in the main part of the config file causes all following
1493 <amkeyword>dumptype</amkeyword>
1494 sections to start with that value,
1495 but the value may be changed on a section by section basis.
1496 Changes to variables in the main part of the config file must be
1497 done before (earlier in the file) any
1498 <amkeyword>dumptype</amkeyword>s
1501 <para>The dumptype options and values are:</para>
1503 <variablelist remap='TP'>
1505 <term><amkeyword>auth</amkeyword> <amtype>string</amtype></term>
1508 <amdefault>"bsd"</amdefault>.
1509 Type of authorization to perform between tape server and backup client hosts. See <manref name="amanda-auth" vol="7"/> for more detail.</para>
1514 <term><amkeyword>amandad-path</amkeyword> <amtype>string</amtype></term>
1517 <amdefault>"$libexec/amandad"</amdefault>.
1518 Specify the amandad path of the client, only use with rsh/ssh authentification.
1524 <term><amkeyword>client-username</amkeyword> <amtype>string</amtype></term>
1527 <amdefault>CLIENT_LOGIN</amdefault>.
1528 Specify the username to connect on the client, only use with rsh/ssh authentification.
1534 <term><amkeyword>client-port</amkeyword> [ <amtype>int</amtype> | <amtype>string</amtype> ]</term>
1537 <amdefault>"amanda"</amdefault>.
1538 Specifies the port to connect to on the client. It can be a service name or a numeric port number.
1543 <!-- bumping parameters yanked from the global section above -->
1546 <term><amkeyword>bumpsize</amkeyword> <amtype>int</amtype></term>
1549 <amdefault>10 Mbytes</amdefault>.
1550 The minimum savings required to trigger an automatic
1551 bump from one incremental level to the next, expressed as size.
1552 If Amanda determines that the next higher backup level
1553 will be this much smaller than the current level,
1554 it will do the next level.
1555 The value of this parameter is used only if the parameter
1556 <emphasis>bumppercent</emphasis> is set to 0.
1558 <para>The default unit is Kbytes if it is not specified.</para>
1560 See also the options
1561 <amkeyword>bumppercent</amkeyword>,
1562 <amkeyword>bumpmult</amkeyword> and
1563 <amkeyword>bumpdays</amkeyword>.</para>
1568 <term><amkeyword>bumppercent</amkeyword> <amtype>int</amtype></term>
1571 <amdefault>0</amdefault>.
1572 The minimum savings required to trigger an automatic
1573 bump from one incremental level to the next, expressed as percentage of the
1574 current size of the DLE (size of current level 0).
1575 If Amanda determines that the next higher backup level
1576 will be this much smaller than the current level,
1577 it will do the next level.
1580 If this parameter is set to 0, the value of the
1581 parameter <emphasis>bumpsize</emphasis> is used to trigger bumping.
1584 See also the options
1585 <amkeyword>bumpsize</amkeyword>,
1586 <amkeyword>bumpmult</amkeyword> and
1587 <amkeyword>bumpdays</amkeyword>.</para>
1592 <term><amkeyword>bumpmult</amkeyword> <amtype>float</amtype></term>
1595 <amdefault>1.5</amdefault>.
1596 The bump size multiplier.
1598 <amkeyword>bumpsize</amkeyword>
1599 by this factor for each level.
1600 This prevents active filesystems from
1601 bumping too much by making it harder to bump to the next level.
1602 For example, with the default
1603 <amkeyword>bumpsize</amkeyword>
1605 <amkeyword>bumpmult</amkeyword>
1606 set to 2.0, the bump threshold will be 10 Mbytes for level one, 20
1607 Mbytes for level two, 40 Mbytes for level three, and so on.</para>
1611 <term><amkeyword>bumpdays</amkeyword> <amtype>int</amtype></term>
1614 <amdefault>2 days</amdefault>.
1615 To insure redundancy in the dumps, Amanda keeps filesystems at the
1616 same incremental level for at least
1617 <amkeyword>bumpdays</amkeyword>
1618 days, even if the other bump threshold criteria are met.</para>
1623 <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
1625 <para>Default: not set.
1626 A comment string describing this set of backup options.</para>
1630 <term><amkeyword>comprate</amkeyword> <amtype>float</amtype> [, <amtype>float</amtype> ]</term>
1633 <amdefault>0.50, 0.50</amdefault>.
1634 The expected full and incremental compression factor for dumps.
1635 It is only used if Amanda does not have any history information on
1636 compression rates for a filesystem, so should not usually need to be set.
1637 However, it may be useful for the first time a very large filesystem that
1638 compresses very little is backed up.</para>
1642 <term><amkeyword>compress</amkeyword> [ <amkeyword>none</amkeyword> | <amkeyword>client</amkeyword> | <amkeyword>server</amkeyword> ] [ <amkeyword>best</amkeyword> | <amkeyword>fast</amkeyword> | <amkeyword>custom</amkeyword> ]</term>
1645 <amkeyword>client fast</amkeyword>.
1646 If Amanda does compression of the backup images, it can do so either on the backup client
1647 host before it crosses the network or on the tape server host as it goes from the
1648 network into the holding disk or to tape. Which place to do compression (if at all) depends on how well the
1649 dump image usually compresses, the speed and load on the client or server, network capacity,
1650 holding disk capacity, availability of tape hardware compression, etc.</para>
1652 <para>For either type of compression, Amanda also allows the selection
1653 of three styles of compression.
1654 <amkeyword>best</amkeyword>
1655 is the best compression available, often at the expense of CPU overhead.
1656 <amkeyword>fast</amkeyword>
1657 is often not as good a compression as
1658 <amkeyword>best</amkeyword>,
1659 but usually less CPU overhead. Or to specify <amkeyword>custom</amkeyword>
1660 to use your own compression method. (See dumptype custom-compress in example/amanda.conf for reference)</para>
1662 <para>So the <amkeyword>compress</amkeyword> options line may be one of:</para>
1664 <variablelist remap='TP'>
1666 <term>compress none</term><listitem><para/></listitem>
1669 <term>compress client fast</term><listitem><para/></listitem>
1672 <term>compress client best</term><listitem><para/></listitem>
1675 <term>compress client custom</term>
1677 <para>Specify <amkeyword>client-custom-compress</amkeyword> "PROG"</para>
1678 <para>PROG must not contain white space and it must accept -d for uncompress.</para>
1682 <term>compress server fast</term><listitem><para/></listitem>
1685 <term>compress server best</term><listitem><para/></listitem>
1688 <term>compress server custom</term>
1690 <para>Specify <amkeyword>server-custom-compress</amkeyword> "PROG"</para>
1691 <para>PROG must not contain white space and it must accept -d for uncompress.</para>
1695 <para>Note that some tape devices do compression and this option has nothing
1696 to do with whether that is used. If hardware compression is used (usually via a particular tape device name
1697 or <emphasis remap='B'>mt</emphasis> option), Amanda (software) compression should be disabled.</para>
1702 <term><amkeyword>client-custom-compress</amkeyword> <amtype>string</amtype></term>
1704 <para>Default: none.
1705 The program to use to perform compression/decompression on the client; used with
1706 "compress client custom". Must not contain whitespace. Must accept -d to uncompress.</para>
1711 <term><amkeyword>server-custom-compress</amkeyword> <amtype>string</amtype></term>
1713 <para>Default: none.
1714 The program to use to perform compression/decompression on the server; used with
1715 "compress server custom". Must not contain whitespace. Must accept -d to uncompress.</para>
1720 <term><amkeyword>dumpcycle</amkeyword> <amtype>int</amtype></term>
1722 <para>Default: <amdefault>10 days</amdefault>.
1723 The number of days in the backup cycle. Each disk using this set of options will get a full
1724 backup at least this of
1725 ten. Setting this to zero tries to do a full backup each run.</para>
1730 <term><amkeyword>encrypt</amkeyword> [ <amkeyword>none</amkeyword> | <amkeyword>client</amkeyword> | <amkeyword>server</amkeyword> ]</term>
1732 <para>Default: not set.
1733 To encrypt backup images, it can do so either on the backup client host before it crosses the network or on the tape
1734 server host as it goes from the network into the holding disk or to tape.</para>
1736 <para>So the <amkeyword>encrypt</amkeyword> options line may be one
1739 <variablelist remap='TP'>
1741 <term>encrypt none</term><listitem><para/></listitem>
1744 <term>encrypt client</term>
1746 <para>Specify client-encrypt "PROG"</para>
1747 <para>PROG must not contain white space.</para>
1748 <para>Specify client-decrypt-option "decryption-parameter" Default: "-d"</para>
1749 <para>decryption-parameter must not contain white space.</para>
1750 <para>(See dumptype client-encrypt-nocomp in example/amanda.conf for reference)</para>
1754 <term>encrypt server</term>
1756 <para>Specify server-encrypt "PROG"</para>
1757 <para>PROG must not contain white space.</para>
1758 <para>Specify server-decrypt-option "decryption-parameter" Default: "-d"</para>
1759 <para>decryption-parameter must not contain white space.</para>
1760 <para>(See dumptype server-encrypt-fast in example/amanda.conf for reference)</para>
1764 <para>Note that current logic assumes compression then encryption during
1765 backup(thus decrypt then uncompress during restore). So specifying
1766 client-encryption AND server-compression is not supported.
1767 <emphasis remap='I'>amcrypt</emphasis> which is a wrapper of
1768 <emphasis remap='I'>aespipe</emphasis> is provided as a reference
1769 symmetric encryption program.</para>
1774 <term><amkeyword>client-encrypt</amkeyword> <amtype>string</amtype></term>
1776 <para>Default: none.
1777 The program to use to perform encryption/decryption on the client; used with
1778 "encrypt client". Must not contain whitespace.</para>
1783 <term><amkeyword>client-decrypt-option</amkeyword> <amtype>string</amtype></term>
1786 The option that can be passed to client-encrypt to make it decrypt instead.
1787 Must not contain whitespace.</para>
1792 <term><amkeyword>server-encrypt</amkeyword> <amtype>string</amtype></term>
1794 <para>Default: none.
1795 The program to use to perform encryption/decryption on the server; used with
1796 "encrypt server". Must not contain whitespace.</para>
1801 <term><amkeyword>server-decrypt-option</amkeyword> <amtype>string</amtype></term>
1804 The option that can be passed to server-encrypt to make it decrypt instead.
1805 Must not contain whitespace.</para>
1810 <term><amkeyword>estimate</amkeyword> [ <amkeyword>client</amkeyword> | <amkeyword>calcsize</amkeyword> | <amkeyword>server</amkeyword> ]+</term>
1812 <para>Default: <amkeyword>client</amkeyword>.
1813 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>
1814 <variablelist remap='TP'>
1818 <para>Use the same program as the dumping program. This is the most
1819 accurate method to do estimates, but it can take a long time.</para>
1823 <term>calcsize</term>
1825 <para>Use a faster program to do estimates, but the result is less
1832 <para>Use only statistics from the previous few runs to give an estimate.
1833 This very quick, but the result is not accurate if your disk
1834 usage changes from day to day. If this method is specified, but the
1835 server does not have enough data to make an estimate, then the option
1836 is internally moved to the end of the list, thereby preferring 'client'
1837 or 'calcsize' in this case.</para>
1846 <term><amkeyword>exclude</amkeyword> [ <amkeyword>list</amkeyword> | <amkeyword>file</amkeyword> ][[<amkeyword>optional</amkeyword>][<amkeyword>append</amkeyword>][ <amtype>string</amtype> ]+]</term>
1849 <amkeyword>file</amkeyword>. Exclude is the opposite of
1850 <amkeyword>include</amkeyword> and specifies files that will be excluded from
1851 the backup. The format of the exclude expressions depends on the application,
1852 and some applications do not support excluding files at all.</para>
1854 <para>There are two exclude parameters,
1855 <amkeyword>exclude</amkeyword> <amkeyword>file</amkeyword>
1857 <amkeyword>exclude</amkeyword> <amkeyword>list.</amkeyword>
1859 <amkeyword>exclude</amkeyword> <amkeyword>file</amkeyword>, the
1860 <amtype>string</amtype>
1861 is an exclude expression. With
1862 <amkeyword>exclude</amkeyword> <amkeyword>list</amkeyword>
1864 <amtype>string</amtype>
1865 is a file name on the client containing &gnutar; exclude expressions.
1866 The path to the specified exclude list file, if present (see description of
1867 'optional' below), must be readable by the Amanda user.</para>
1869 <para>All exclude expressions are concatenated in one file and passed to the
1870 application as an <option>--exclude-from</option> argument.</para>
1872 <para>For &gnutar;, exclude expressions must always be specified as relative to the
1873 top-level directory of the DLE, and must start with "./". See the manpages for individual
1874 applications for more information on supported exclude expressions.</para>
1877 <amkeyword>append</amkeyword> keyword, the
1878 <amtype>string</amtype> is appended to the current list, without it, the
1879 <amtype>string</amtype> overwrites the list.</para>
1881 <para>If <amkeyword>optional</amkeyword>
1882 is specified for <amkeyword>exclude</amkeyword> <amkeyword>list</amkeyword>,
1883 then amcheck will not complain if the file doesn't exist or is not readable.</para>
1885 <para>For <amkeyword>exclude</amkeyword> <amkeyword>list</amkeyword>,
1886 if the file name is relative, the disk name being backed up is prepended.
1887 So if this is entered:</para>
1890 exclude list ".amanda.excludes"
1893 <para>the actual file used would be
1894 <filename>/var/.amanda.excludes</filename>
1895 for a backup of <filename>/var</filename>,
1896 <filename>/usr/local/.amanda.excludes</filename> for a backup of
1897 <filename>/usr/local</filename>, and so on.</para>
1902 <term><amkeyword>holdingdisk</amkeyword> [ <amkeyword>never</amkeyword> | <amkeyword>auto</amkeyword> | <amkeyword>required</amkeyword> ]</term>
1905 <amkeyword>auto</amkeyword>.
1906 Whether a holding disk should be used for these backups or whether they should go directly to tape.
1907 If the holding disk is a portion of another file system that Amanda
1908 is backing up, that file system should refer to a dumptype with
1909 <amkeyword>holdingdisk</amkeyword>
1911 <emphasis remap='I'>never</emphasis>
1912 to avoid backing up the holding disk into itself.</para>
1914 <variablelist remap='TP'>
1916 <term><amkeyword>never</amkeyword>|no|false|off</term>
1918 <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>
1922 <term><amkeyword>auto</amkeyword>|yes|true|on</term>
1924 <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>
1928 <term><amkeyword>required</amkeyword></term>
1930 <para>Always dump to holdingdisk, never directly to tape. There will be no dump if it doesn't fit on holdingdisk</para>
1939 <term><amkeyword>ignore</amkeyword> <amtype>boolean</amtype></term>
1942 <amkeyword>no</amkeyword>.
1943 Whether disks associated with this backup type should be backed up or not.
1944 This option is useful when the
1945 <emphasis remap='I'>disklist</emphasis>
1946 file is shared among several configurations,
1947 some of which should not back up all the listed file systems.</para>
1951 <term><amkeyword>include</amkeyword> [ <amkeyword>list</amkeyword> | <amkeyword>file</amkeyword> ][[<amkeyword>optional</amkeyword>][<amkeyword>append</amkeyword>][ <amtype>string</amtype> ]+]</term>
1954 <amkeyword>file</amkeyword>
1956 There are two include lists,
1957 <amkeyword>include file</amkeyword>
1959 <amkeyword>include list.</amkeyword>
1961 <amkeyword>include file</amkeyword>
1963 <amtype>string</amtype>
1964 is a glob expression. With
1965 <amkeyword>include list</amkeyword>
1967 <amtype>string</amtype>
1968 is a file name on the client containing glob expressions.</para>
1970 <para>All include expressions are expanded by Amanda, concatenated in one file and passed to &gnutar; as a
1971 <option>--files-from</option> argument. They must start with "./" and contain no other "/".</para>
1973 <para>Include expressions must always be specified as relative to the
1974 head directory of the DLE.</para>
1976 <note><para>For globbing to work at all, even the limited single level,
1977 the top level directory of the DLE must be readable by the Amanda user.</para>
1980 <para>With the <amkeyword>append</amkeyword> keyword, the
1981 <amtype>string</amtype> is appended to the current list, without it, the
1982 <amtype>string</amtype> overwrites the list.</para>
1985 <amkeyword>optional</amkeyword> is specified for
1986 <amkeyword>include list</amkeyword>, then amcheck will not complain if the file
1987 doesn't exist or is not readable.</para>
1989 <para>For <amkeyword>include list</amkeyword>,
1990 If the file name is relative, the disk name being backed up is prepended.</para>
1995 <term><amkeyword>index</amkeyword> <amtype>boolean</amtype></term>
1997 <para>Default: <amkeyword>no</amkeyword>.
1998 Whether an index (catalogue) of the backup should be generated and saved in
1999 <amkeyword>indexdir</amkeyword>.
2000 These catalogues are used by the <emphasis remap='B'>amrecover</emphasis> utility.</para>
2005 <term><amkeyword>kencrypt</amkeyword> <amtype>boolean</amtype></term>
2008 <amkeyword>no</amkeyword>.
2009 Whether the backup image should be encrypted by Kerberos as it is sent
2010 across the network from the backup client host to the tape server host.</para>
2014 <term><amkeyword>maxdumps</amkeyword> <amtype>int</amtype></term>
2017 <amdefault>1</amdefault>.
2018 The maximum number of backups from a single host that Amanda will attempt to run in parallel.
2019 See also the main section parameter <amkeyword>inparallel</amkeyword>.</para>
2023 <term><amkeyword>maxpromoteday</amkeyword> <amtype>int</amtype></term>
2026 <amdefault>10000</amdefault>.
2027 The maximum number of day for a promotion, set it 0 if you don't want
2028 promotion, set it to 1 or 2 if your disks get overpromoted.</para>
2032 <term><amkeyword>priority</amkeyword> [ <amkeyword>low</amkeyword> | <amkeyword>medium</amkeyword> | <amkeyword>high</amkeyword> ]</term>
2034 <para>Default: <amkeyword>medium</amkeyword>.
2035 When there is no tape to write to, Amanda will do incremental backups
2036 in priority order to the holding disk. The priority may be
2037 high (2), medium (1), low (0) or a number of your choice.</para>
2041 <term><amkeyword>program</amkeyword> [ <amkeyword>"DUMP"</amkeyword> | <amkeyword>"GNUTAR"</amkeyword> | <amkeyword>"APPLICATION"</amkeyword> ]</term>
2044 <amdefault>"DUMP"</amdefault>.
2045 The type of backup to perform. Valid values are:</para>
2047 <variablelist remap='TP'>
2049 <term><amkeyword>"DUMP"</amkeyword></term>
2051 <para>The native operating system backup program.</para>
2055 <term><amkeyword>"GNUTAR"</amkeyword></term>
2057 <para>To use GNU-tar or to do PC backups using Samba.</para>
2061 <term><amkeyword>"APPLICATION"</amkeyword></term>
2063 <para>To use an application, see the <emphasis>application</emphasis> option.</para>
2070 <term><amkeyword>application</amkeyword> <amtype>string</amtype></term>
2072 <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>
2076 <term><amkeyword>script</amkeyword> <amtype>string</amtype></term>
2078 <para>No default. Must be the name of a script. You can have many script. See SCRIPT SECTION below.</para>
2082 <term><amkeyword>property</amkeyword> [<amkeyword>append</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
2084 <para>These options can set various properties, they can be used by third
2085 party software to store information in the configuration file.
2086 Both strings are quoted; the first string contains the name of
2087 the property to set, and the others contains its values.
2088 <amkeyword>append</amkeyword> keyword append the values to the list of values for that property.
2094 <term><amkeyword>record</amkeyword> <amtype>boolean</amtype></term>
2097 <amkeyword>yes</amkeyword>.
2098 Whether to ask the backup program to update its database (e.g. <filename>/etc/dumpdates</filename>
2099 for DUMP or <filename>/usr/local/var/amanda/gnutar-lists</filename> for GNUTAR) of time stamps.
2100 This is normally enabled for daily backups and turned off for periodic archival runs.</para>
2104 <term><amkeyword>skip-full</amkeyword> <amtype>boolean</amtype></term>
2107 <amkeyword>no</amkeyword>. If <amkeyword>true</amkeyword> and
2108 <emphasis remap='B'>planner</emphasis> has scheduled a full backup, these disks will be skipped, and
2109 full backups should be run off-line on these days. It was reported that Amanda only schedules
2110 level 1 incrementals in this configuration; this is probably a bug.</para>
2114 <term><amkeyword>skip-incr</amkeyword> <amtype>boolean</amtype></term>
2117 <amkeyword>no</amkeyword>. If <amkeyword>true</amkeyword> and
2118 <emphasis remap='B'>planner</emphasis> has scheduled an incremental backup, these disks will be skipped.</para>
2122 <term><amkeyword>ssh-keys</amkeyword> <amtype>string</amtype></term>
2124 <para>Default: not set.
2125 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>
2129 <term><amkeyword>starttime</amkeyword> <amtype>int</amtype></term>
2131 <para>Default: not set.
2132 Backup of these disks will not start until after this time of day.
2133 The value should be hh*100+mm, e.g. 6:30PM (18:30) would be entered as
2134 <literal>1830</literal>.</para>
2138 <term><amkeyword>strategy</amkeyword> [ <amkeyword>standard</amkeyword> | <amkeyword>nofull</amkeyword> | <amkeyword>noinc</amkeyword> | <amkeyword>skip</amkeyword> | <amkeyword>incronly</amkeyword> ]</term>
2140 <para>Default: <amkeyword>standard</amkeyword>.
2141 Strategy to use when planning what level of backup to run next. Values are:</para>
2143 <variablelist remap='TP'>
2145 <term><amkeyword>standard</amkeyword></term>
2147 <para>The standard Amanda schedule.</para>
2151 <term><amkeyword>nofull</amkeyword></term>
2153 <para>Never do full backups, only level 1 incrementals.</para>
2157 <term><amkeyword>noinc</amkeyword></term>
2159 <para>Never do incremental backups, only full dumps.</para>
2163 <term><amkeyword>skip</amkeyword></term>
2165 <para>Treat this DLE as if it doesn't exist (useful to disable DLEs
2166 when sharing the <emphasis remap='I'>disklist</emphasis> file between
2167 multiple configurations). Skipped DLEs will not be checked or
2168 dumped, and will not be matched by disklist expressions.</para>
2172 <term><amkeyword>incronly</amkeyword></term>
2174 <para>Only do incremental dumps. <command>amadmin force</command> should be used to tell
2175 Amanda that a full dump has been performed off-line, so that it resets to level 1.</para>
2183 <term><amkeyword>allow-split</amkeyword> <amtype>bool</amtype></term>
2185 <para>Default: true.
2186 If true, then dumps with this dumptype can be split on the storage media. If false, then
2187 the dump will be written in a single file on the media. See "Dump Splitting Configuration"
2193 <term><amkeyword>tape-splitsize</amkeyword> <amtype>int</amtype></term>
2195 <para>Deprecated. See "Dump Splitting Configuration" below.</para>
2196 <para>Default: not set.
2197 Split dump file on tape into pieces of a specified size.
2198 The default unit is Kbytes if it is not specified.</para>
2203 <term><amkeyword>split-diskbuffer</amkeyword> <amtype>string</amtype></term>
2204 <para>Deprecated. See "Dump Splitting Configuration" below.</para>
2206 <para>Default: not set.
2207 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.
2213 <term><amkeyword>fallback-splitsize</amkeyword> <amtype>int</amtype></term>
2215 <para>Deprecated. See "Dump Splitting Configuration" below.</para>
2217 <amdefault>10M</amdefault>.
2218 This specifies the part size used when no <amkeyword>split-diskbuffer</amkeyword> is specified, or when it is too small or does not exist,
2219 and thus the maximum amount of memory consumed for in-memory splitting.
2220 The default unit is Kbytes if it is not specified.</para>
2225 <term><amkeyword>recovery-limit</amkeyword>
2226 [ <amkeyword>same-host</amkeyword> | <amtype>string</amtype> ]*</term>
2229 <para>Default: global value. This parameter overrides the global
2230 <amkeyword>recovery-limit</amkeyword> parameter for DLEs of this
2237 <para>The following <amkeyword>dumptype</amkeyword> entries are predefined by Amanda:</para>
2239 <programlisting remap='.nf'>
2240 define dumptype "no-compress" {
2243 define dumptype "compress-fast" {
2244 compress client fast
2246 define dumptype "compress-best" {
2247 compress client best
2249 define dumptype "srvcompress" {
2250 compress server fast
2252 define dumptype "bsd-auth" {
2255 define dumptype "no-record" {
2258 define dumptype "no-hold" {
2261 define dumptype "no-full" {
2266 <para>In addition to options in a
2267 <amkeyword>dumptype</amkeyword>
2268 section, one or more other
2269 <amkeyword>dumptype</amkeyword>
2270 names may be supplied as identifiers, which make this
2271 <amkeyword>dumptype</amkeyword>
2272 inherit options from other previously defined
2273 <amkeyword>dumptype</amkeyword>s.
2274 For instance, two sections might be the same except for the
2275 <amkeyword>record</amkeyword> option:</para>
2277 <programlisting remap='.nf'>
2278 define dumptype "normal" {
2279 comment "Normal backup, no compression, do indexing"
2284 define dumptype "testing" {
2285 comment "Test backup, no compression, do indexing, no recording"
2291 <para>Amanda provides a
2292 <amkeyword>dumptype</amkeyword>
2294 <emphasis remap='I'>global</emphasis>
2296 <emphasis remap='B'>amanda.conf</emphasis>
2298 <amkeyword>dumptype</amkeyword>s
2300 This provides an easy place to make changes that will affect every
2301 <amkeyword>dumptype</amkeyword>, although you must be careful
2302 that every dumptype explicitly inherits from the
2303 <emphasis remap='I'>global</emphasis>
2304 dumptype - Amanda does not do so automatically.</para>
2307 <refsect1><title>TAPETYPE SECTION</title>
2308 <para>The <emphasis remap='B'>amanda.conf</emphasis>
2309 file may define multiple types of tape media and devices.
2310 The information is entered in a
2311 <amkeyword>tapetype</amkeyword>
2312 section, which looks like this in the config file:</para>
2315 define tapetype "<amtype>name</amtype>" {
2316 <emphasis remap='I'>tapetype-option</emphasis> <emphasis remap='I'>tapetype-value</emphasis>
2317 <literal>...</literal>
2321 <para>The { must appear at the end of a line, and the } on its own line.</para>
2322 <para><emphasis remap='I'>Name</emphasis>
2323 is the name of this type of tape medium/device.
2324 It is referenced from the
2325 <amkeyword>tapetype</amkeyword>
2326 option in the main part of the config file.</para>
2328 <para>The tapetype options and values are:</para>
2329 <variablelist remap='TP'>
2331 <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
2333 <para>Default: not set.
2334 A comment string describing this set of tape information.</para>
2338 <term><amkeyword>filemark</amkeyword> <amtype>int</amtype></term>
2341 <amdefault>1 kbytes</amdefault>.
2342 How large a file mark (tape mark) is, measured in kbytes.
2343 If the size is only known in some linear measurement (e.g. inches),
2344 convert it to kbytes using the device density.</para>
2348 <term><amkeyword>length</amkeyword> <amtype>int</amtype></term>
2351 <amdefault>2000 kbytes</amdefault>. How much data will fit on a tape, expressed in kbytes.</para>
2353 <para>Note that this value is only used by Amanda to schedule which backups will be run.
2354 Once the backups start, Amanda will continue to write to a tape until it gets an error,
2355 regardless of what value is entered for <amkeyword>length</amkeyword>
2356 (but see <manref name="amanda-devices" vol="7" /> for exceptions).
2362 <term><amkeyword>blocksize</amkeyword> <amtype>int</amtype></term>
2365 <amdefault>32 kbytes</amdefault>.
2366 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>
2370 <term><amkeyword>readblocksize</amkeyword> <amtype>int</amtype></term>
2372 <para>Default: <amdefault>32 kytes</amdefault>
2373 How much data will be read in each tape record. This can be used to override a
2374 device's block size for reads only. This may be useful, for example, in
2375 reading a tape written with a 256k block size when Amanda is configured to use
2376 128k blocks. This unusual feature is not supported by all operating systems and
2379 <para>The default unit is Kbytes if it is not specified.</para>
2384 <term><amkeyword>part-size</amkeyword> <amtype>int</amtype></term>
2386 <para>Default: none. This is the size (in KB if no units are specified) of
2387 each split part written to the volume. It is reduced to
2388 <amkeyword>part-cache-max-size</amkeyword> when part caching is required.
2389 If this is set to zero, then no splitting will take place; in this case,
2390 some devices can span dumps from volume to volume, while others will cause
2391 the entire dump to fail if they encounter end-of-medium before the dump is
2392 complete. See "Dump Splitting Configuration" below.</para>
2397 <term><amkeyword>part-cache-type</amkeyword> [ <amkeyword>none</amkeyword> | <amkeyword>disk</amkeyword> | <amkeyword>memory</amkeyword> ] </term>
2399 <para>Default: none. When part caching is required, this parameter specifies
2400 the type of caching that will be used. The options include no caching
2401 (<amkeyword>none</amkeyword>), in which case a failed part will cause the
2402 entire dump to fail; on-disk caching (<amkeyword>disk</amkeyword>), for
2403 which <amkeyword>part-cache-dir</amkeyword> must be set properly; and
2404 in-memory caching (<amkeyword>memory</amkeyword>), which on most systems
2405 severely restrains the size of the part that can be written. See "Dump
2406 Splitting Configuration" below.</para>
2411 <term><amkeyword>part-cache-dir</amkeyword> <amtype>string</amtype></term>
2413 <para>Default: none.
2414 The directory in which part-cache files can be written when caching on disk.
2415 See "Dump Splitting Configuration" below.</para>
2420 <term><amkeyword>part-cache-max-size</amkeyword> <amtype>int</amtype></term>
2422 <para>Default: none.
2423 The maximum part size to use when caching is in effect. This is used to limit
2424 the part size when disk or memory space for caching is constrained. This value
2425 must be greater than zero.</para>
2430 <term><amkeyword>speed</amkeyword> <amtype>int</amtype></term>
2433 <amdefault>200 bps</amdefault>.
2434 How fast the drive will accept data, in bytes per second.
2435 This parameter is NOT currently used by Amanda.</para>
2439 <term><amkeyword>lbl-templ</amkeyword> <amtype>string</amtype></term>
2441 <para>Default: not set.
2442 A PostScript template file used by
2443 <emphasis remap='B'>amreport</emphasis>
2444 to generate labels. Several sample files are provided with the Amanda sources in the
2445 <emphasis remap='I'>example</emphasis> directory.
2447 <manref name="amreport" vol="8"/>
2448 man page for more information.</para>
2453 <para>In addition to options, another
2454 <amkeyword>tapetype</amkeyword>
2455 name may be supplied as an identifier, which makes this
2456 <amkeyword>tapetype</amkeyword>
2457 inherit options from another
2458 <amkeyword>tapetype</amkeyword>.
2459 For instance, the only difference between a DLT4000 tape drive using
2460 Compact-III tapes and one using Compact-IV tapes is the length of the tape.
2461 So they could be entered as:</para>
2463 <programlisting remap='.nf'>
2464 define tapetype "DLT4000-III" {
2465 comment "DLT4000 tape drives with Compact-III tapes"
2466 length 12500 mbytes # 10 Gig tapes with some compression
2467 filemark 2000 kbytes
2470 define tapetype "DLT4000-IV" {
2472 comment "DLT4000 tape drives with Compact-IV tapes"
2473 length 25000 mbytes # 20 Gig tapes with some compression
2477 <!-- If anybody has read this, where do all those stupid
2478 pseudo-duplicate FOM-tapetype-entries come from??
2484 <refsect1><title>INTERFACE SECTION</title>
2486 <emphasis remap='B'>amanda.conf</emphasis>
2487 file may define multiple types of network interfaces.
2488 The information is entered in an <amkeyword>interface</amkeyword>
2489 section, which looks like this:</para>
2492 define interface "<emphasis remap='I'>name</emphasis>" {
2493 <emphasis remap='I'>interface-option</emphasis> <emphasis remap='I'>interface-value</emphasis>
2494 <literal>...</literal>
2498 <para>The { must appear at the end of a line, and the } on its own line.</para>
2499 <para><emphasis remap='I'>name</emphasis>
2500 is the name of this type of network interface. It is referenced from the
2501 <emphasis remap='I'>disklist</emphasis> file.</para>
2503 <para>Note that these sections define network interface characteristics,
2504 not the actual interface that will be used. Nor do they impose limits on the bandwidth that will
2505 actually be taken up by Amanda.
2506 Amanda computes the estimated bandwidth each file system backup will take
2507 based on the estimated size and time, then compares that plus any other running
2508 backups with the limit as another of the criteria when deciding whether
2509 to start the backup. Once a backup starts, Amanda will use as much of the network as it can
2510 leaving throttling up to the operating system and network hardware.</para>
2512 <para>The interface options and values are:</para>
2513 <variablelist remap='TP'>
2515 <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
2517 <para>Default: not set.
2518 A comment string describing this set of network information.</para>
2522 <term><amkeyword>use</amkeyword> <amtype>int</amtype></term>
2525 <amdefault>8000 Kbps</amdefault>.
2526 The speed of the interface in Kbytes per second.</para>
2531 <para>In addition to options, another
2532 <amkeyword>interface</amkeyword>
2533 name may be supplied as an identifier, which makes this
2534 <amkeyword>interface</amkeyword>
2535 inherit options from another
2536 <amkeyword>interface</amkeyword>.
2537 At the moment, this is of little use.</para>
2540 <refsect1><title>APPLICATION SECTION</title>
2542 <emphasis remap='B'>amanda.conf</emphasis>
2543 file may define multiple types of application.
2544 The information is entered in a <amkeyword>application</amkeyword>
2545 section, which looks like this:</para>
2548 define application "<emphasis remap='I'>name</emphasis>" {
2549 <emphasis remap='I'>application-option</emphasis> <emphasis remap='I'>application-value</emphasis>
2550 <literal>...</literal>
2553 <para>The { must appear at the end of a line, and the } on its own line.</para>
2555 <para><emphasis remap='I'>name</emphasis>
2556 is the name of this type of application. It is referenced from the
2557 <emphasis remap='I'>dumptype</emphasis></para>
2559 <para>The application options and values are:</para>
2560 <variablelist remap='TP'>
2562 <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
2564 <para>Default: not set.
2565 A comment string describing this application.</para>
2569 <term><amkeyword>plugin</amkeyword> <amtype>string</amtype></term>
2571 <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>
2575 <term><amkeyword>property</amkeyword> [<amkeyword>append</amkeyword>] [<amkeyword>priority</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
2577 <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
2578 the property to set, and the others contains its values.
2579 <amkeyword>append</amkeyword> keyword append the values to the list of values for that property.
2580 <amkeyword>priority</amkeyword> keyword disallow the setting of that property on the client.
2587 <refsect1><title>SCRIPT SECTION</title>
2589 <emphasis remap='B'>amanda.conf</emphasis>
2590 file may define multiple types of script.
2591 The information is entered in a <amkeyword>script</amkeyword>
2592 section, which looks like this:</para>
2595 define script "<emphasis remap='I'>name</emphasis>" {
2596 <emphasis remap='I'>script-option</emphasis> <emphasis remap='I'>script-value</emphasis>
2597 <literal>...</literal>
2600 <para>The { must appear at the end of a line, and the } on its own line.</para>
2602 <para><emphasis remap='I'>name</emphasis>
2603 is the name of this type of script. It is referenced from the
2604 <emphasis remap='I'>dumptype</emphasis></para>
2606 <para>The script options and values are:</para>
2607 <variablelist remap='TP'>
2609 <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
2611 <para>Default: not set.
2612 A comment string describing this script.</para>
2616 <term><amkeyword>plugin</amkeyword> <amtype>string</amtype></term>
2618 <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>
2622 <term><amkeyword>order</amkeyword> <amtype>int</amtype></term>
2624 <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>
2628 <term><amkeyword>execute-where</amkeyword> [ <amkeyword>client</amkeyword> | <amkeyword>server</amkeyword> ]</term>
2630 <para>Default: <amkeyword>client</amkeyword>. Where the script must be executed, on the client or server.</para>
2634 <term><amkeyword>execute-on</amkeyword> <amtype>execute_on</amtype> [,<amtype>execute_on</amtype>]*</term>
2636 <para>No default. When the script must be executed, you can specify many of them:</para>
2638 <variablelist remap='TP'>
2640 <term><amkeyword>pre-dle-amcheck</amkeyword></term>
2642 <para>Execute before the amcheck command for the dle.</para>
2646 <term><amkeyword>pre-host-amcheck</amkeyword></term>
2648 <para>Execute before the amcheck command for all dle for the client.</para>
2652 <term><amkeyword>post-dle-amcheck</amkeyword></term>
2654 <para>Execute after the amcheck command for the dle.</para>
2658 <term><amkeyword>post-host-amcheck</amkeyword></term>
2660 <para>Execute after the amcheck command for all dle for the client.</para>
2664 <term><amkeyword>pre-dle-estimate</amkeyword></term>
2666 <para>Execute before the estimate command for the dle.</para>
2670 <term><amkeyword>pre-host-estimate</amkeyword></term>
2672 <para>Execute before the estimate command for all dle for the client.</para>
2676 <term><amkeyword>post-dle-estimate</amkeyword></term>
2678 <para>Execute after the estimate command for the dle.</para>
2682 <term><amkeyword>post-host-estimate</amkeyword></term>
2684 <para>Execute after the estimate command for all dle for the client.</para>
2688 <term><amkeyword>pre-dle-backup</amkeyword></term>
2690 <para>Execute before the backup command for the dle.</para>
2694 <term><amkeyword>pre-host-backup</amkeyword></term>
2696 <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>
2700 <term><amkeyword>post-dle-backup</amkeyword></term>
2702 <para>Execute after the backup command for the dle.</para>
2706 <term><amkeyword>post-host-backup</amkeyword></term>
2708 <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>
2712 <term><amkeyword>pre-recover</amkeyword></term>
2714 <para>Execute before any level is recovered.</para>
2718 <term><amkeyword>post-recover</amkeyword></term>
2720 <para>Execute after all levels are recovered.</para>
2724 <term><amkeyword>pre-level-recover</amkeyword></term>
2726 <para>Execute before each level recovery.</para>
2730 <term><amkeyword>post-level-recover</amkeyword></term>
2732 <para>Execute after each level recovery.</para>
2736 <term><amkeyword>inter-level-recover</amkeyword></term>
2738 <para>Execute between two levels of recovery.</para>
2742 <para>If you recover level 0 and 2 of the disk /usr with amrecover, it will execute:</para>
2744 script --pre-recover
2745 script --pre-level-recover --level 0
2747 script --post-level-recover --level 0
2748 script --inter-level-recover --level 0 --level 2
2749 script --pre-level-recover --level 2
2751 script --post-level-recover --level 2
2752 script --post-recover
2757 <term><amkeyword>property</amkeyword> [<amkeyword>append</amkeyword>] [<amkeyword>priority</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
2759 <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
2760 the property to set, and the others contains its values.
2761 <amkeyword>append</amkeyword> keyword append the values to the list of values for that property.
2762 <amkeyword>priority</amkeyword> keyword disallow the setting of that property on the client.
2769 <refsect1><title>DEVICE SECTION</title>
2770 <para>Backend storage devices are specified in
2771 <emphasis remap='B'>amanda.conf</emphasis>
2772 in the form of "device" sections, which look like this:</para>
2775 define device <emphasis remap='I'>name</emphasis> {
2776 commend "<emphasis remap='I'>comment (optional)</emphasis>"
2777 tapedev "<emphasis remap='I'>device-specifier</emphasis>"
2778 device-property "<emphasis remap='I'>prop-name</emphasis>" "<emphasis remap='I'>prop-value</emphasis>"
2779 <literal>...</literal>
2783 <para>The { must appear at the end of a line, and the } on its own line.</para>
2784 <para><emphasis remap='I'>name</emphasis> is the user-specified name of
2785 this device. It is referenced from the global <emphasis
2786 remap='I'>tapedev</emphasis> parameter. The <emphasis
2787 remap='I'>device-specifier</emphasis> specifies the device name to use;
2788 see <manref name="amanda-devices" vol="7"/>.
2789 As with most sections, the <emphasis remap='I'>comment</emphasis>
2790 parmeter is optional and only for the user's convenience.</para>
2792 <para>An arbitrary number of <emphasis
2793 remap='I'>device-property</emphasis> parameters can be specified.
2795 <manref name="amanda-devices" vol="7"/>
2796 for information on device properties.</para>
2800 <refsect1><title>CHANGER SECTION</title>
2801 <para>Changers are described in
2802 <emphasis remap='B'>amanda.conf</emphasis>
2803 in the form of "changer" sections, which look like this:</para>
2806 define changer <emphasis remap='I'>name</emphasis> {
2807 comment "<emphasis remap='I'>comment (optional)</emphasis>"
2808 tpchanger "<emphasis remap='I'>changer-spec</emphasis>"
2809 changerdev "<emphasis remap='I'>device-name</emphasis>"
2810 changerfile "<emphasis remap='I'>state-file</emphasis>"
2811 <literal>...</literal>
2815 <para>The { must appear at the end of a line, and the } on its own line.</para>
2816 <para><emphasis remap='I'>name</emphasis> is the user-specified name of this
2817 device. The remaining parameters are specific to the changer type selected.
2820 <para>See <manref name="amanda-changers" vol="7" /> for more information on configuring changers.</para>
2824 <refsect1><title>Dump Splitting Configuration</title>
2826 <para>Amanda can "split" dumps into parts while writing them to storage
2827 media. This allows Amanda to recover gracefully from a failure while
2828 writing a part to a volume, by simply selecting a new volume and
2829 re-writing the dump from the beginning of the failed part. Parts also
2830 allow Amanda to seek directly to the required data, although this
2831 functionality is not yet used.</para>
2833 <para>In order to support re-writing from the beginning of a failed part,
2834 Amanda must have access to the contents of the part after it has been
2835 partially written. If the dump is being read from holding disk, then
2836 the part contents are availble there. Otherwise, the part must be
2837 cached, and this can be done memory or on disk. In either of the
2838 latter cases, the cache must have enough space to hold an entire
2841 <para>Because it is common for a single Amanda configuration to use both
2842 holding-disk (FILE-WRITE) and direct (known as PORT-WRITE) dumps, Amanda
2843 allows the configuration of different split sizes for the two cases. This
2844 allows, for example, for a part size appropriate to large tapes when
2845 performing FILE-WRITE dumps, with a part size limited by available disk
2846 or memory when performing PORT-WRITE dumps.</para>
2848 <para>Selecting a proper split size is a delicate matter. If the parts are
2849 too large, substantial storage space may be wasted in failed parts. If
2850 too small, large dumps will be split into innumerable tiny dumpfiles,
2851 adding to restoration complexity; furthermore, an excess of filemarks
2852 will cause slower tape drive operation and reduce the usable space on
2853 tape. A good rule of thumb is 1/10 of the size of a volume of storage
2856 <para>In versions of Amanda through 3.1.*, splitting was controlled by the
2857 dumptype parameters <amkeyword>tape-splitsize</amkeyword>,
2858 <amkeyword>split-diskbuffer</amkeyword>, and
2859 <amkeyword>fallback-splitsize</amkeyword>. These keywords had
2860 confusing and non-intuitive interactions, and have since been
2863 <para>If the deprecated keywords are not present, subsequent versions
2864 of Amanda use the dumptype parameter
2865 <amkeyword>allow-split</amkeyword> to control whether a DLE can be
2866 split, and the <emphasis>tapetype</emphasis> parameters
2867 <amkeyword>part-size</amkeyword>,
2868 <amkeyword>part-cache-type</amkeyword>,
2869 <amkeyword>part-cache-dir</amkeyword>, and
2870 <amkeyword>part-cache-max-size</amkeyword>. The
2871 <amkeyword>part-size</amkeyword> specifies the "normal" part size,
2872 while the <amkeyword>part-cache-*</amkeyword> parameters describe
2873 how to behave when caching is required (on PORT-WRITE). Full
2874 details on these parameters are given above.</para>
2879 <manref name="amanda-client.conf" vol="5"/>,
2880 <manref name="amanda-applications" vol="7"/>,
2881 <manref name="amanda-auth" vol="7"/>,
2882 <manref name="amanda-changers" vol="7"/>,
2883 <manref name="amanda-devices" vol="7"/>,
2884 <manref name="amanda-scripts" vol="7"/>