</variablelist>
</listitem>
</varlistentry>
+
+ <varlistentry>
+ <term><amkeyword>report-use-media</amkeyword> <amtype>boolean</amtype></term>
+ <listitem>
+<para>Default:
+<amdefault>True</amdefault> if <amkeyword>max-dle-by-volume</amkeyword>
+is not set,
+<amdefault>False</amdefault> if it is set.
+If the reporter must print the list of media used in the run.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><amkeyword>report-next-media</amkeyword> <amtype>boolean</amtype></term>
+ <listitem>
+<para>Default:
+<amdefault>True</amdefault> if <amkeyword>max-dle-by-volume</amkeyword>
+is not set,
+<amdefault>False</amdefault> if it is set.
+If the reporter must print the list of media expected for the next run.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><amkeyword>max-dle-by-volume</amkeyword> <amtype>int</amtype></term>
+ <listitem>
+<para>Default:
+<amdefault>1000000000</amdefault>.
+The maximum number of dle written to a single volume.</para>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term><amkeyword>dumpcycle</amkeyword> <amtype>int</amtype></term>
<listitem>
<amkeyword>runtapes</amkeyword>.</para>
</listitem>
</varlistentry>
+
<varlistentry>
<term><amkeyword>tapecycle</amkeyword> <amtype>int</amtype></term>
<listitem>
because when set, Amanda may erase near-failing tapes or tapes accidentally
loaded in the wrong slot.</para>
<para>When using this directive, specify the template for new tape
-labels. The template should contain some number of contiguous '%'
+labels. The template can contains many variables that are substituted by their
+values:
+<programlisting>
+ $c : config name
+ $o : org configuration
+ $b : barcode of the volume
+ $s : slot number, can specify a minimun number of digit:
+ $3s to get '001'
+ $m : meta label
+</programlisting></para>
+<para>The template can contain some number of contiguous '%'
characters, which will be replaced with a generated number. Be sure to
specify enough '%' characters that you do not run out of tape labels.
Example:
-<markup>autolabel "DailySet1-%%%" empty</markup>
+<markup>"DailySet1-%%%"</markup>,
+<markup>"$c-%%%"</markup>,
+<markup>"$m-%%%"</markup>,
+<markup>"$m-$b"</markup>
+</para>
+<para>The generared label can be used only if it match the
+<amkeyword>labelstr</amkeyword> setting. The volume will not be used if the
+generated label doesn't match the <amkeyword>labelstr</amkeyword> setting.
</para>
<para>Note that many devices cannot distinguish an empty tape from an error
condition, so it may is often necessary to include
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><amkeyword>meta-autolabel</amkeyword>
+ <amtype>string</amtype></term>
+ <listitem>
+<para>Default: not set. When set and if the changer support meta-label, this directive will cause Amanda to automatically add a meta-label to a meta-volume.</para>
+<para>A meta-volume is a containers that contains many volumes, eg. a removable
+hard-disk for use with chg-disk, each hard disk have many slots (volume).
+The meta-label is the label to put on the meta-volume.</para>
+<para>When using this directive, specify the template for new meta
+labels. The template can contains many variables that are substituted by their
+values:
+<programlisting>
+ $c : config name
+ $o : org configuration
+</programlisting></para>
+<para>The template should contain some number of contiguous '%'
+characters, which will be replaced with a generated number. Be sure to
+specify enough '%' characters that you do not run out of meta labels.
+Example:
+<markup>"DailySet1-%%%"</markup>,
+<markup>"$o-%%%"</markup>,
+</para>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term><amkeyword>dumpuser</amkeyword> <amtype>string</amtype></term>
<listitem>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><amkeyword>interactivity</amkeyword> <amtype>string</amtype></term>
+ <listitem>
+<para>Default: not set. The interactivity module Amanda should use to interact with
+the user. See <manref name="amanda-interactivity" vol="7" /> for a list of
+modules.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><amkeyword>taperscan</amkeyword> <amtype>string</amtype></term>
+ <listitem>
+<para>Default: traditional. The taperscan module amanda should use to find a tape
+to write to. See <manref name="amanda-taperscan" vol="7" /> for a list of
+modules.</para>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term><amkeyword>changerdev</amkeyword> <amtype>string</amtype></term>
<listitem>
</listitem>
</varlistentry>
<varlistentry>
-<term><amkeyword>taper-parallel-write</amkeyword> <amtype>int</amtype></term>
-<listitem>
- </listitem>
-<para>Default: <amdefault>1</amdefault>.
+ <term><amkeyword>taper-parallel-write</amkeyword> <amtype>int</amtype></term>
+ <listitem>
+ <para>Default: <amdefault>1</amdefault>.
Amanda can write simultaneously up to that number of volume at any given
time. The changer must have as many drives.</para>
- </varlistentry>
+ </listitem>
+</varlistentry>
+
+<varlistentry>
+ <term><amkeyword>eject-volume</amkeyword> <amtype>int</amtype></term>
+ <listitem>
+ <para>Default: <amdefault>no</amdefault>.
+Set to <amkeyword>yes</amkeyword> if you want the volume to be ejected
+after Amanda wrote data to it. It works only with some changer and device.</para>
+ </listitem>
+</varlistentry>
+
<varlistentry>
<term><amkeyword>labelstr</amkeyword> <amtype>string</amtype></term>
<listitem>
<term><amkeyword>netusage</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
-<amdefault>8000 Kbps</amdefault>.
+<amdefault>80000 Kbps</amdefault>.
The maximum network bandwidth allocated to Amanda, in Kbytes per second.
See also the
<emphasis remap='B'>interface</emphasis>
</listitem>
</varlistentry>
<varlistentry>
- <term><amkeyword>autoflush</amkeyword> <amtype>bool</amtype></term>
+ <term><amkeyword>autoflush</amkeyword> <amkeyword>no</amkeyword>|<amkeyword>yes</amkeyword>|<amkeyword>all</amkeyword></term>
<listitem>
<para>Default:
-<amkeyword>off</amkeyword>.
-Whether an amdump run will flush the dumps from holding disk to tape.</para>
+<amkeyword>no</amkeyword>.
+Whether an amdump run will flush the dumps from holding disk to tape.
+With <amkeyword>yes</amkeyword>, only dump matching the command line argument are flushed.
+With <amkeyword>all</amkeyword>, all dump are flushed.</para>
</listitem>
</varlistentry>
<varlistentry>
<varlistentry>
<term><amkeyword>columnspec</amkeyword> <amtype>string</amtype></term>
<listitem>
-<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>
+<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>
<para>Defines the width of columns <emphasis remap='B'>amreport</emphasis>
should use.
<emphasis remap='I'>String</emphasis>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><amkeyword>debug-recovery</amkeyword> <amtype>int</amtype></term>
+ <listitem>
+<para>Default:
+<amdefault>1</amdefault>.
+Debug level of all recovery process</para>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term><amkeyword>flush-threshold-dumped</amkeyword> <amtype>int</amtype></term>
<listitem>
</varlistentry>
<varlistentry>
- <term><amkeyword>recovery-limit</amkeyword> [ <amtype>string</amtype> | <amkeyword>same-host</amkeyword> ]</term>
+ <term><amkeyword>recovery-limit</amkeyword> [ <amtype>string</amtype> | <amkeyword>same-host</amkeyword> | <amkeyword>server</amkeyword>]</term>
<listitem>
<para>Default: none (no limitations). This parameter limits the hosts
- that may do remote recoveries. Hosts are identified by their authenticated
+ that may do recoveries. Hosts are identified by their authenticated
peer name, as described in <manref name="amanda-auth" vol="7"/>; if this is
not available and the recovery-limit parameter is present, recovery will be
denied. The arguments to the parameter are strings giving host match
expressions (see <manref name="amanda-match" vol="7"/>) or the special
- keyword same-host, which requires an exact match to the hostname of the
- DLE being recovered. Specifying no arguments at all will disable all
+ keywords <amkeyword>same-host</amkeyword> or <amkeyword>server</amkeyword>.
+ The <amkeyword>same-host</amkeyword> keyword requires an exact
+ match to the hostname of the DLE being recovered.
+ The <amkeyword>server</amkeyword> keyword require the connection come from
+ the fqdn of the server.
+ Specifying no arguments at all will disable all
recoveries from any host.</para>
<para>Note that match expressions can be constructed to be
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><amkeyword>tmpdir</amkeyword> <amtype>string</amtype></term>
+ <listitem>
+<para>Default: none (system default). Set it to a directory with lots of free
+space if sort in amindexd fail with 'No space left on device'.</para>
+ </listitem>
+ </varlistentry>
</variablelist>
</refsect1>
<term><amkeyword>auth</amkeyword> <amtype>string</amtype></term>
<listitem>
<para>Default:
-<amdefault>"bsd"</amdefault>.
+<amdefault>"bsdtcp"</amdefault>.
Type of authorization to perform between tape server and backup client hosts. See <manref name="amanda-auth" vol="7"/> for more detail.</para>
</listitem>
</varlistentry>
</listitem>
</varlistentry>
+
<!-- bumping parameters yanked from the global section above -->
<varlistentry>
<amdefault>10000</amdefault>.
The maximum number of day for a promotion, set it 0 if you don't want
promotion, set it to 1 or 2 if your disks get overpromoted.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><amkeyword>max-warnings</amkeyword> <amtype>int</amtype></term>
+ <listitem>
+<para>Default:
+<amdefault>20</amdefault>.
+The maximum number of error lines in the report for a dle. A value of '0'
+means unlimited. This is useful to reduce the size of the log file and the
+size of the report. All errors are put in separate files if a dle have more
+errors.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><amkeyword>record</amkeyword> <amtype>boolean</amtype></term>
<listitem>
<para>Default:
-<amkeyword>yes</amkeyword>.
-Whether to ask the backup program to update its database (e.g. <filename>/etc/dumpdates</filename>
+<emphasis remap='I'>yes</emphasis>.
+Whether to ask the backup program to update its database (e.g. <filename>/var/lib/dumpdates</filename>
for DUMP or <filename>/usr/local/var/amanda/gnutar-lists</filename> for GNUTAR) of time stamps.
This is normally enabled for daily backups and turned off for periodic archival runs.</para>
</listitem>
<varlistentry>
<term><amkeyword>recovery-limit</amkeyword>
- [ <amkeyword>same-host</amkeyword> | <amtype>string</amtype> ]*</term>
+ [ <amkeyword>s
erver</amkeyword> | <amkeyword>same-host</amkeyword> | <amtype>string</amtype> ]*</term>
<listitem>
<para>Default: global value. This parameter overrides the global
</listitem>
</varlistentry>
+
+ <varlistentry>
+ <term><amkeyword>dump-limit</amkeyword>
+ [ <amkeyword>server</amkeyword> | <amkeyword>same-host</amkeyword> ]*</term>
+ <listitem>
+
+<para>Default: <amkeyword>server</amkeyword>. Specify which host can initiate
+ a backup of the dle. With <amkeyword>server</amkeyword>, the server
+ can initiate a backup with the <command>amdump</command> command.
+ With <amkeyword>same-host</amkeyword>, the client can initiate a backup with
+ the <command>amdump_client</command> command.</para>
+
+ </listitem>
+ </varlistentry>
</variablelist>
<para>The following <amkeyword>dumptype</amkeyword> entries are predefined by Amanda:</para>
compress server fast
}
define dumptype "bsd-auth" {
- auth bsd
+ auth "bsd"
+}
+define dumptype "bsdtcp-auth" {
+ auth "bsdtcp"
}
define dumptype "no-record" {
record no
<varlistentry>
<term><amkeyword>part-size</amkeyword> <amtype>int</amtype></term>
<listitem>
-<para>Default: none. This is the size (in KB if no units are specified) of
-each split part written to the volume. It is reduced to
-<amkeyword>part-cache-max-size</amkeyword> when part caching is required.
-If this is set to zero, then no splitting will take place; in this case,
-some devices can span dumps from volume to volume, while others will cause
-the entire dump to fail if they encounter end-of-medium before the dump is
-complete. See "Dump Splitting Configuration" below.</para>
+<para>If this is set to zero (default), then no splitting will take place,
+and the entire dump will fail, if end-of-medium is encountered before
+the dump is complete, unless the device property LEOM is true, and the
+device can detect EOM. See "Dump Splitting Configuration" below.</para>
</listitem>
</varlistentry>
<term><amkeyword>use</amkeyword> <amtype>int</amtype></term>
<listitem>
<para>Default:
-<amdefault>8000 Kbps</amdefault>.
+<amdefault>80000 Kbps</amdefault>.
The speed of the interface in Kbytes per second.</para>
</listitem>
</varlistentry>
<para>The application options and values are:</para>
<variablelist remap='TP'>
+ <varlistentry>
+ <term><amkeyword>client-name</amkeyword> <amtype>string</amtype></term>
+ <listitem>
+<para>No default,
+specifies an application name that is in the amanda-client.conf on the client.
+The setting from that application will be merged with the current application.
+If <amkeyword>client-name</amkeyword> is set then it is an error
+if that application is not defined on the client.</para>
+<para>If <amkeyword>client-name</amkeyword> is not set then the
+merge is done with the application that have the name equal to the plugin.
+eg. if the plugin is 'amgtar', then the setting from the application 'amgtar'
+is used if it is defined.
+</para>
+ </listitem>
+ </varlistentry>
<varlistentry>
<term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
<listitem>
<para>The script options and values are:</para>
<variablelist remap='TP'>
+ <varlistentry>
+ <term><amkeyword>client-name</amkeyword> <amtype>string</amtype></term>
+ <listitem>
+<para>No default,
+specifies a script name that is in the amanda-client.conf on the client.
+The setting from that script will be merged with the currect script.
+If <amkeyword>client-name</amkeyword> is set then it is an error if that script is not defined on the client.</para>
+<para>If <amkeyword>client-name</amkeyword> is not set then the
+merge is done with the script that have the name equal to the plugin.
+eg. if the plugin is 'amlog-script', then the setting from the script
+'amlog-script' is used.
+</para>
+ </listitem>
+ </varlistentry>
<varlistentry>
<term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
<listitem>
<term><amkeyword>order</amkeyword> <amtype>int</amtype></term>
<listitem>
<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>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><amkeyword>single-execution</amkeyword> <amtype>boolean</amtype></term>
+ <listitem>
+<para>Default: <amdefault>no</amdefault>. The script is executed for each dle. If <amdefault>yes</amdefault>, the script is executed one time only.</para>
</listitem>
</varlistentry>
<varlistentry>
<para>No default. When the script must be executed, you can specify many of them:</para>
<!-- .RS -->
<variablelist remap='TP'>
+ <varlistentry>
+ <term><amkeyword>pre-amcheck</amkeyword></term>
+ <listitem>
+<para>Execute before the amcheck command for all dle. Can only be run on server.</para>
+ </listitem>
+ </varlistentry>
<varlistentry>
<term><amkeyword>pre-dle-amcheck</amkeyword></term>
<listitem>
<term><amkeyword>pre-host-amcheck</amkeyword></term>
<listitem>
<para>Execute before the amcheck command for all dle for the client.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><amkeyword>post-amcheck</amkeyword></term>
+ <listitem>
+<para>Execute after the amcheck command for all dle. Can only be run on server.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><amkeyword>post-host-amcheck</amkeyword></term>
<listitem>
<para>Execute after the amcheck command for all dle for the client.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><amkeyword>pre-estimate</amkeyword></term>
+ <listitem>
+<para>Execute before the estimate command for all dle. Can only be run on server.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><amkeyword>pre-host-estimate</amkeyword></term>
<listitem>
<para>Execute before the estimate command for all dle for the client.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><amkeyword>post-estimate</amkeyword></term>
+ <listitem>
+<para>Execute after the estimate command for all dle. Can only be run on server.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><amkeyword>post-host-estimate</amkeyword></term>
<listitem>
<para>Execute after the estimate command for all dle for the client.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><amkeyword>pre-backup</amkeyword></term>
+ <listitem>
+<para>Execute before the backup command for all dle. Can only be run on server.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><amkeyword>pre-host-backup</amkeyword></term>
<listitem>
<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>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><amkeyword>post-backup</amkeyword></term>
+ <listitem>
+<para>Execute after the backup command for all dle. Can only be run on server.</para>
</listitem>
</varlistentry>
<varlistentry>
</refsect1>
+<refsect1><title>INTERACTIVITY SECTION</title>
+<para>The
+<emphasis remap='B'>amanda.conf</emphasis>
+file may define multiple interactivyt methods, although only one will be used - that specified
+by the <amkeyword>interactivity</amkeyword> parameter.
+The information is entered in a <amkeyword>interactivity</amkeyword>
+section, which looks like this:</para>
+
+<programlisting>
+define interactivity <emphasis remap='I'>name</emphasis> {
+ <emphasis remap='I'>interactivity-option</emphasis> <emphasis remap='I'>interactivity-value</emphasis>
+ <literal>...</literal>
+}
+</programlisting>
+
+<para>The { must appear at the end of a line, and the } on its own line.</para>
+<para><emphasis remap='I'>name</emphasis> is the user-specified name of this
+interactivity. The remaining parameters are specific to the interactivity type
+selected.
+</para>
+
+<para>The interactivity options and values are:</para>
+<variablelist remap='TP'>
+ <varlistentry>
+ <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
+ <listitem>
+<para>Default: not set.
+A comment string describing this interactivity.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><amkeyword>plugin</amkeyword> <amtype>string</amtype></term>
+ <listitem>
+<para>No default. Must be set to the name of the interactivity module, as described in <manref name="amanda-interactivity" vol="7" />.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><amkeyword>property</amkeyword> [<amkeyword>append</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
+ <listitem>
+<para>No default. You can set arbitrary properties for the interactivity. Each interactivity module has a different set of properties. The first string contains the name of
+the property to set, and the others contains its values. All strings should be quoted.
+The <amkeyword>append</amkeyword> keyword appends the given values to an existing list of values for that property.
+</para>
+ </listitem>
+ </varlistentry>
+</variablelist>
+
+<para>See <manref name="amanda-interactivity" vol="7" /> for more information on configuring interactivity methods.</para>
+
+</refsect1>
+
+<refsect1><title>TAPERSCAN SECTION</title>
+<para>The
+<emphasis remap='B'>amanda.conf</emphasis>
+file may define multiple taperscan methods, although only one will be used - that specified
+by the <amkeyword>taperscan</amkeyword> parameter.
+The information is entered in a <amkeyword>taperscan</amkeyword>
+section, which looks like this:</para>
+
+<programlisting>
+define taperscan <emphasis remap='I'>name</emphasis> {
+ <emphasis remap='I'>taperscan-option</emphasis> <emphasis remap='I'>taperscan-value</emphasis>
+ <literal>...</literal>
+}
+</programlisting>
+
+<para>The { must appear at the end of a line, and the } on its own line.</para>
+<para><emphasis remap='I'>name</emphasis> is the user-specified name of this
+taperscan. The remaining parameters are specific to the taperscan type
+selected.
+</para>
+
+<para>The taperscan options and values are:</para>
+<variablelist remap='TP'>
+ <varlistentry>
+ <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
+ <listitem>
+<para>Default: not set.
+A comment string describing this taperscan.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><amkeyword>plugin</amkeyword> <amtype>string</amtype></term>
+ <listitem>
+<para>No default. Must be set to the name of the taperscan module. See <manref name="amanda-taperscan" vol="7" /> for a list of defined taperscan modules.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><amkeyword>property</amkeyword> [<amkeyword>append</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
+ <listitem>
+<para>No default. Operates just like properties for interactivity methods, above.</para>
+ </listitem>
+ </varlistentry>
+</variablelist>
+
+<para>See <manref name="amanda-taperscan" vol="7" /> for more information on configuring taperscan.</para>
+
+</refsect1>
+
<refsect1><title>Dump Splitting Configuration</title>
<para>Amanda can "split" dumps into parts while writing them to storage
<manref name="amanda-auth" vol="7"/>,
<manref name="amanda-changers" vol="7"/>,
<manref name="amanda-devices" vol="7"/>,
+<manref name="amanda-interactivity" vol="7"/>,
<manref name="amanda-scripts" vol="7"/>
+<manref name="amanda-taperscan" vol="7"/>
</seealso>
projects / debian / amanda / blobdiff