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 '../entities/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 &A;, 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 &A;. 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 &A; 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 <emphasis remap='B'>mailto</emphasis>
57 <emphasis remap='B'>MailTo</emphasis>
58 are treated the same. Also, the characters
59 <emphasis remap='B'>'-'</emphasis>
61 <emphasis remap='B'>'_'</emphasis>
62 are interchangeable in all predefined &A; keywords:
63 <emphasis remap='B'>device_property</emphasis>
65 <emphasis remap='B'>device-property</emphasis>
66 have the same meaning.</para>
68 <para>Identifiers are names which are defined in the configuration itself, such
69 as dumptypes or interfaces. Identifiers are are case-insensitive, but
71 <emphasis remap='B'>'-'</emphasis>
73 <emphasis remap='B'>'_'</emphasis>.
74 Identifiers should be quoted in the configuration file, although For historical
75 reasons, the quotes are optional.</para>
77 <para>Strings are always quoted with double quotes ("), and any double quotes
78 or backslashes within the string are escaped with a backslash:
80 tapelist "/path/to/tapelist"
81 property "escaped-string" "escaping: \\ (backslash) and \" (double-quote)"
85 <para>To summarize, then:
88 logdir "logs" # required sensitive sensitive
89 send-amreport-on strange # prohibited insensitive insensitive
90 tapetype "EXABYTE" # optional insensitive sensitive
92 define dumptype "dt" { # optional insensitive sensitive
93 "dumptype-common" # optional insensitive sensitive
94 strategy noincr # prohibited insensitive insensitive
101 <refsect2><title>VALUE SUFFIXES</title>
103 <para>Integer arguments may have one of the following (case insensitive) suffixes,
104 some of which have a multiplier effect:</para>
106 <variablelist remap='TP'>
108 <term><emphasis remap='B'>b byte bytes</emphasis></term>
110 <para>Some number of bytes.</para>
114 <term><emphasis remap='B'>bps</emphasis></term>
116 <para>Some number of bytes per second.</para>
120 <term><emphasis remap='B'>k kb kbyte kbytes kilobyte kilobytes</emphasis></term>
122 <para>Some number of kilobytes (bytes*1024).</para>
126 <term><emphasis remap='B'>kps kbps</emphasis></term>
128 <para>Some number of kilobytes per second (bytes*1024).</para>
129 <para>It is the default multiplier for all size options.</para>
133 <term><emphasis remap='B'>m mb meg mbyte mbytes megabyte megabytes</emphasis></term>
135 <para>Some number of megabytes (bytes*1024*1024).</para>
139 <term><emphasis remap='B'>mps mbps</emphasis></term>
141 <para>Some number of megabytes per second (bytes*1024*1024).</para>
145 <term><emphasis remap='B'>g gb gbyte gbytes gigabyte gigabytes</emphasis></term>
147 <para>Some number of gigabytes (bytes*1024*1024*1024).</para>
151 <term><emphasis remap='B'>tape tapes</emphasis></term>
153 <para>Some number of tapes.</para>
157 <term><emphasis remap='B'>day days</emphasis></term>
159 <para>Some number of days.</para>
163 <term><emphasis remap='B'>week weeks</emphasis></term>
165 <para>Some number of weeks (days*7).</para>
167 <note><para>The value
168 <emphasis remap='B'>inf</emphasis>
169 may be used in most places where an integer is expected
170 to mean an infinite amount.</para>
172 <para>Boolean arguments may have any of the values
173 <emphasis remap='B'>y</emphasis>,
174 <emphasis remap='B'>yes</emphasis>,
175 <emphasis remap='B'>t</emphasis>,
176 <emphasis remap='B'>true</emphasis>
178 <emphasis remap='B'>on</emphasis>
179 to indicate a true state, or
180 <emphasis remap='B'>n</emphasis>,
181 <emphasis remap='B'>no</emphasis>,
182 <emphasis remap='B'>f</emphasis>,
183 <emphasis remap='B'>false</emphasis>
185 <emphasis remap='B'>off</emphasis>
186 to indicate a false state.
187 If no argument is given,
188 <emphasis remap='B'>true</emphasis>
197 <refsect2><title>PARAMETER ORDER</title>
199 <para>In general, the order in which parameters occur in the configuration file
200 does not matter, with the exception of subsection inheritance. For example, if
201 dumptype "normal-encrypt" which inherits from dumptype "normal", then "normal"
202 must appear first in the configuration file.</para>
206 <refsect2><title>STRINGS</title>
207 <para>Quoted strings in Amanda follow a common, C-like syntax. Printable
208 characters and whitespace are kept as-is, except that the backslash character
209 (\) is used as an escape character, and a double-quote ends the string. The allowed
212 ESCAPE SEQUENCE BECOMES
221 \001 - \377 (character specified in octal)
223 Illegally quoted strings are handled on a "best-effort" basis, which may lead to
228 finserver "/data/finance/XYZ Corp's \"real\" finances" finance-high eth0 -1
229 property "syspath" "C:\\WINDOWS\\SYSTEM"
236 <title>GLOBAL PARAMETERS</title>
238 <variablelist remap='TP'>
240 <term><emphasis remap='B'>org</emphasis> <emphasis remap='I'> string</emphasis></term>
243 <emphasis remap='I'>daily</emphasis>.
244 A descriptive name for the configuration.
245 This string appears in the Subject line of mail reports.
246 Each &A; configuration should have a different string to keep
247 mail reports distinct.</para>
251 <term><emphasis remap='B'>mailer</emphasis> <emphasis remap='I'> string</emphasis></term>
253 <para>Default found by configure. A mail program that can send mail with '<emphasis remap='I'>MAILER -s "subject" user < message_file</emphasis>'.</para>
257 <term><emphasis remap='B'>mailto</emphasis> <emphasis remap='I'> string</emphasis></term>
260 <emphasis remap='I'>operators</emphasis>.
261 A space separated list of recipients for mail reports.</para>
265 <term><emphasis remap='B'>send-amreport-on</emphasis> [all|strange|error|never]</term>
268 <emphasis remap='B'>all</emphasis>.
269 Specify which types of messages will trigger an email from amreport. amreport is used by amdump and amflush.</para>
271 <variablelist remap='TP'>
273 <term><emphasis remap='B'>all</emphasis></term>
275 <para>Send an email on any message.</para>
279 <term><emphasis remap='B'>strange</emphasis></term>
281 <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 &A;.</para>
285 <term><emphasis remap='B'>error</emphasis></term>
287 <para>Send an email only on error messages.</para>
291 <term><emphasis remap='B'>never</emphasis></term>
293 <para>Never send an email.</para>
300 <term><emphasis remap='B'>dumpcycle</emphasis> <emphasis remap='I'> int</emphasis></term>
303 <emphasis remap='I'>10 days</emphasis>.
304 The number of days in the backup cycle.
305 Each disk will get a full backup at least this often.
306 Setting this to zero tries to do a full backup each run.</para>
307 <note><para>This parameter may also be set in a specific
308 <emphasis remap='B'>dumptype</emphasis>
310 This value sets the default for all
311 <emphasis remap='B'>dumptype</emphasis>s
313 <emphasis remap='B'>amanda.conf</emphasis>
315 <emphasis remap='B'>dumptype</emphasis>s
322 <term><emphasis remap='B'>runspercycle</emphasis> <emphasis remap='I'> int</emphasis></term>
325 <emphasis remap='I'>same as dumpcycle</emphasis>.
326 The number of amdump runs in
327 <emphasis remap='B'>dumpcycle</emphasis>
329 A value of 0 means the same value as
330 <emphasis remap='B'>dumpcycle</emphasis>.
331 A value of -1 means guess the number of runs from the &tapelist; file,
332 which is the number of tapes used in the last
333 <emphasis remap='B'>dumpcycle</emphasis>
335 <emphasis remap='B'>runtapes</emphasis>.</para>
339 <term><emphasis remap='B'>tapecycle</emphasis> <emphasis remap='I'> int</emphasis></term>
342 <emphasis remap='I'>15 tapes</emphasis>.
343 Typically tapes are used by &A; in an ordered rotation. The <emphasis remap='B'>tapecycle</emphasis> parameter
344 defines the size of that rotation. The number of tapes in rotation must be larger than the number of tapes
345 required for a complete dump cycle (see the <emphasis remap='B'>dumpcycle</emphasis> parameter).
348 This is calculated by multiplying the number of &amdump; runs per dump cycle
349 (<emphasis remap='B'>runspercycle</emphasis> parameter) times the number of tapes used per run
350 (<emphasis remap='B'>runtapes</emphasis> parameter). Typically two to four times this calculated number of tapes are in rotation.
351 While &A; is always willing to use a new tape in its rotation, it refuses to reuse a tape until at
352 least '<emphasis remap='B'>tapecycle</emphasis> -1' number of other tapes have been used.
355 It is considered good administrative practice to set the <emphasis remap='B'>tapecycle</emphasis> parameter
356 slightly lower than the actual number of tapes in rotation. This allows the administrator to more easily cope
357 with damaged or misplaced tapes or schedule adjustments that call for slight adjustments in the rotation order.
363 <term><emphasis remap='B'>usetimestamps</emphasis>
364 <emphasis remap='I'> bool</emphasis></term>
366 <para>Default: <emphasis remap='B'>Yes</emphasis>.
367 This option allows Amanda to track multiple runs per calendar
368 day. The only reason one might disable it is that Amanda versions before 2.5.1
369 can't read logfiles written when this option was enabled.
375 <term><emphasis remap='B'>label_new_tapes</emphasis>
376 <emphasis remap='I'> string</emphasis></term>
378 <para>Default: not set.
379 When set, this directive will cause &A; to automatically write an &A;
380 tape label to any blank tape she encounters. This option is DANGEROUS
381 because when set, &A; will ERASE any non-&A; tapes you may have, and may
382 also ERASE any near-failing tapes. Use with caution.</para>
383 <para>When using this directive, specify the template for new tape
384 labels. The template should contain some number of contiguous '%'
385 characters, which will be replaced with a generated number. Be sure to
386 specify enough '%' characters that you do not run out of tape labels.
388 <markup>label_new_tapes "DailySet1-%%%"</markup>
394 <term><emphasis remap='B'>dumpuser</emphasis> <emphasis remap='I'> string</emphasis></term>
397 <emphasis remap='I'>amanda</emphasis>.
398 The login name &A; uses to run the backups.
399 The backup client hosts must allow access
400 from the tape server host as this user via
401 <markup>.rhosts</markup>
403 <markup>.amandahosts</markup>,
404 depending on how the &A; software was built.</para>
408 <term><emphasis remap='B'>printer</emphasis> string</term>
410 <para>Printer to use when doing tape labels.
412 <emphasis remap='B'>lbl-templ</emphasis>
413 <emphasis remap='B'>tapetype</emphasis>
419 <term><emphasis remap='B'>tapedev</emphasis> string</term>
422 <filename>null:</filename>.
423 The device name, referencing the name of a "device" section in the configuration file. See
424 <citerefentry><refentrytitle>amanda-devices</refentrytitle><manvolnum>7</manvolnum></citerefentry>
425 for more information on device names.</para>
427 <para>If a tape changer is configured
429 <emphasis remap='B'>tpchanger</emphasis>
430 option), this option might not be used.</para>
432 <para>If <emphasis remap='B'>tapedev</emphasis> is
433 <emphasis remap='B'>null:</emphasis>,
436 will run normally but all images will be thrown away.
437 This should only be used for debugging and testing,
438 and probably only with the
439 <emphasis remap='B'>record</emphasis>
441 <emphasis remap='I'>no</emphasis>.</para>
446 <term><emphasis remap='B'>device_property</emphasis> string string</term>
448 <para>These options can set various device properties. See
449 <citerefentry><refentrytitle>amanda-devices</refentrytitle><manvolnum>7</manvolnum></citerefentry>
450 for more information on device properties and their syntax.
451 Both strings are always quoted; the first string contains the name of
452 the property to set, and the second contains its value. For example, to set
453 a fixed block size of 128k, write:</para>
455 device_property "BLOCK_SIZE" "128k"
462 <term><emphasis remap='B'>property</emphasis> [append] string string+</term>
464 <para>These options can set various properties, they can be used by third
465 party software to store information in the configuration file.
466 Both strings are quoted; the first string contains the name of
467 the property to set, and the others contains its values.
468 <emphasis remap='B'>append</emphasis> keyword append the values to the list of values for that property.
474 <term><emphasis remap='B'>tpchanger</emphasis> string</term>
477 <emphasis remap='I'>none</emphasis>.
478 The name of the tape changer.
479 If a tape changer is not configured, this option is not used
480 and should be commented out of the configuration file.</para>
481 <para>If a tape changer is configured, choose one of the changer scripts
482 (e.g. <emphasis remap='B'>chg-scsi</emphasis>)
483 and enter that here.</para>
488 <term><emphasis remap='B'>changerdev</emphasis> string</term>
491 <filename>/dev/null</filename>.
492 A tape changer configuration parameter.
493 Usage depends on the particular changer defined with the
494 <emphasis remap='B'>tpchanger</emphasis>
499 <term><emphasis remap='B'>changerfile</emphasis> string</term>
502 <filename>/usr/adm/amanda/log/changer-status</filename>.
503 A tape changer configuration parameter.
504 Usage depends on the particular changer defined with the
505 <emphasis remap='B'>tpchanger</emphasis>
510 <term><emphasis remap='B'>runtapes</emphasis> int</term>
513 <literal>1</literal>.
514 The maximum number of tapes used in a single run.
515 If a tape changer is not configured, this option is not used
516 and should be commented out of the configuration file.</para>
517 <para>If a tape changer is configured, this may be set larger than one to
518 let &A; write to more than one tape.</para>
519 <para>Note that this is an upper bound on the number of tapes,
520 and &A; may use less.</para>
521 <para>Also note that as of this release, &A; does not support true tape overflow.
522 When it reaches the end of one tape,
523 the backup image &A; was processing starts over again on the next tape.</para>
528 <term><emphasis remap='B'>maxdumpsize</emphasis> int</term>
531 <emphasis remap='I'>runtapes</emphasis>*<emphasis remap='I'>tape_length</emphasis>.
532 Maximum number of bytes the planner will schedule for a run.</para>
533 <para>The default unit is Kbytes if it is not specified.</para>
537 <term><emphasis remap='B'>taperalgo</emphasis> [first|firstfit|largest|largestfit|smallest|last]</term>
540 <emphasis remap='I'>first</emphasis>.
541 The algorithm used to choose which dump image to send to the taper.</para>
543 <variablelist remap='TP'>
545 <term><emphasis remap='B'>first</emphasis></term>
547 <para>First in, first out.</para>
551 <term><emphasis remap='B'>firstfit</emphasis></term>
553 <para>The first dump image that will fit on the current tape.</para>
557 <term><emphasis remap='B'>largest</emphasis></term>
559 <para>The largest dump image.</para>
563 <term><emphasis remap='B'>largestfit</emphasis></term>
565 <para>The largest dump image that will fit on the current tape.</para>
569 <term><emphasis remap='B'>smallest</emphasis></term>
571 <para>The smallest dump image.</para>
575 <term><emphasis remap='B'>last</emphasis></term>
577 <para>Last in, first out.</para>
585 <term><emphasis remap='B'>labelstr</emphasis> <emphasis remap='I'> string</emphasis></term>
588 <emphasis remap='I'>.*</emphasis>.
589 The tape label constraint regular expression.
590 All tape labels generated (see
591 <citerefentry><refentrytitle>amlabel</refentrytitle><manvolnum>8</manvolnum></citerefentry>)
592 and used by this configuration must match the regular expression.
593 If multiple configurations are run from the same tape server host,
594 it is helpful to set their labels to different strings
595 (for example, "DAILY[0-9][0-9]*" vs.
596 "ARCHIVE[0-9][0-9]*")
597 to avoid overwriting each other's tapes.</para>
601 <term><emphasis remap='B'>tapetype</emphasis> <emphasis remap='I'> identifier</emphasis></term>
604 <emphasis remap='I'>"EXABYTE"</emphasis>.
605 The type of tape drive associated with
606 <emphasis remap='B'>tapedev</emphasis>
608 <emphasis remap='B'>tpchanger</emphasis>.
609 This refers to one of the defined <emphasis remap='B'>tapetype</emphasis>s
610 in the config file (see below), which specify various tape parameters,
612 <emphasis remap='B'>length</emphasis>,
613 <emphasis remap='B'>filemark</emphasis>
615 <emphasis remap='B'>speed</emphasis>
616 of the tape media and device.</para>
620 <term><emphasis remap='B'>ctimeout</emphasis> int</term>
623 <emphasis remap='I'>30 seconds</emphasis>.
624 Maximum amount of time that
625 <emphasis remap='B'>amcheck</emphasis>
626 will wait for each client host.</para>
630 <term><emphasis remap='B'>dtimeout</emphasis> int</term>
633 <emphasis remap='I'>1800 seconds</emphasis>.
634 Amount of idle time per disk on a given client that a
635 <emphasis remap='B'>dumper</emphasis>
637 <command>amdump</command>
638 will wait before it fails with a data timeout error.</para>
643 <term><emphasis remap='B'>etimeout</emphasis> int</term>
646 <emphasis remap='I'>300 seconds</emphasis>.
647 Amount of time per estimate on a given client that the
648 <emphasis remap='B'>planner</emphasis> step of
649 <command>amdump</command> will wait to get the dump size estimates
650 (note: Amanda runs up to 3 estimates for each DLE). For instance,
651 with the default of 300 seconds and four DLE's, each estimating level
652 0 and level 1 on client A, <emphasis remap='B'>planner</emphasis>
653 will wait up to 40 minutes for that machine. A negative value will
654 be interpreted as a total amount of time to wait
655 per client instead of per disk.</para>
660 <term><emphasis remap='B'>connect_tries</emphasis> int</term>
663 <emphasis remap='I'>3</emphasis>.
664 How many times the server will try a connection.</para>
669 <term><emphasis remap='B'>req_tries</emphasis> int</term>
672 <emphasis remap='I'>3</emphasis>.
673 How many times the server will resend a REQ packet if it doesn't get the ACK packet.</para>
678 <term><emphasis remap='B'>netusage</emphasis> int</term>
681 <emphasis remap='I'>8000 Kbps</emphasis>.
682 The maximum network bandwidth allocated to &A;, in Kbytes per second.
684 <emphasis remap='B'>interface</emphasis>
689 <term><emphasis remap='B'>inparallel</emphasis> int</term>
692 <literal>10</literal>.
693 The maximum number of backups that &A; will attempt to run in parallel.
694 &A; will stay within the constraints of network bandwidth and
695 holding disk space available, so it doesn't hurt to set
696 this number a bit high. Some contention can occur with larger numbers
697 of backups, but this effect is relatively small on most systems.</para>
702 <term><emphasis remap='B'>displayunit</emphasis> "k|m|g|t"</term>
705 <literal>"k"</literal>.
706 The unit used to print many numbers, k=kilo, m=mega, g=giga, t=tera.
712 <term><emphasis remap='B'>dumporder</emphasis> string</term>
715 <emphasis remap='I'>tttTTTTTTT</emphasis>.
716 The priority order of each dumper:
723 b: smallest bandwidth
725 </programlisting></para>
731 <term><emphasis remap='B'>maxdumps</emphasis> int</term>
734 <literal>1</literal>.
735 The maximum number of backups from a single host that &A; will
736 attempt to run in parallel. See also the
737 <emphasis remap='B'>inparallel</emphasis>
740 <para>Note that this parameter may also be set in a specific
741 <emphasis remap='B'>dumptype</emphasis>
743 This value sets the default for all
744 <emphasis remap='B'>dumptype</emphasis>s
746 <emphasis remap='B'>amanda.conf</emphasis>
748 <emphasis remap='B'>dumptype</emphasis>s
754 <term><emphasis remap='B'>bumpsize</emphasis> int</term>
757 <emphasis remap='I'>10 Mbytes</emphasis>.
758 The minimum savings required to trigger an automatic
759 bump from one incremental level to the next, expressed as size.
760 If &A; determines that the next higher backup level
761 will be this much smaller than the current level,
762 it will do the next level.
763 The value of this parameter is used only if the parameter
764 <emphasis>bumppercent</emphasis> is set to 0.
766 <para>The default unit is Kbytes if it is not specified.</para>
768 The global setting of this parameter can be overwritten inside of a
773 <emphasis remap='B'>bumppercent</emphasis>,
774 <emphasis remap='B'>bumpmult</emphasis> and
775 <emphasis remap='B'>bumpdays</emphasis>.</para>
780 <term><emphasis remap='B'>bumppercent</emphasis> int</term>
783 <emphasis remap='I'>0 percent</emphasis>.
784 The minimum savings required to trigger an automatic
785 bump from one incremental level to the next, expressed as percentage of the
786 current size of the DLE (size of current level 0).
787 If &A; determines that the next higher backup level
788 will be this much smaller than the current level,
789 it will do the next level.
792 If this parameter is set to 0, the value of the
793 parameter <emphasis>bumpsize</emphasis> is used to trigger bumping.
796 The global setting of this parameter can be overwritten inside of a
801 <emphasis remap='B'>bumpsize</emphasis>,
802 <emphasis remap='B'>bumpmult</emphasis> and
803 <emphasis remap='B'>bumpdays</emphasis>.</para>
808 <term><emphasis remap='B'>bumpmult</emphasis> <emphasis remap='I'> float</emphasis></term>
811 <literal>1.5</literal>.
812 The bump size multiplier.
814 <emphasis remap='B'>bumpsize</emphasis>
815 by this factor for each level.
816 This prevents active filesystems from
817 bumping too much by making it harder to bump to the next level.
818 For example, with the default
819 <emphasis remap='B'>bumpsize</emphasis>
821 <emphasis remap='B'>bumpmult</emphasis>
822 set to 2.0, the bump threshold will be 10 Mbytes for level one, 20
823 Mbytes for level two, 40 Mbytes for level three, and so on.</para>
825 The global setting of this parameter can be overwritten inside of a
831 <term><emphasis remap='B'>bumpdays</emphasis> <emphasis remap='I'> int</emphasis></term>
834 <emphasis remap='I'>2 days</emphasis>.
835 To insure redundancy in the dumps, &A; keeps filesystems at the
836 same incremental level for at least
837 <emphasis remap='B'>bumpdays</emphasis>
838 days, even if the other bump threshold criteria are met.</para>
840 The global setting of this parameter can be overwritten inside of a
847 <term><emphasis remap='B'>diskfile</emphasis> <emphasis remap='I'> string</emphasis></term>
850 <emphasis remap='I'>disklist</emphasis>.
851 The file name for the
852 <emphasis remap='I'>disklist</emphasis>
853 file holding client hosts, disks and other client dumping information.</para>
857 <term><emphasis remap='B'>infofile</emphasis> <emphasis remap='I'> string</emphasis></term>
860 <filename>/usr/adm/amanda/curinfo</filename>.
861 The file or directory name for the historical information database.
862 If &A; was configured to use DBM databases, this is the base file
864 If it was configured to use text formated databases (the default),
865 this is the base directory and within here will be a directory per
866 client, then a directory per disk, then a text file of data.</para>
870 <term><emphasis remap='B'>logdir</emphasis> <emphasis remap='I'> string</emphasis></term>
873 <filename>/usr/adm/amanda</filename>.
874 The directory for the
875 <command>amdump</command>
877 <emphasis remap='B'>log</emphasis>
882 <term><emphasis remap='B'>indexdir</emphasis> <emphasis remap='I'> string</emphasis></term>
885 <filename>/usr/adm/amanda/index</filename>.
886 The directory where index files (backup image catalogues) are stored.
888 only generated for filesystems whose
889 <emphasis remap='B'>dumptype</emphasis>
891 <emphasis remap='B'>index</emphasis>
892 option enabled.</para>
896 <term><emphasis remap='B'>tapelist</emphasis> <emphasis remap='I'> string</emphasis></term>
899 <emphasis remap='I'>tapelist</emphasis>.
900 The file name for the active &tapelist;.
901 &A; maintains this file with information about the active set of tapes.</para>
905 <term><emphasis remap='B'>device_output_buffer_size</emphasis> <emphasis remap='I'> int</emphasis></term>
908 <literal>1280k</literal>.
909 Controls the amount of memory used by &A;
910 to hold data as it is read from the network or disk before it is written to
911 the output device. Higher values may be
912 useful on fast tape drives and optical media.</para>
913 <para>The default unit is bytes if it is not specified.</para>
917 <term><emphasis remap='B'>tapebufs</emphasis> <emphasis remap='I'> int</emphasis></term>
920 <literal>20</literal>.
921 This option is deprecated; use
922 the <emphasis remap='B'>device_output_buffer_size</emphasis> directive
923 instead. <emphasis remap='B'>tapebufs</emphasis> works the same way,
924 but the number specified is multiplied by the device blocksize prior
929 <term><emphasis remap='B'>reserve</emphasis> <emphasis remap='I'> number</emphasis></term>
932 <literal>100</literal>.
933 The part of holding-disk space that should be reserved for incremental
934 backups if no tape is available, expressed as a percentage of the
935 available holding-disk space (0-100).
936 By default, when there is no tape to write to, degraded mode (incremental) backups
937 will be performed to the holding disk. If full backups should also be allowed in this case,
938 the amount of holding disk space reserved for incrementals should be lowered.</para>
942 <term><emphasis remap='B'>autoflush</emphasis> <emphasis remap='I'> bool</emphasis></term>
945 <emphasis remap='I'>off</emphasis>.
946 Whether an amdump run will flush the dumps from holding disk to tape.</para>
950 <term><emphasis remap='B'>amrecover_do_fsf</emphasis> <emphasis remap='I'> bool</emphasis></term>
953 <emphasis remap='I'>on</emphasis>.
954 Amrecover will call amrestore with the -f flag for faster positioning of the tape.</para>
958 <term><emphasis remap='B'>amrecover_check_label</emphasis> <emphasis remap='I'> bool</emphasis></term>
961 <emphasis remap='I'>on</emphasis>.
962 Amrecover will call amrestore with the -l flag to check the label.</para>
966 <term><emphasis remap='B'>amrecover_changer</emphasis> <emphasis remap='I'> string</emphasis></term>
969 Amrecover will use the changer if you use 'settape <string>' and that string
970 is the same as the amrecover_changer setting.</para>
974 <term><emphasis remap='B'>columnspec</emphasis> <emphasis remap='I'> string</emphasis></term>
976 <para>Defines the width of columns <emphasis remap='B'>amreport</emphasis>
978 <emphasis remap='I'>String</emphasis>
979 is a comma (',') separated list of triples. Each triple consists
980 of three parts which are separated by a equal sign ('=') and a colon (':') (see the example).
981 These three parts specify:</para>
985 <para>the name of the column, which may be:</para>
988 Compress (compression ratio)
989 Disk (client disk name)
990 DumpRate (dump rate in KBytes/sec)
991 DumpTime (total dump time in hours:minutes)
992 HostName (client host name)
994 OrigKB (original image size in KBytes)
995 OutKB (output image size in KBytes)
996 TapeRate (tape writing rate in KBytes/sec)
997 TapeTime (total tape time in hours:minutes)
1003 <para>the amount of space to display before the column (used to get whitespace between columns).</para><para/>
1006 <para>the width of the column itself.
1007 If set to a negative value, the width will be calculated on demand to fit the largest entry in
1012 <para>Here is an example:
1014 columnspec "Disk=1:18,HostName=0:10,OutKB=1:7"
1015 </programlisting></para>
1017 The above will display the disk information in 18 characters
1018 and put one space before it. The hostname column will be 10 characters wide with
1019 no space to the left. The output KBytes column is seven characters wide
1020 with one space before it.</para>
1025 <term><emphasis remap='B'>includefile</emphasis> <emphasis remap='I'> string</emphasis></term>
1028 <emphasis remap='I'>none</emphasis>.
1029 The name of an &A; configuration file to include within the current file.
1030 Useful for sharing dumptypes, tapetypes and interface definitions among several configurations.
1031 Relative pathnames are relative to the configuration directory.
1037 <term><emphasis remap='B'>debug_auth</emphasis> int</term>
1040 <emphasis remap='I'>0</emphasis>.
1041 Debug level of the auth module</para>
1046 <term><emphasis remap='B'>debug_event</emphasis> int</term>
1049 <emphasis remap='I'>0</emphasis>.
1050 Debug level of the event module</para>
1055 <term><emphasis remap='B'>debug_holding</emphasis> int</term>
1058 <emphasis remap='I'>0</emphasis>.
1059 Debug level of the holdingdisk module</para>
1064 <term><emphasis remap='B'>debug_protocol</emphasis> int</term>
1067 <emphasis remap='I'>0</emphasis>.
1068 Debug level of the protocol module</para>
1073 <term><emphasis remap='B'>debug_planner</emphasis> int</term>
1076 <emphasis remap='I'>0</emphasis>.
1077 Debug level of the planner process</para>
1082 <term><emphasis remap='B'>debug_driver</emphasis> int</term>
1085 <emphasis remap='I'>0</emphasis>.
1086 Debug level of the driver process</para>
1091 <term><emphasis remap='B'>debug_dumper</emphasis> int</term>
1094 <emphasis remap='I'>0</emphasis>.
1095 Debug level of the dumper process</para>
1100 <term><emphasis remap='B'>debug_chunker</emphasis> int</term>
1103 <emphasis remap='I'>0</emphasis>.
1104 Debug level of the chunker process</para>
1109 <term><emphasis remap='B'>debug_taper</emphasis> int</term>
1112 <emphasis remap='I'>0</emphasis>.
1113 Debug level of the taper process</para>
1118 <term><emphasis remap='B'>flush-threshold-dumped</emphasis> int</term>
1120 <para>Default: <emphasis remap='I'>0</emphasis>.
1121 &A; will not begin writing data to a new volume until the amount of
1122 data on the holding disk is at least this percentage of the volume
1123 size. In other words, &A; will not begin until the
1124 inequality <inlineequation><mathphrase>h > t ×
1125 d</mathphrase></inlineequation> is satisfied,
1126 where <mathphrase>h</mathphrase> is the amount of data on the
1127 holding disk, <mathphrase>t</mathphrase> is the capacity of a
1128 volume, and <mathphrase>d</mathphrase> is this parameter, expressed as a
1129 percentage. This parameter may be larger than 100%, for example to keep
1130 more recent dumps on the holding disk for faster recovery.</para>
1131 <para> Needless to say, your holding disk must be big enough
1132 that this criterion could be satisfied. If the holding disk cannot
1133 be used for a particular dump (because, for example, there is no
1134 remaining holding space) then &A; will disregard the constraint
1135 specified by this setting and start a new volume anyway. Once
1136 writing to a volume has begun, this constraint is not applied unless
1137 and until a new volume is needed.</para>
1138 <para> The value of this parameter may not exceed than that of
1139 the <emphasis remap='B'>flush-threshold-scheduled</emphasis>
1145 <term><emphasis remap='B'>flush-threshold-scheduled</emphasis> int</term>
1147 <para>Default: <emphasis remap='I'>0</emphasis>.
1148 &A; will not begin writing data to a new volume until the sum of the
1149 amount of data on the holding disk and the estimated amount of data
1150 remaining to be dumped during this run is at least this percentage
1151 of the volume size. In other words, &A; will not begin until the
1152 inequality <inlineequation><mathphrase>h + s > t ×
1153 d</mathphrase></inlineequation> is satisfied,
1154 where <mathphrase>h</mathphrase> is the amount of data on the
1155 holding disk, <mathphrase>s</mathphrase> is the total amount of
1156 data scheduled for this run but not dumped
1157 yet, <mathphrase>t</mathphrase> is the capacity of a volume,
1158 and <mathphrase>d</mathphrase> is this parameter, expressed as a
1159 percentage. This parameter may be larger than 100%.</para>
1160 <para> Needless to say, your holding disk must be big enough
1161 that this criterion could be satisfied. If the holding disk cannot
1162 be used for a particular dump (because, for example, there is no
1163 remaining holding space) then &A; will disregard the constraint
1164 specified by this setting and start a new volume anyway. Once
1165 writing to a volume has begun, this constraint is not applied unless
1166 and until a new volume is needed.</para>
1167 <para> The value of this parameter may not be less than that of
1168 the <emphasis remap='B'>flush-threshold-dumped</emphasis>
1169 or <emphasis remap='B'>taperflush</emphasis> parameters.</para>
1173 <!-- the entity '#215' below is U+00D7 MULTIPLICATION SIGN; the 'times' entity
1174 is not as portable as one might hope. -->
1176 <term><emphasis remap='B'>taperflush</emphasis> int</term>
1178 <para>Default: <emphasis remap='I'>0</emphasis>.
1179 At the end of a run, &A; will start a new tape to flush remaining
1180 data if there is more data on the holding disk at the end of a run
1181 than this setting allows; the amount is specified as a percentage of
1182 the capacity of a single
1183 volume. In other words, at the end of a run, &A; will begin
1185 inequality <inlineequation><mathphrase>h > t ×
1186 f</mathphrase></inlineequation> is satisfied,
1187 where <mathphrase>h</mathphrase> is the amount of data remaining on the
1188 holding disk from this or previous runs, <mathphrase>t</mathphrase>
1189 is the capacity of a volume,
1190 and <mathphrase>f</mathphrase> is this parameter, expressed as a
1191 percentage. This parameter may be greater than 100%.</para>
1192 <para> The value of this parameter may not exceed that of
1193 the <emphasis remap='B'>flush-threshold-scheduled</emphasis>
1194 parameter.; <emphasis remap='B'>autoflush</emphasis> must be set to 'yes' if
1195 <emphasis remap='B'>taperflush</emphasis> is greater than 0.</para>
1200 <term><emphasis remap='B'>reserved-udp-port</emphasis> int,int</term>
1202 <para>Default: --with-udpportrange or
1203 <emphasis remap='I'>512,1023</emphasis>.
1204 Reserved udp port that will be used (bsd, bsdudp).
1205 Range is inclusive.</para>
1210 <term><emphasis remap='B'>reserved-tcp-port</emphasis> int,int</term>
1212 <para>Default: --with-low-tcpportrange or
1213 <emphasis remap='I'>512,1023</emphasis>.
1214 Reserved tcp port that will be used (bsdtcp).
1215 Range is inclusive.</para>
1220 <term><emphasis remap='B'>unreserved-tcp-port</emphasis> int,int</term>
1222 <para>Default: --with-tcpportrange or
1223 <emphasis remap='I'>1024,65535</emphasis>.
1224 Unreserved tcp port that will be used (bsd, bsdudp).
1225 Range is inclusive.</para>
1232 <refsect1><title>HOLDINGDISK SECTION</title>
1233 <para>The <emphasis remap='B'>amanda.conf</emphasis>
1234 file may define one or more holding disks used as buffers to hold
1235 backup images before they are written to tape.
1236 The syntax is:</para>
1239 holdingdisk <emphasis remap='I'>name</emphasis> {
1240 <emphasis remap='I'>holdingdisk-option</emphasis> <emphasis remap='I'>holdingdisk-value</emphasis>
1241 <literal>...</literal>
1245 <para><emphasis remap='I'>Name</emphasis>
1246 is a logical name for this holding disk.</para>
1248 <para>The options and values are:</para>
1250 <variablelist remap='TP'>
1252 <term><emphasis remap='B'>comment</emphasis> <emphasis remap='I'> string</emphasis></term>
1255 <emphasis remap='I'>none</emphasis>.
1256 A comment string describing this holding disk.</para>
1261 <term><emphasis remap='B'>directory</emphasis> <emphasis remap='I'> disk</emphasis></term>
1264 <filename>/dumps/amanda</filename>.
1265 The path to this holding area.</para>
1270 <term><emphasis remap='B'>use</emphasis> <emphasis remap='I'> int</emphasis></term>
1273 <emphasis remap='I'>0 Gb</emphasis>.
1274 Amount of space that can be used in this holding disk area.
1275 If the value is zero, all available space on the file system is used.
1276 If the value is negative, &A; will use all available space minus that value.</para>
1281 <term><emphasis remap='B'>chunksize</emphasis> <emphasis remap='I'> int</emphasis></term>
1284 <emphasis remap='I'>1 Gb</emphasis>.
1285 Holding disk chunk size. Dumps larger than the specified size will be stored in multiple
1286 holding disk files. The size of each chunk will not exceed the specified value.
1287 However, even though dump images are split in the holding disk, they are concatenated as
1288 they are written to tape, so each dump image still corresponds to a single continuous
1289 tape section.</para>
1290 <para>The default unit is Kbytes if it is not specified.</para>
1292 <para>If 0 is specified, &A; will create holding disk chunks as large as
1293 ((INT_MAX/1024)-64) Kbytes.</para>
1295 <para>Each holding disk chunk includes a 32 Kbyte header, so the minimum
1296 chunk size is 64 Kbytes (but that would be really silly).</para>
1298 <para>Operating systems that are limited to a maximum file size of 2 Gbytes
1299 actually cannot handle files that large.
1300 They must be at least one byte less than 2 Gbytes.
1301 Since &A; works with 32 Kbyte blocks, and
1302 to handle the final read at the end of the chunk, the chunk size
1303 should be at least 64 Kbytes (2 * 32 Kbytes) smaller than the maximum
1304 file size, e.g. 2047 Mbytes.</para>
1310 <refsect1><title>DUMPTYPE SECTION</title>
1311 <para>The &amconf; file may define multiple sets of backup options
1312 and refer to them by name from the &disklist; file.
1313 For instance, one set of options might be defined for file systems
1314 that can benefit from high compression, another set that does not compress well,
1315 another set for file systems that should always get a full backup and so on.</para>
1317 <para>A set of backup options are entered in a
1318 <emphasis remap='B'>dumptype</emphasis>
1319 section, which looks like this:</para>
1322 define dumptype "<emphasis remap='I'>name</emphasis>" {
1323 <emphasis remap='I'>dumptype-option</emphasis> <emphasis remap='I'>dumptype-value</emphasis>
1324 <literal>...</literal>
1328 <para><emphasis remap='I'>Name</emphasis>
1329 is the name of this set of backup options.
1330 It is referenced from the &disklist; file.</para>
1332 <para>Some of the options in a
1333 <emphasis remap='B'>dumptype</emphasis>
1334 section are the same as those in the main part of &amconf;.
1335 The main option value is used to set the default for all
1336 <emphasis remap='B'>dumptype</emphasis>
1337 sections. For instance, setting
1338 <emphasis remap='B'>dumpcycle</emphasis>
1339 to 50 in the main part of the config file causes all following
1340 <emphasis remap='B'>dumptype</emphasis>
1341 sections to start with that value,
1342 but the value may be changed on a section by section basis.
1343 Changes to variables in the main part of the config file must be
1344 done before (earlier in the file) any
1345 <emphasis remap='B'>dumptype</emphasis>s
1348 <para>The dumptype options and values are:</para>
1350 <variablelist remap='TP'>
1352 <term><emphasis remap='B'>auth</emphasis> <emphasis remap='I'> string</emphasis></term>
1355 <emphasis remap='I'>bsd</emphasis>.
1356 Type of authorization to perform between tape server and backup client hosts. See <citerefentry><refentrytitle>amanda-auth</refentrytitle><manvolnum>7</manvolnum></citerefentry> for more detail.</para>
1361 <term><emphasis remap='B'>amandad_path</emphasis> <emphasis remap='I'> string</emphasis></term>
1364 <emphasis remap='I'>$libexec/amandad</emphasis>.
1365 Specify the amandad path of the client, only use with rsh/ssh authentification.
1371 <term><emphasis remap='B'>client_username</emphasis> <emphasis remap='I'> string</emphasis></term>
1374 <emphasis remap='I'>CLIENT_LOGIN</emphasis>.
1375 Specify the username to connect on the client, only use with rsh/ssh authentification.
1380 <!-- bumping parameters yanked from the global section above -->
1383 <term><emphasis remap='B'>bumpsize</emphasis> int</term>
1386 <emphasis remap='I'>10 Mbytes</emphasis>.
1387 The minimum savings required to trigger an automatic
1388 bump from one incremental level to the next, expressed as size.
1389 If &A; determines that the next higher backup level
1390 will be this much smaller than the current level,
1391 it will do the next level.
1392 The value of this parameter is used only if the parameter
1393 <emphasis>bumppercent</emphasis> is set to 0.
1395 <para>The default unit is Kbytes if it is not specified.</para>
1397 See also the options
1398 <emphasis remap='B'>bumppercent</emphasis>,
1399 <emphasis remap='B'>bumpmult</emphasis> and
1400 <emphasis remap='B'>bumpdays</emphasis>.</para>
1405 <term><emphasis remap='B'>bumppercent</emphasis> int</term>
1408 <emphasis remap='I'>0 percent</emphasis>.
1409 The minimum savings required to trigger an automatic
1410 bump from one incremental level to the next, expressed as percentage of the
1411 current size of the DLE (size of current level 0).
1412 If &A; determines that the next higher backup level
1413 will be this much smaller than the current level,
1414 it will do the next level.
1417 If this parameter is set to 0, the value of the
1418 parameter <emphasis>bumpsize</emphasis> is used to trigger bumping.
1421 See also the options
1422 <emphasis remap='B'>bumpsize</emphasis>,
1423 <emphasis remap='B'>bumpmult</emphasis> and
1424 <emphasis remap='B'>bumpdays</emphasis>.</para>
1429 <term><emphasis remap='B'>bumpmult</emphasis> <emphasis remap='I'> float</emphasis></term>
1432 <literal>1.5</literal>.
1433 The bump size multiplier.
1435 <emphasis remap='B'>bumpsize</emphasis>
1436 by this factor for each level.
1437 This prevents active filesystems from
1438 bumping too much by making it harder to bump to the next level.
1439 For example, with the default
1440 <emphasis remap='B'>bumpsize</emphasis>
1442 <emphasis remap='B'>bumpmult</emphasis>
1443 set to 2.0, the bump threshold will be 10 Mbytes for level one, 20
1444 Mbytes for level two, 40 Mbytes for level three, and so on.</para>
1448 <term><emphasis remap='B'>bumpdays</emphasis> <emphasis remap='I'> int</emphasis></term>
1451 <emphasis remap='I'>2 days</emphasis>.
1452 To insure redundancy in the dumps, &A; keeps filesystems at the
1453 same incremental level for at least
1454 <emphasis remap='B'>bumpdays</emphasis>
1455 days, even if the other bump threshold criteria are met.</para>
1460 <term><emphasis remap='B'>comment</emphasis> <emphasis remap='I'> string</emphasis></term>
1463 <emphasis remap='I'>none</emphasis>.
1464 A comment string describing this set of backup options.</para>
1468 <term><emphasis remap='B'>comprate</emphasis> <emphasis remap='I'>float</emphasis> [, <emphasis remap='I'>float</emphasis> ]</term>
1471 <literal>0.50</literal>,
1472 <literal>0.50</literal>.
1473 The expected full and incremental compression factor for dumps.
1474 It is only used if &A; does not have any history information on
1475 compression rates for a filesystem, so should not usually need to be set.
1476 However, it may be useful for the first time a very large filesystem that
1477 compresses very little is backed up.</para>
1481 <term><emphasis remap='B'>compress [client|server]</emphasis> <emphasis remap='I'> string</emphasis></term>
1484 <emphasis remap='I'>client fast</emphasis>.
1485 If &A; does compression of the backup images, it can do so either on the backup client
1486 host before it crosses the network or on the tape server host as it goes from the
1487 network into the holding disk or to tape. Which place to do compression (if at all) depends on how well the
1488 dump image usually compresses, the speed and load on the client or server, network capacity,
1489 holding disk capacity, availability of tape hardware compression, etc.</para>
1491 <para>For either type of compression, &A; also allows the selection
1492 of three styles of compression.
1493 <emphasis remap='B'>Best</emphasis>
1494 is the best compression available, often at the expense of CPU overhead.
1495 <emphasis remap='B'>Fast</emphasis>
1496 is often not as good a compression as
1497 <emphasis remap='B'>best</emphasis>,
1498 but usually less CPU overhead. Or to specify <emphasis remap='B'>Custom</emphasis>
1499 to use your own compression method. (See dumptype custom-compress in example/amanda.conf for reference)</para>
1501 <para>So the <emphasis remap='B'>compress</emphasis> options line may be one of:</para>
1503 <variablelist remap='TP'>
1505 <term>compress none</term><listitem><para/></listitem>
1508 <term>compress client fast</term><listitem><para/></listitem>
1511 <term>compress client best</term><listitem><para/></listitem>
1514 <term>compress client custom</term>
1516 <para>Specify <emphasis>client_custom_compress</emphasis> "PROG"</para>
1517 <para>PROG must not contain white space and it must accept -d for uncompress.</para>
1521 <term>compress server fast</term><listitem><para/></listitem>
1524 <term>compress server best</term><listitem><para/></listitem>
1527 <term>compress server custom</term>
1529 <para>Specify <emphasis>server_custom_compress</emphasis> "PROG"</para>
1530 <para>PROG must not contain white space and it must accept -d for uncompress.</para>
1534 <para>Note that some tape devices do compression and this option has nothing
1535 to do with whether that is used. If hardware compression is used (usually via a particular tape device name
1536 or <emphasis remap='B'>mt</emphasis> option), &A; (software) compression should be disabled.</para>
1540 <term><emphasis remap='B'>dumpcycle</emphasis> <emphasis remap='I'> int</emphasis></term>
1542 <para>Default: <emphasis remap='I'>10 days</emphasis>.
1543 The number of days in the backup cycle. Each disk using this set of options will get a full
1544 backup at least this of
1545 ten. Setting this to zero tries to do a full backup each run.</para>
1550 <term><emphasis remap='B'>encrypt [none|client|server]</emphasis></term>
1552 <para>Default: <emphasis remap='I'>none</emphasis>.
1553 To encrypt backup images, it can do so either on the backup client host before it crosses the network or on the tape
1554 server host as it goes from the network into the holding disk or to tape.</para>
1556 <para>So the <emphasis remap='B'>encrypt</emphasis> options line may be one
1559 <variablelist remap='TP'>
1561 <term>encrypt none</term><listitem><para/></listitem>
1564 <term>encrypt client</term>
1566 <para>Specify client_encrypt "PROG"</para>
1567 <para>PROG must not contain white space.</para>
1568 <para>Specify client_decrypt_option "decryption-parameter" Default: "-d"</para>
1569 <para>decryption-parameter must not contain white space.</para>
1570 <para>(See dumptype client-encrypt-nocomp in example/amanda.conf for reference)</para>
1574 <term>encrypt server</term>
1576 <para>Specify server_encrypt "PROG"</para>
1577 <para>PROG must not contain white space.</para>
1578 <para>Specify server_decrypt_option "decryption-parameter" Default: "-d"</para>
1579 <para>decryption-parameter must not contain white space.</para>
1580 <para>(See dumptype server-encrypt-fast in example/amanda.conf for reference)</para>
1584 <para>Note that current logic assumes compression then encryption during
1585 backup(thus decrypt then uncompress during restore). So specifying
1586 client-encryption AND server-compression is not supported.
1587 <emphasis remap='I'>amcrypt</emphasis> which is a wrapper of
1588 <emphasis remap='I'>aespipe</emphasis> is provided as a reference
1589 symmetric encryption program.</para>
1595 <term><emphasis remap='B'>estimate</emphasis> <emphasis remap='I'>client|calcsize|server</emphasis></term>
1597 <para>Default: <emphasis remap='I'>client</emphasis>.
1598 Determine the way &A; does it's estimate.</para>
1599 <variablelist remap='TP'>
1603 <para>Use the same program as the dumping program, this is the most
1604 accurate way to do estimates, but it can take a long time.</para>
1608 <term>calcsize</term>
1610 <para>Use a faster program to do estimates, but the result is less accurate.</para>
1616 <para>Use only statistics from the previous run to give an estimate,
1617 it takes only a few seconds but the result is not accurate if your disk
1618 usage changes from day to day.</para>
1627 <term><emphasis remap='B'>exclude</emphasis> [ list|file ][[optional][ append ][ <emphasis remap='I'>string</emphasis> ]+]</term>
1630 <emphasis remap='I'>file</emphasis>.
1631 There are two exclude lists,
1632 <emphasis remap='B'>exclude file</emphasis>
1634 <emphasis remap='B'>exclude list.</emphasis>
1636 <emphasis remap='B'>exclude file</emphasis>
1638 <emphasis remap='I'>string</emphasis>
1639 is a &gnutar; exclude expression. With
1640 <emphasis remap='B'>exclude list</emphasis>
1642 <emphasis remap='I'>string</emphasis>
1643 is a file name on the client containing &gnutar; exclude expressions.
1644 The path to the specified exclude list file, if present (see description of
1645 'optional' below), must be readable by the &A; user.</para>
1647 <para>All exclude expressions are concatenated in one file and passed to &gnutar;
1648 as an <option>--exclude-from</option> argument.</para>
1650 <para>Exclude expressions must always be specified as relative to the
1651 head directory of the DLE.</para>
1654 <emphasis remap='B'>append</emphasis> keyword, the
1655 <emphasis remap='I'>string</emphasis> is appended to the current list, without it, the
1656 <emphasis remap='I'>string</emphasis> overwrites the list.</para>
1658 <para>If <emphasis remap='B'>optional</emphasis>
1659 is specified for <emphasis remap='B'>exclude list</emphasis>,
1660 then amcheck will not complain if the file doesn't exist or is not readable.</para>
1662 <para>For <emphasis remap='B'>exclude list</emphasis>,
1663 if the file name is relative, the disk name being backed up is prepended.
1664 So if this is entered:</para>
1667 exclude list ".amanda.excludes"
1670 <para>the actual file used would be
1671 <filename>/var/.amanda.excludes</filename>
1672 for a backup of <filename>/var</filename>,
1673 <filename>/usr/local/.amanda.excludes</filename> for a backup of
1674 <filename>/usr/local</filename>, and so on.</para>
1679 <term><emphasis remap='B'>holdingdisk</emphasis> [ never|auto|required ]</term>
1682 <emphasis remap='I'>auto</emphasis>.
1683 Whether a holding disk should be used for these backups or whether they should go directly to tape.
1684 If the holding disk is a portion of another file system that &A;
1685 is backing up, that file system should refer to a dumptype with
1686 <emphasis remap='B'>holdingdisk</emphasis>
1688 <emphasis remap='I'>never</emphasis>
1689 to avoid backing up the holding disk into itself.</para>
1691 <variablelist remap='TP'>
1693 <term><emphasis remap='B'>never</emphasis>|no|false|off</term>
1695 <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>
1699 <term><emphasis remap='B'>auto</emphasis>|yes|true|on</term>
1701 <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>
1705 <term><emphasis remap='B'>required</emphasis></term>
1707 <para>Always dump to holdingdisk, never directly to tape. There will be no dump if it doesn't fit on holdingdisk</para>
1716 <term><emphasis remap='B'>ignore</emphasis> <emphasis remap='I'> boolean</emphasis></term>
1719 <emphasis remap='I'>no</emphasis>.
1720 Whether disks associated with this backup type should be backed up or not.
1721 This option is useful when the
1722 <emphasis remap='I'>disklist</emphasis>
1723 file is shared among several configurations,
1724 some of which should not back up all the listed file systems.</para>
1728 <term><emphasis remap='B'>include</emphasis> [ list|file ][[optional][ append ][ <emphasis remap='I'>string</emphasis> ]+]</term>
1731 <emphasis remap='I'>file</emphasis>
1733 There are two include lists,
1734 <emphasis remap='B'>include file</emphasis>
1736 <emphasis remap='B'>include list.</emphasis>
1738 <emphasis remap='B'>include file</emphasis>
1740 <emphasis remap='I'>string</emphasis>
1741 is a glob expression. With
1742 <emphasis remap='B'>include list</emphasis>
1744 <emphasis remap='I'>string</emphasis>
1745 is a file name on the client containing glob expressions.</para>
1747 <para>All include expressions are expanded by &A;, concatenated in one file and passed to &gnutar; as a
1748 <option>--files-from</option> argument. They must start with "./" and contain no other "/".</para>
1750 <para>Include expressions must always be specified as relative to the
1751 head directory of the DLE.</para>
1753 <note><para>For globbing to work at all, even the limited single level,
1754 the top level directory of the DLE must be readable by the &A; user.</para>
1757 <para>With the <emphasis remap='B'>append</emphasis> keyword, the
1758 <emphasis remap='I'>string</emphasis> is appended to the current list, without it, the
1759 <emphasis remap='I'>string</emphasis> overwrites the list.</para>
1762 <emphasis remap='B'>optional</emphasis> is specified for
1763 <emphasis remap='B'>include list,</emphasis> then amcheck will not complain if the file
1764 doesn't exist or is not readable.</para>
1766 <para>For <emphasis remap='B'>include list</emphasis>,
1767 If the file name is relative, the disk name being backed up is prepended.</para>
1772 <term><emphasis remap='B'>index</emphasis> <emphasis remap='I'> boolean</emphasis></term>
1774 <para>Default: <emphasis remap='I'>no</emphasis>.
1775 Whether an index (catalogue) of the backup should be generated and saved in
1776 <emphasis remap='B'>indexdir</emphasis>.
1777 These catalogues are used by the <emphasis remap='B'>amrecover</emphasis> utility.</para>
1782 <term><emphasis remap='B'>kencrypt</emphasis> <emphasis remap='I'> boolean</emphasis></term>
1785 <emphasis remap='I'>no</emphasis>.
1786 Whether the backup image should be encrypted by Kerberos as it is sent
1787 across the network from the backup client host to the tape server host.</para>
1791 <term><emphasis remap='B'>maxdumps</emphasis> <emphasis remap='I'> int</emphasis></term>
1794 <literal>1</literal>.
1795 The maximum number of backups from a single host that &A; will attempt to run in parallel.
1796 See also the main section parameter <emphasis remap='B'>inparallel</emphasis>.</para>
1800 <term><emphasis remap='B'>maxpromoteday</emphasis> <emphasis remap='I'> int</emphasis></term>
1803 <literal>10000</literal>.
1804 The maximum number of day for a promotion, set it 0 if you don't want
1805 promotion, set it to 1 or 2 if your disks get overpromoted.</para>
1809 <term><emphasis remap='B'>priority</emphasis> <emphasis remap='I'> string</emphasis></term>
1811 <para>Default: <emphasis remap='I'>medium</emphasis>.
1812 When there is no tape to write to, &A; will do incremental backups
1813 in priority order to the holding disk. The priority may be
1814 high (2), medium (1), low (0) or a number of your choice.</para>
1818 <term><emphasis remap='B'>program</emphasis> [DUMP|GNUTAR|APPLICATION]</term>
1821 <emphasis remap='I'>DUMP</emphasis>.
1822 The type of backup to perform. Valid values are:</para>
1824 <variablelist remap='TP'>
1826 <term><emphasis remap='B'>DUMP</emphasis></term>
1828 <para>The native operating system backup program.</para>
1832 <term><emphasis remap='B'>GNUTAR</emphasis></term>
1834 <para>To use GNU-tar or to do PC backups using Samba.</para>
1838 <term><emphasis remap='B'>APPLICATION</emphasis></term>
1840 <para>To use an application-tool, see the <emphasis>application</emphasis> option.</para>
1847 <term><emphasis remap='B'>application</emphasis> <emphasis remap='I'> string</emphasis></term>
1849 <para>No default. Must be the name of an application-tool if <emphasis>program</emphasis> is set to <emphasis remap='I'>APPLICATION</emphasis>. See APPLICATION SECTION below.</para>
1853 <term><emphasis remap='B'>script</emphasis> <emphasis remap='I'> string</emphasis></term>
1855 <para>No default. Must be the name of a script-tool. You can have many script. See SCRIPT SECTION below.</para>
1859 <term><emphasis remap='B'>property</emphasis> [append] <emphasis remap='I'>string</emphasis> <emphasis remap='I'>string</emphasis>+</term>
1861 <para>These options can set various properties, they can be used by third
1862 party software to store information in the configuration file.
1863 Both strings are quoted; the first string contains the name of
1864 the property to set, and the others contains its values.
1865 <emphasis remap='B'>append</emphasis> keyword append the values to the list of values for that property.
1871 <term><emphasis remap='B'>record</emphasis> <emphasis remap='I'> boolean</emphasis></term>
1874 <emphasis remap='I'>yes</emphasis>.
1875 Whether to ask the backup program to update its database (e.g. <filename>/etc/dumpdates</filename>
1876 for DUMP or <filename>/usr/local/var/amanda/gnutar-lists</filename> for GNUTAR) of time stamps.
1877 This is normally enabled for daily backups and turned off for periodic archival runs.</para>
1881 <term><emphasis remap='B'>skip-full</emphasis> <emphasis remap='I'> boolean</emphasis></term>
1884 <emphasis remap='I'>no</emphasis>. If <emphasis remap='I'>true</emphasis> and
1885 <emphasis remap='B'>planner</emphasis> has scheduled a full backup, these disks will be skipped, and
1886 full backups should be run off-line on these days. It was reported that &A; only schedules
1887 level 1 incrementals in this configuration; this is probably a bug.</para>
1891 <term><emphasis remap='B'>skip-incr</emphasis> <emphasis remap='I'> boolean</emphasis></term>
1894 <emphasis remap='I'>no</emphasis>. If <emphasis remap='I'>true</emphasis> and
1895 <emphasis remap='B'>planner</emphasis> has scheduled an incremental backup, these disks will be skipped.</para>
1899 <term><emphasis remap='B'>starttime</emphasis> <emphasis remap='I'> int</emphasis></term>
1902 <emphasis remap='I'>none</emphasis>.
1903 Backups will not start until after this time of day.
1904 The value should be hh*100+mm, e.g. 6:30PM (18:30) would be entered as
1905 <literal>1830</literal>.</para>
1909 <term><emphasis remap='B'>strategy</emphasis> <emphasis remap='I'> string</emphasis></term>
1911 <para>Default: <emphasis remap='I'>standard</emphasis>.
1912 Strategy to use when planning what level of backup to run next. Values are:</para>
1914 <variablelist remap='TP'>
1916 <term><emphasis remap='B'>standard</emphasis></term>
1918 <para>The standard &A; schedule.</para>
1922 <term><emphasis remap='B'>nofull</emphasis></term>
1924 <para>Never do full backups, only level 1 incrementals.</para>
1928 <term><emphasis remap='B'>noinc</emphasis></term>
1930 <para>Never do incremental backups, only full dumps.</para>
1934 <term><emphasis remap='B'>skip</emphasis></term>
1936 <para>Never do backups (useful when sharing the <emphasis remap='I'>disklist</emphasis> file).</para>
1940 <term><emphasis remap='B'>incronly</emphasis></term>
1942 <para>Only do incremental dumps. <command>amadmin force</command> should be used to tell
1943 &A; that a full dump has been performed off-line, so that it resets to level 1.</para>
1951 <term><emphasis remap='B'>tape_splitsize</emphasis> <emphasis remap='I'> int</emphasis></term>
1954 <emphasis remap='I'>none</emphasis>.
1955 Split dump file on tape into pieces of a specified size.
1956 This allows dumps to be spread across multiple tapes, and can potentially
1957 make more efficient use of tape space.
1958 Note that if this value is too large (more than half the size of the
1959 average dump being split), substantial tape space can be wasted.
1960 If too small, large dumps will be split into innumerable tiny dumpfiles,
1961 adding to restoration complexity.
1962 A good rule of thumb, usually, is 1/10 of the size of your tape.</para>
1963 <para>The default unit is Kbytes if it is not specified.</para>
1968 <term><emphasis remap='B'>split_diskbuffer</emphasis> <emphasis remap='I'> string</emphasis></term>
1971 <emphasis remap='I'>none</emphasis>.
1972 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.
1978 <term><emphasis remap='B'>fallback_splitsize</emphasis> <emphasis remap='I'> int</emphasis></term>
1981 <emphasis remap='I'>10M</emphasis>.
1982 When dumping a split dump in PORT-WRITE mode, if no split_diskbuffer is
1983 specified (or if we somehow fail to use our split_diskbuffer), we must
1984 buffer split chunks in memory.
1985 This specifies the maximum size split chunks can be in this scenario,
1986 and thus the maximum amount of memory consumed for in-memory splitting.
1987 The size of this buffer can be changed from its (very conservative) default
1988 to a value reflecting the amount of memory that each taper process on
1989 the dump server may reasonably consume.
1991 <para>The default unit is Kbytes if it is not specified.</para>
1996 <para>The following <emphasis remap='B'>dumptype</emphasis> entries are predefined by &A;:</para>
1998 <programlisting remap='.nf'>
1999 define dumptype "no-compress" {
2002 define dumptype "compress-fast" {
2003 compress client fast
2005 define dumptype "compress-best" {
2006 compress client best
2008 define dumptype "srvcompress" {
2009 compress server fast
2011 define dumptype "bsd-auth" {
2014 define dumptype "krb4-auth" {
2017 define dumptype "no-record" {
2020 define dumptype "no-hold" {
2023 define dumptype "no-full" {
2028 <para>In addition to options in a
2029 <emphasis remap='B'>dumptype</emphasis>
2030 section, one or more other
2031 <emphasis remap='B'>dumptype</emphasis>
2032 names may be supplied as identifiers, which make this
2033 <emphasis remap='B'>dumptype</emphasis>
2034 inherit options from other previously defined
2035 <emphasis remap='B'>dumptype</emphasis>s.
2036 For instance, two sections might be the same except for the
2037 <emphasis remap='B'>record</emphasis> option:</para>
2039 <programlisting remap='.nf'>
2040 define dumptype "normal" {
2041 comment "Normal backup, no compression, do indexing"
2046 define dumptype "testing" {
2047 comment "Test backup, no compression, do indexing, no recording"
2053 <para>&A; provides a
2054 <emphasis remap='B'>dumptype</emphasis>
2056 <emphasis remap='I'>global</emphasis>
2058 <emphasis remap='B'>amanda.conf</emphasis>
2060 <emphasis remap='B'>dumptype</emphasis>s
2062 This provides an easy place to make changes that will affect every
2063 <emphasis remap='B'>dumptype</emphasis>.</para>
2066 <refsect1><title>TAPETYPE SECTION</title>
2067 <para>The <emphasis remap='B'>amanda.conf</emphasis>
2068 file may define multiple types of tape media and devices.
2069 The information is entered in a
2070 <emphasis remap='B'>tapetype</emphasis>
2071 section, which looks like this in the config file:</para>
2074 define tapetype "<emphasis remap='I'>name</emphasis>" {
2075 <emphasis remap='I'>tapetype-option</emphasis> <emphasis remap='I'>tapetype-value</emphasis>
2076 <literal>...</literal>
2080 <para><emphasis remap='I'>Name</emphasis>
2081 is the name of this type of tape medium/device.
2082 It is referenced from the
2083 <emphasis remap='B'>tapetype</emphasis>
2084 option in the main part of the config file.</para>
2086 <para>The tapetype options and values are:</para>
2087 <variablelist remap='TP'>
2089 <term><emphasis remap='B'>comment</emphasis> <emphasis remap='I'> string</emphasis></term>
2092 <emphasis remap='I'>none</emphasis>.
2093 A comment string describing this set of tape information.</para>
2097 <term><emphasis remap='B'>filemark</emphasis> <emphasis remap='I'> int</emphasis></term>
2100 <emphasis remap='I'>1 kbytes</emphasis>.
2101 How large a file mark (tape mark) is, measured in kbytes.
2102 If the size is only known in some linear measurement (e.g. inches),
2103 convert it to kbytes using the device density.</para>
2107 <term><emphasis remap='B'>length</emphasis> <emphasis remap='I'> int</emphasis></term>
2110 <emphasis remap='I'>2000 kbytes</emphasis>. How much data will fit on a tape, expressed in kbytes.</para>
2112 <para>Note that this value is only used by &A; to schedule which backups will be run.
2113 Once the backups start, &A; will continue to write to a tape until it gets an error,
2114 regardless of what value is entered for <emphasis remap='B'>length</emphasis>
2115 (but see <citerefentry><refentrytitle>amanda-devices</refentrytitle><manvolnum>7</manvolnum></citerefentry> for exceptions).
2121 <term><emphasis remap='B'>blocksize</emphasis> <emphasis remap='I'> int</emphasis></term>
2124 <emphasis remap='I'>32 kbytes</emphasis>.
2125 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>
2129 <term><emphasis remap='B'>readblocksize</emphasis> <emphasis remap='I'> int</emphasis></term>
2131 <para>Default: <emphasis remap="I">32 kytes</emphasis>
2132 How much data will be read in each tape record. This can be used to override a
2133 device's block size for reads only. This may be useful, for example, in
2134 reading a tape written with a 256k block size when Amanda is configured to use
2135 128k blocks. This unusual feature is not supported by all operating systems and
2138 <para>The default unit is Kbytes if it is not specified.</para>
2143 <term><emphasis remap='B'>speed</emphasis> <emphasis remap='I'> int</emphasis></term>
2146 <emphasis remap='I'>200 bps</emphasis>.
2147 How fast the drive will accept data, in bytes per second.
2148 This parameter is NOT currently used by &A;.</para>
2152 <term><emphasis remap='B'>lbl-templ</emphasis> <emphasis remap='I'> string</emphasis></term>
2154 <para>A PostScript template file used by
2155 <emphasis remap='B'>amreport</emphasis>
2156 to generate labels. Several sample files are provided with the &A; sources in the
2157 <emphasis remap='I'>example</emphasis> directory.
2159 <citerefentry><refentrytitle>amreport</refentrytitle><manvolnum>8</manvolnum></citerefentry>
2160 man page for more information.</para>
2165 <para>In addition to options, another
2166 <emphasis remap='B'>tapetype</emphasis>
2167 name may be supplie as an identifier, which makes this
2168 <emphasis remap='B'>tapetype</emphasis>
2169 inherit options from another
2170 <emphasis remap='B'>tapetype</emphasis>.
2171 For instance, the only difference between a DLT4000 tape drive using
2172 Compact-III tapes and one using Compact-IV tapes is the length of the tape.
2173 So they could be entered as:</para>
2175 <programlisting remap='.nf'>
2176 define tapetype "DLT4000-III" {
2177 comment "DLT4000 tape drives with Compact-III tapes"
2178 length 12500 mbytes # 10 Gig tapes with some compression
2179 filemark 2000 kbytes
2182 define tapetype "DLT4000-IV" {
2184 comment "DLT4000 tape drives with Compact-IV tapes"
2185 length 25000 mbytes # 20 Gig tapes with some compression
2189 <!-- If anybody has read this, where do all those stupid
2190 pseudo-duplicate FOM-tapetype-entries come from??
2196 <refsect1><title>INTERFACE SECTION</title>
2198 <emphasis remap='B'>amanda.conf</emphasis>
2199 file may define multiple types of network interfaces.
2200 The information is entered in an <emphasis remap='B'>interface</emphasis>
2201 section, which looks like this:</para>
2204 define interface "<emphasis remap='I'>name</emphasis>" {
2205 <emphasis remap='I'>interface-option</emphasis> <emphasis remap='I'>interface-value</emphasis>
2206 <literal>...</literal>
2210 <para><emphasis remap='I'>name</emphasis>
2211 is the name of this type of network interface. It is referenced from the
2212 <emphasis remap='I'>disklist</emphasis> file.</para>
2214 <para>Note that these sections define network interface characteristics,
2215 not the actual interface that will be used. Nor do they impose limits on the bandwidth that will
2216 actually be taken up by &A;.
2217 &A; computes the estimated bandwidth each file system backup will take
2218 based on the estimated size and time, then compares that plus any other running
2219 backups with the limit as another of the criteria when deciding whether
2220 to start the backup. Once a backup starts, &A; will use as much of the network as it can
2221 leaving throttling up to the operating system and network hardware.</para>
2223 <para>The interface options and values are:</para>
2224 <variablelist remap='TP'>
2226 <term><emphasis remap='B'>comment</emphasis> <emphasis remap='I'> string</emphasis></term>
2229 <emphasis remap='I'>none</emphasis>.
2230 A comment string describing this set of network information.</para>
2234 <term><emphasis remap='B'>use</emphasis> <emphasis remap='I'> int</emphasis></term>
2237 <emphasis remap='I'>8000 Kbps</emphasis>.
2238 The speed of the interface in Kbytes per second.</para>
2243 <para>In addition to options, another
2244 <emphasis remap='B'>interface</emphasis>
2245 name may be supplied as an identifier, which makes this
2246 <emphasis remap='B'>interface</emphasis>
2247 inherit options from another
2248 <emphasis remap='B'>interface</emphasis>.
2249 At the moment, this is of little use.</para>
2252 <refsect1><title>APPLICATION SECTION</title>
2254 <emphasis remap='B'>amanda.conf</emphasis>
2255 file may define multiple types of application.
2256 The information is entered in a <emphasis remap='B'>application-tool</emphasis>
2257 section, which looks like this:</para>
2260 define application-tool "<emphasis remap='I'>name</emphasis>" {
2261 <emphasis remap='I'>application-option</emphasis> <emphasis remap='I'>application-value</emphasis>
2262 <literal>...</literal>
2266 <para><emphasis remap='I'>name</emphasis>
2267 is the name of this type of application. It is referenced from the
2268 <emphasis remap='I'>dumptype</emphasis></para>
2270 <para>The application-tool options and values are:</para>
2271 <variablelist remap='TP'>
2273 <term><emphasis remap='B'>comment</emphasis> <emphasis remap='I'>string</emphasis></term>
2276 <emphasis remap='I'>none</emphasis>.
2277 A comment string describing this application.</para>
2281 <term><emphasis remap='B'>plugin</emphasis> <emphasis remap='I'>string</emphasis></term>
2283 <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>
2287 <term><emphasis remap='B'>property</emphasis> [append] [priority] <emphasis remap='I'>string</emphasis> <emphasis remap='I'>string</emphasis>+</term>
2289 <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
2290 the property to set, and the others contains its values.
2291 <emphasis remap='B'>append</emphasis> keyword append the values to the list of values for that property.
2292 <emphasis remap='B'>priority</emphasis> keyword disallow the setting of that property on the client.
2299 <refsect1><title>SCRIPT SECTION</title>
2301 <emphasis remap='B'>amanda.conf</emphasis>
2302 file may define multiple types of script.
2303 The information is entered in a <emphasis remap='B'>script-tool</emphasis>
2304 section, which looks like this:</para>
2307 define script-tool "<emphasis remap='I'>name</emphasis>" {
2308 <emphasis remap='I'>script-option</emphasis> <emphasis remap='I'>script-value</emphasis>
2309 <literal>...</literal>
2313 <para><emphasis remap='I'>name</emphasis>
2314 is the name of this type of script. It is referenced from the
2315 <emphasis remap='I'>dumptype</emphasis></para>
2317 <para>The script-tool options and values are:</para>
2318 <variablelist remap='TP'>
2320 <term><emphasis remap='B'>comment</emphasis> <emphasis remap='I'>string</emphasis></term>
2323 <emphasis remap='I'>none</emphasis>.
2324 A comment string describing this script.</para>
2328 <term><emphasis remap='B'>plugin</emphasis> <emphasis remap='I'>string</emphasis></term>
2330 <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>
2334 <term><emphasis remap='B'>execute_where</emphasis> [client|server]</term>
2336 <para>Default: <emphasis remap='I'>client</emphasis>. Where the script must be executed, on the client or server.</para>
2340 <term><emphasis remap='B'>execute_on</emphasis> <emphasis remap='I'>execute_on</emphasis>[,<emphasis remap='I'>execute_on</emphasis>]*</term>
2342 <para>No default. When the script must be executed, you can specify many of them:</para>
2344 <variablelist remap='TP'>
2346 <term><emphasis remap='B'>pre-dle-amcheck</emphasis></term>
2348 <para>Execute before the amcheck command for the dle.</para>
2352 <term><emphasis remap='B'>pre-host-amcheck</emphasis></term>
2354 <para>Execute before the amcheck command for all dle for the client.</para>
2358 <term><emphasis remap='B'>post-dle-amcheck</emphasis></term>
2360 <para>Execute after the amcheck command for the dle.</para>
2364 <term><emphasis remap='B'>post-host-amcheck</emphasis></term>
2366 <para>Execute after the amcheck command for all dle for the client.</para>
2370 <term><emphasis remap='B'>pre-dle-estimate</emphasis></term>
2372 <para>Execute before the estimate command for the dle.</para>
2376 <term><emphasis remap='B'>pre-host-estimate</emphasis></term>
2378 <para>Execute before the estimate command for all dle for the client.</para>
2382 <term><emphasis remap='B'>post-dle-estimate</emphasis></term>
2384 <para>Execute after the estimate command for the dle.</para>
2388 <term><emphasis remap='B'>post-host-estimate</emphasis></term>
2390 <para>Execute after the estimate command for all dle for the client.</para>
2394 <term><emphasis remap='B'>pre-dle-backup</emphasis></term>
2396 <para>Execute before the backup command for the dle.</para>
2400 <term><emphasis remap='B'>pre-host-backup</emphasis></term>
2402 <para>Execute before the backup command for all dle for the client.</para>
2406 <term><emphasis remap='B'>post-dle-backup</emphasis></term>
2408 <para>Execute after the backup command for the dle.</para>
2412 <term><emphasis remap='B'>post-host-backup</emphasis></term>
2414 <para>Execute after the backup command for all dle for the client.</para>
2418 <term><emphasis remap='B'>pre-recover</emphasis></term>
2420 <para>Execute before any level is recovered.</para>
2424 <term><emphasis remap='B'>post-recover</emphasis></term>
2426 <para>Execute after all levels are recovered.</para>
2430 <term><emphasis remap='B'>pre-level-recover</emphasis></term>
2432 <para>Execute before each level recovery.</para>
2436 <term><emphasis remap='B'>post-level-recover</emphasis></term>
2438 <para>Execute after each level recovery.</para>
2442 <term><emphasis remap='B'>inter-level-recover</emphasis></term>
2444 <para>Execute between two levels of recovery.</para>
2448 <para>If you recover level 0 and 2 of the disk /usr with amrecover, it will execute:</para>
2450 script --pre-recover
2451 script --pre-level-recover --level 0
2453 script --post-level-recover --level 0
2454 script --inter-level-recover --level 0 --level 2
2455 script --pre-level-recover --level 2
2457 script --post-level-recover --level 2
2458 script --post-recover
2463 <term><emphasis remap='B'>property</emphasis> [append] [priority] <emphasis remap='I'>string</emphasis> <emphasis remap='I'>string</emphasis>+</term>
2465 <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
2466 the property to set, and the others contains its values.
2467 <emphasis remap='B'>append</emphasis> keyword append the values to the list of values for that property.
2468 <emphasis remap='B'>priority</emphasis> keyword disallow the setting of that property on the client.
2475 <refsect1><title>DEVICE SECTION</title>
2476 <para>Backend storage devices are specified in
2477 <emphasis remap='B'>amanda.conf</emphasis>
2478 in the form of "device" sections, which look like this:</para>
2481 define device <emphasis remap='I'>name</emphasis> {
2482 commend "<emphasis remap='I'>comment (optional)</emphasis>"
2483 tapedev "<emphasis remap='I'>device-specifier</emphasis>"
2484 device_property "<emphasis remap='I'>prop-name</emphasis>" "<emphasis remap='I'>prop-value</emphasis>"
2485 <literal>...</literal>
2489 <para><emphasis remap='I'>name</emphasis> is the user-specified name of
2490 this device. It is referenced from the global <emphasis
2491 remap='I'>tapedev</emphasis> parameter. The <emphasis
2492 remap='I'>device-specifier</emphasis> specifies the device name to use;
2493 see <citerefentry><refentrytitle>amanda-devices</refentrytitle><manvolnum>7</manvolnum></citerefentry>.
2494 As with most sections, the <emphasis remap='I'>comment</emphasis>
2495 parmeter is optional and only for the user's convenience.</para>
2497 <para>An arbitrary number of <emphasis
2498 remap='I'>device_property</emphasis> parameters can be specified.
2500 <citerefentry><refentrytitle>amanda-devices</refentrytitle><manvolnum>7</manvolnum></citerefentry>
2501 for information on device properties.</para>
2505 <refsect1><title>CHANGER SECTION</title>
2506 <para>Changers are described in
2507 <emphasis remap='B'>amanda.conf</emphasis>
2508 in the form of "changer" sections, which look like this:</para>
2511 define changer <emphasis remap='I'>name</emphasis> {
2512 comment "<emphasis remap='I'>comment (optional)</emphasis>"
2513 tapedev "<emphasis remap='I'>tape-device</emphasis>"
2514 tpchanger "<emphasis remap='I'>changer-type</emphasis>"
2515 changerdev "<emphasis remap='I'>device-name</emphasis>"
2516 changerfile "<emphasis remap='I'>state-file</emphasis>"
2517 <literal>...</literal>
2521 <para><emphasis remap='I'>name</emphasis> is the user-specified name of this
2522 device. The remaining parameters are specific to the changer type selected.
2527 <refsect1><title>SEE ALSO</title>
2529 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
2530 <citerefentry><refentrytitle>amanda-client.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2531 <citerefentry><refentrytitle>amcrypt</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
2532 <citerefentry><refentrytitle>aespipe</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2533 <ulink url="http://wiki.zmanda.com"/>