<refmeta>
<refentrytitle>amanda-client.conf</refentrytitle>
<manvolnum>5</manvolnum>
+&rmi.source;
+&rmi.version;
+&rmi.manual.5;
</refmeta>
<refnamediv>
<refname>amanda-client.conf</refname>
<refpurpose>Client configuration file for &A;, the Advanced Maryland Automatic Network Disk Archiver</refpurpose>
</refnamediv>
+<refentryinfo>
+&author.jds;
+&author.sgw.xml;
+</refentryinfo>
<!-- body begins here -->
<refsect1><title>DESCRIPTION</title>
<para> The files <emphasis remap='B'><CONFIG_DIR>/amanda-client.conf</emphasis> and <emphasis remap='B'><CONFIG_DIR>/<config>/amanda-client.conf</emphasis> are loaded.</para>
</refsect1>
-<refsect1><title>PARAMETERS</title>
+<refsect1><title>SYNTAX</title>
-<para>There are a number of configuration parameters that control the
-behavior of the &A; programs.
-All have default values,
-so you need not specify the parameter in
-<emphasis remap='B'>amanda-client.conf</emphasis>
-if the default is suitable.</para>
+The syntax of &amclientconf; is identical to that for
+<citerefentry><refentrytitle>amanda.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
-<para>Lines starting with # are ignored, as are blank lines.
-Comments may be placed on a line with a directive by starting
-the comment with a #.
-The remainder of the line is ignored.</para>
-
-<para>Keywords are case insensitive, i.e.
-<emphasis remap='B'>auth</emphasis>
-and
-<emphasis remap='B'>Auth</emphasis>
-are treated the same.</para>
-
-<para>Integer arguments may have one of the following (case insensitive) suffixes,
-some of which have a multiplier effect:</para>
+</refsect1>
-<refsect2><title>POSSIBLE SUFFIXES</title>
+<refsect1>
+<title>GLOBAL PARAMETERS</title>
<variablelist remap='TP'>
<varlistentry>
- <term><emphasis remap='B'>b byte bytes</emphasis></term>
- <listitem>
-<para>Some number of bytes.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis remap='B'>bps</emphasis></term>
- <listitem>
-<para>Some number of bytes per second.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis remap='B'>k kb kbyte kbytes kilobyte kilobytes</emphasis></term>
- <listitem>
-<para>Some number of kilobytes (bytes*1024).</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis remap='B'>kps kbps</emphasis></term>
- <listitem>
-<para>Some number of kilobytes per second (bytes*1024).</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis remap='B'>m mb meg mbyte mbytes megabyte megabytes</emphasis></term>
- <listitem>
-<para>Some number of megabytes (bytes*1024*1024).</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis remap='B'>mps mbps</emphasis></term>
- <listitem>
-<para>Some number of megabytes per second (bytes*1024*1024).</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis remap='B'>g gb gbyte gbytes gigabyte gigabytes</emphasis></term>
- <listitem>
-<para>Some number of gigabytes (bytes*1024*1024*1024).</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis remap='B'>tape tapes</emphasis></term>
- <listitem>
-<para>Some number of tapes.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis remap='B'>day days</emphasis></term>
- <listitem>
-<para>Some number of days.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis remap='B'>week weeks</emphasis></term>
+ <term><emphasis remap='B'>conf</emphasis> <emphasis remap='I'> string</emphasis></term>
<listitem>
-<para>Some number of weeks (days*7).</para>
-
-<note><para>The value
-<emphasis remap='B'>inf</emphasis>
-may be used in most places where an integer is expected
-to mean an infinite amount.</para>
-
-<para>Boolean arguments may have any of the values
-<emphasis remap='B'>y</emphasis>,
-<emphasis remap='B'>yes</emphasis>,
-<emphasis remap='B'>t</emphasis>,
-<emphasis remap='B'>true</emphasis>
-or
-<emphasis remap='B'>on</emphasis>
-to indicate a true state, or
-<emphasis remap='B'>n</emphasis>,
-<emphasis remap='B'>no</emphasis>,
-<emphasis remap='B'>f</emphasis>,
-<emphasis remap='B'>false</emphasis>
-or
-<emphasis remap='B'>off</emphasis>
-to indicate a false state.
-If no argument is given,
-<emphasis remap='B'>true</emphasis>
-is assumed.
-</para>
-</note>
+<para>Default:
+<emphasis remap='I'>Set by configure</emphasis>.
+The conf use by amrecover.</para>
</listitem>
</varlistentry>
-</variablelist>
-</refsect2>
-<refsect2>
-<title>PARAMETERS</title>
-
-<variablelist remap='TP'>
<varlistentry>
- <term><emphasis remap='B'>conf</emphasis> <emphasis remap='I'> string</emphasis></term>
+ <term><emphasis remap='B'>client_username</emphasis> <emphasis remap='I'> string</emphasis></term>
<listitem>
<para>Default:
-<emphasis remap='I'>Set by configure</emphasis>.
-The conf use by amrecover.</para>
+<emphasis remap='I'>CLIENT_LOGIN</emphasis>.
+Similar to the parameter of the same name in &amconf;, this specifies the username that
+&amrecover; should send when connecting to the server. It should match the username
+specified in &amandahosts; on the server.</para>
</listitem>
</varlistentry>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>mailer</emphasis> <emphasis remap='I'> string</emphasis></term>
+ <listitem>
+<para>Default found by configure. A mail program that can send mail with '<emphasis remap='I'>MAILER -s "subject" user < message_file</emphasis>'.</para>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term><emphasis remap='B'>amandates</emphasis> <emphasis remap='I'> string</emphasis></term>
<listitem>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>property</emphasis> "name" "value"</term>
+ <listitem>
+<para>Adds a global property for this client host, useful for e.g., Application API plugins.</para>
+ </listitem>
+ </varlistentry>
+
+</variablelist>
+</refsect1>
+
+<refsect1><title>APPLICATION SECTION</title>
+<para>The
+<emphasis remap='B'>amanda.conf</emphasis>
+file may define multiple types of application.
+The information is entered in a <emphasis remap='B'>application-tool</emphasis>
+section, which looks like this:</para>
+
+<programlisting>
+define application-tool "<emphasis remap='I'>name</emphasis>" {
+ <emphasis remap='I'>application-option</emphasis> <emphasis remap='I'>appli
+cation-value</emphasis>
+ <literal>...</literal>
+}
+</programlisting>
+
+<para><emphasis remap='I'>name</emphasis>
+is the name of this type of application. It is referenced from the
+<emphasis remap='I'>dumptype</emphasis></para>
+
+<para>The application-tool options and values are:</para>
+<variablelist remap='TP'>
+ <varlistentry>
+ <term><emphasis remap='B'>comment</emphasis> <emphasis remap='I'>string</emphasis></term>
+ <listitem>
+<para>Default:
+<emphasis remap='I'>none</emphasis>.
+A comment string describing this application.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>plugin</emphasis> <emphasis remap='I'>string</emphasis></term>
+ <listitem>
+<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>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>property</emphasis> [append] [priority] <emphasis remap='I'>string</emphasis> <emphasis remap='I'>string</emphasis>+</term>
+ <listitem>
+<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
+the property to set, and the others contains its values.
+<emphasis remap='B'>append</emphasis> keyword append the values to the list of values for that property.
+<emphasis remap='B'>priority</emphasis> keyword disallow the setting of that property on the server.
+</para>
+ </listitem>
+ </varlistentry>
</variablelist>
-</refsect2>
</refsect1>
-<refsect1><title>AUTHOR</title>
-<para>James da Silva, &email.jds;: Original text</para>
-<para>&maintainer.sgw;: XML-conversion, major update, splitting</para>
+<refsect1><title>SCRIPT SECTION</title>
+<para>The
+<emphasis remap='B'>amanda.conf</emphasis>
+file may define multiple types of script.
+The information is entered in a <emphasis remap='B'>script-tool</emphasis>
+section, which looks like this:</para>
+
+<programlisting>
+define script-tool "<emphasis remap='I'>name</emphasis>" {
+ <emphasis remap='I'>script-option</emphasis> <emphasis remap='I'>script-value</emphasis>
+ <literal>...</literal>
+}
+</programlisting>
+
+<para><emphasis remap='I'>name</emphasis>
+is the name of this type of script. It is referenced from the
+<emphasis remap='I'>dumptype</emphasis></para>
+
+<para>The script-tool options and values are:</para>
+<variablelist remap='TP'>
+ <varlistentry>
+ <term><emphasis remap='B'>comment</emphasis> <emphasis remap='I'>string</emphasis></term>
+ <listitem>
+<para>Default:
+<emphasis remap='I'>none</emphasis>.
+A comment string describing this script.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>plugin</emphasis> <emphasis remap='I'>string</emphasis></term>
+ <listitem>
+<para>No default. Must be set to the name of the program. This program must be in the <emphasis remap='I'>$libdir/amanda/application</emphasis> directory on the client and/or server.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>execute_where</emphasis> [client|server]</term>
+ <listitem>
+<para>Default: <emphasis remap='I'>client</emphasis>. Where the script must be executed, on the client or server. Only <emphasis remap='I'>client</emphasis> is valid.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>execute_on</emphasis> <emphasis remap='I'>execute_on</emphasis>[,<emphasis remap='I'>execute_on</emphasis>]*</term>
+ <listitem>
+<para>No default. When the script must be executed, you can specify many of them:</para>
+ <!-- .RS -->
+ <variablelist remap='TP'>
+ <varlistentry>
+ <term><emphasis remap='B'>pre-dle-amcheck</emphasis></term>
+ <listitem>
+<para>Execute before the amcheck command for the dle.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>pre-host-amcheck</emphasis></term>
+ <listitem>
+<para>Execute before the amcheck command for all dle for the client.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>post-dle-amcheck</emphasis></term>
+ <listitem>
+<para>Execute after the amcheck command for the dle.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>post-host-amcheck</emphasis></term>
+ <listitem>
+<para>Execute after the amcheck command for all dle for the client.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>pre-dle-estimate</emphasis></term>
+ <listitem>
+<para>Execute before the estimate command for the dle.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>pre-host-estimate</emphasis></term>
+ <listitem>
+<para>Execute before the estimate command for all dle for the client.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>post-dle-estimate</emphasis></term>
+ <listitem>
+<para>Execute after the estimate command for the dle.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>post-host-estimate</emphasis></term>
+ <listitem>
+<para>Execute after the estimate command for all dle for the client.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>pre-dle-backup</emphasis></term>
+ <listitem>
+<para>Execute before the backup command for the dle.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>pre-host-backup</emphasis></term>
+ <listitem>
+<para>Execute before the backup command for all dle for the client.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>post-dle-backup</emphasis></term>
+ <listitem>
+<para>Execute after the backup command for the dle.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>post-host-backup</emphasis></term>
+ <listitem>
+<para>Execute after the backup command for all dle for the client.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>pre-recover</emphasis></term>
+ <listitem>
+<para>Execute before any level is recovered.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>post-recover</emphasis></term>
+ <listitem>
+<para>Execute after all levels are recovered.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>pre-level-recover</emphasis></term>
+ <listitem>
+<para>Execute before each level recovery.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>post-level-recover</emphasis></term>
+ <listitem>
+<para>Execute after each level recovery.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>inter-level-recover</emphasis></term>
+ <listitem>
+<para>Execute between two levels of recovery.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap='B'>property</emphasis> [append] [priority] <emphasis remap='I'>string</emphasis> <emphasis remap='I'>string</emphasis>+</term>
+ <listitem>
+<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
+the property to set, and the others contains its values.
+<emphasis remap='B'>append</emphasis> keyword append the values to the list of values for that property.
+<emphasis remap='B'>priority</emphasis> keyword disallow the setting of that property on the server.
+</para>
+ </listitem>
+ </varlistentry>
+</variablelist>
</refsect1>
<refsect1><title>SEE ALSO</title>
projects / debian / amanda / blobdiff