1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
5 <!-- entities files to use -->
6 <!ENTITY % global_entities SYSTEM 'global.entities'>
10 <refentry id='amanda-client.conf.5'>
13 <refentrytitle>amanda-client.conf</refentrytitle>
14 <manvolnum>5</manvolnum>
20 <refname>amanda-client.conf</refname>
21 <refpurpose>Client configuration file for Amanda, the Advanced Maryland Automatic Network Disk Archiver</refpurpose>
27 <!-- body begins here -->
29 <refsect1><title>DESCRIPTION</title>
30 <para>&amclientconf; is the client configuration file for Amanda. This manpage lists the
31 relevant sections and parameters of this file for quick reference.</para>
32 <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>
35 <refsect1><title>SYNTAX</title>
37 The syntax of &amclientconf; is identical to that for
38 <manref name="amanda.conf" vol="5"/>.
43 <title>GLOBAL PARAMETERS</title>
45 <variablelist remap='TP'>
47 <term><amkeyword>conf</amkeyword> <amtype>string</amtype></term>
50 <amdefault>Set by configure</amdefault>.
51 The conf use by amrecover.</para>
56 <term><amkeyword>client-username</amkeyword> <amtype>string</amtype></term>
59 <amdefault>CLIENT_LOGIN</amdefault>.
60 Similar to the parameter of the same name in &amconf;, this specifies the username that
61 &amrecover; should send when connecting to the server. It should match the username
62 specified in &amandahosts; on the server.</para>
67 <term><amkeyword>client-port</amkeyword> [ <amtype>int</amtype> | <amtype>string</amtype> ]</term>
70 <amdefault>"amanda"</amdefault>.
71 Similar to the parameter of the same name in &amconf;, this specifies the port to connect on the server. It can be a service name or a numeric port number.</para>
76 <term><amkeyword>index-server</amkeyword> <amtype>string</amtype></term>
79 <amdefault>Set by configure</amdefault>.
80 The amindexd server amrecover will connect to.</para>
85 <term><amkeyword>tape-server</amkeyword> <amtype>string</amtype></term>
88 <amdefault>Set by configure</amdefault>.
89 The amidxtaped server amrecover will connect to.</para>
94 <term><amkeyword>tapedev</amkeyword> <amtype>string</amtype></term>
97 <amdefault>Set by configure</amdefault>.
98 The tapedev amrecover will use.</para>
103 <term><amkeyword>auth</amkeyword> <amtype>string</amtype></term>
106 <amkeyword>"bsdtcp"</amkeyword>.
107 Type of authorization to perform between tape server and backup client hosts.</para>
108 <para><amkeyword>"bsd"</amkeyword>, bsd authorization with udp initial
109 connection and one tcp connection by data stream.</para>
110 <para><amkeyword>"bsdtcp"</amkeyword>, bsd authorization but use only
111 one tcp connection.</para>
112 <para><amkeyword>"bsdudp"</amkeyword>, like bsd, but will use only one
113 tcp connection for all data stream.</para>
114 <para><amkeyword>"krb5"</amkeyword> to use Kerberos-V
115 authorization.</para>
116 <para><amkeyword>"local"</amkeyword>, if the client is the server, it
117 doesn't require authencation setup.</para>
118 <para><amkeyword>"rsh"</amkeyword> to use rsh
119 authorization.</para>
120 <para><amkeyword>"ssh"</amkeyword> to use OpenSSH
121 authorization.</para>
127 <term><amkeyword>ssh-keys</amkeyword> <amtype>string</amtype></term>
130 <amdefault>No default</amdefault>.
131 The key file the ssh auth will use, it must be the private key. If this parameter is not specified, then the default ssh key will be used.</para>
136 <term><amkeyword>gnutar-list-dir</amkeyword> <amtype>string</amtype></term>
138 <para>Default from configure
139 <amdefault>--with-gnutar-listdir=DIR</amdefault>.
140 The directory where gnutar keep its state file.</para>
145 <term><amkeyword>mailer</amkeyword> <amtype>string</amtype></term>
147 <para>Default found by configure. A mail program that can send mail with '<emphasis remap='I'>MAILER -s "subject" user < message_file</emphasis>'.</para>
152 <term><amkeyword>amandates</amkeyword> <amtype>string</amtype></term>
155 <amdefault>/etc/amandates</amdefault>.
156 The file where amanda keep the last date of each dumplevel.</para>
161 <term><amkeyword>connect-tries</amkeyword> <amtype>int</amtype></term>
164 <amdefault>3</amdefault>.
165 How many times the server will try a connection.</para>
170 <term><amkeyword>rep-tries</amkeyword> <amtype>int</amtype></term>
173 <amdefault>5</amdefault>.
174 How many times amandad will resend a REP packet if it doesn't get the ACK packet.</para>
179 <term><amkeyword>debug-days</amkeyword> <amtype>int</amtype></term>
182 <amdefault>3</amdefault>.
183 The number of days the debug files are kept.</para>
188 <term><amkeyword>debug-amandad</amkeyword> <amtype>int</amtype></term>
191 <emphasis remap='I'>0</emphasis>.
192 Debug level of the amandad process</para>
197 <term><amkeyword>debug-amidxtaped</amkeyword> <amtype>int</amtype></term>
200 <amdefault>0</amdefault>.
201 Debug level of the amidxtaped process</para>
206 <term><amkeyword>debug-amindexd</amkeyword> <amtype>int</amtype></term>
209 <amdefault>0</amdefault>.
210 Debug level of the amindexd process</para>
215 <term><amkeyword>debug-amrecover</amkeyword> <amtype>int</amtype></term>
218 <amdefault>0</amdefault>.
219 Debug level of the amrecover process</para>
224 <term><amkeyword>debug-auth</amkeyword> <amtype>int</amtype></term>
227 <amdefault>0</amdefault>.
228 Debug level of the auth module</para>
233 <term><amkeyword>debug-event</amkeyword> <amtype>int</amtype></term>
236 <amdefault>0</amdefault>.
237 Debug level of the event module</para>
242 <term><amkeyword>debug-holding</amkeyword> <amtype>int</amtype></term>
245 <amdefault>0</amdefault>.
246 Debug level of the holdingdisk module</para>
251 <term><amkeyword>debug-protocol</amkeyword> <amtype>int</amtype></term>
254 <amdefault>0</amdefault>.
255 Debug level of the protocol module</para>
260 <term><amkeyword>debug-selfcheck</amkeyword> <amtype>int</amtype></term>
263 <amdefault>0</amdefault>.
264 Debug level of the selfcheck process</para>
269 <term><amkeyword>debug-sendsize</amkeyword> <amtype>int</amtype></term>
272 <amdefault>0</amdefault>.
273 Debug level of the sendsize process</para>
278 <term><amkeyword>debug-sendbackup</amkeyword> <amtype>int</amtype></term>
281 <amdefault>0</amdefault>.
282 Debug level of the sendbackup process</para>
287 <term><amkeyword>reserved-udp-port</amkeyword> <amtype>int</amtype>,<amtype>int</amtype></term>
289 <para>Default: --with-udpportrange or
290 <amdefault>512,1023</amdefault>.
291 Reserved udp port that will be used (amrecover with bsd or bsdudp)</para>
296 <term><amkeyword>reserved-tcp-port</amkeyword> <amtype>int</amtype>,<amtype>int</amtype></term>
298 <para>Default: --with-low-tcpportrange or
299 <amdefault>512,1023</amdefault>.
300 Reserved tcp port that will be used (amrecover with bsdtcp)</para>
305 <term><amkeyword>unreserved-tcp-port</amkeyword> <amtype>int</amtype>,<amtype>int</amtype></term>
307 <para>Default: --with-tcpportrange or
308 <amdefault>1025,65536</amdefault>.
309 Unreserved tcp port that will be used (bsd, bsdudp)</para>
314 <term><amkeyword>property</amkeyword> <amtype>string</amtype> <amtype>string</amtype>+</term>
316 <para>Adds a global property for this client host, useful for e.g., Application API plugins. The first string is the property name, the following strings are the property values</para>
323 <refsect1><title>APPLICATION SECTION</title>
325 <emphasis remap='B'>amanda-client.conf</emphasis>
326 file may define multiple types of application.
327 The information is entered in a <amkeyword>application</amkeyword>
328 section, which looks like this:</para>
331 define application "<amtype>name</amtype>" {
332 <emphasis remap='I'>application-option</emphasis> <emphasis remap='I'>application-value</emphasis>
333 <literal>...</literal>
337 <para><amtype>name</amtype>
338 is the name of this type of application.</para>
340 The setting from an application is merged with the dle setting
341 if the <amtype>name</amtype> is the same as the <amkeyword>client-application-name</amkeyword> from the dle
342 or if the <amkeyword>client-application-name</amkeyword> from the dle is not set and the <amtype>name</amtype> is the same as the <amkeyword>plugin</amkeyword> from the dle.</para>
344 <para>The application options and values are:</para>
345 <variablelist remap='TP'>
347 <term><amkeyword>client-application-name</amkeyword> <amtype>string</amtype></term>
350 <amdefault>none</amdefault>.
351 Not use on the client.</para>
355 <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
358 <amdefault>none</amdefault>.
359 A comment string describing this application.</para>
363 <term><amkeyword>plugin</amkeyword> <amtype>string</amtype></term>
365 <para>No default. Must be set to the name of the program. This program must be
366 in the <emphasis remap='I'>$libexecdir/amanda/application</emphasis> directory
367 on the client. If set, it must be the same as the dle <amkeyword>plugin</amkeyword>.</para>
371 <term><amkeyword>property</amkeyword> [<amkeyword>append</amkeyword>] [<amkeyword>priority</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
373 <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
374 the property to set, and the others contains its values.
375 <amkeyword>append</amkeyword> keyword append the values to the list of values for that property.
376 <amkeyword>priority</amkeyword> keyword disallow the setting of that property on the server.
383 <refsect1><title>SCRIPT SECTION</title>
385 <emphasis remap='B'>amanda-client.conf</emphasis>
386 file may define multiple types of script.
387 The information is entered in a <emphasis remap='B'>script</emphasis>
388 section, which looks like this:</para>
391 define script "<amtype>name</amtype>" {
392 <emphasis remap='I'>script-option</emphasis> <emphasis remap='I'>script-value</emphasis>
393 <literal>...</literal>
397 <para><amtype>name</amtype>
398 is the name of this type of script.</para>
400 The setting from a script is merged with the dle setting
401 if the <amtype>name</amtype> is the same as the <amkeyword>client-script-name</amkeyword> from the dle
402 or if the <amkeyword>client-script-name</amkeyword> from the dle is not set and the <amtype>name</amtype> is the same as the <amkeyword>plugin</amkeyword> from the dle.</para>
404 <para>The script options and values are:</para>
405 <variablelist remap='TP'>
407 <term><amkeyword>client-script-name</amkeyword> <amtype>string</amtype></term>
410 <amdefault>none</amdefault>.
411 Not used on the client.</para>
415 <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
418 <amdefault>none</amdefault>.
419 A comment string describing this script.</para>
423 <term><amkeyword>plugin</amkeyword> <amtype>string</amtype></term>
425 <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. If set, it must be the same as the dle <amkeyword>plugin</amkeyword>.</para>
429 <term><amkeyword>execute-where</amkeyword> <amkeyword>client</amkeyword></term>
431 <para>Default: <amkeyword>client</amkeyword>.
432 Value can't be changed.</para>
436 <term><amkeyword>execute-on</amkeyword> <amtype>execute_on</amtype>[,<amtype>execute_on</amtype>]*</term>
438 <para>No default. When the script must be executed, you can specify many of them:</para>
440 <variablelist remap='TP'>
442 <term><amkeyword>pre-dle-amcheck</amkeyword></term>
444 <para>Execute before the amcheck command for the dle.</para>
448 <term><amkeyword>pre-host-amcheck</amkeyword></term>
450 <para>Execute before the amcheck command for all dle for the client.</para>
454 <term><amkeyword>post-dle-amcheck</amkeyword></term>
456 <para>Execute after the amcheck command for the dle.</para>
460 <term><amkeyword>post-host-amcheck</amkeyword></term>
462 <para>Execute after the amcheck command for all dle for the client.</para>
466 <term><amkeyword>pre-dle-estimate</amkeyword></term>
468 <para>Execute before the estimate command for the dle.</para>
472 <term><amkeyword>pre-host-estimate</amkeyword></term>
474 <para>Execute before the estimate command for all dle for the client.</para>
478 <term><amkeyword>post-dle-estimate</amkeyword></term>
480 <para>Execute after the estimate command for the dle.</para>
484 <term><amkeyword>post-host-estimate</amkeyword></term>
486 <para>Execute after the estimate command for all dle for the client.</para>
490 <term><amkeyword>pre-dle-backup</amkeyword></term>
492 <para>Execute before the backup command for the dle.</para>
496 <term><amkeyword>post-dle-backup</amkeyword></term>
498 <para>Execute after the backup command for the dle.</para>
502 <term><amkeyword>pre-recover</amkeyword></term>
504 <para>Execute before any level is recovered.</para>
508 <term><amkeyword>post-recover</amkeyword></term>
510 <para>Execute after all levels are recovered.</para>
514 <term><amkeyword>pre-level-recover</amkeyword></term>
516 <para>Execute before each level recovery.</para>
520 <term><amkeyword>post-level-recover</amkeyword></term>
522 <para>Execute after each level recovery.</para>
526 <term><amkeyword>inter-level-recover</amkeyword></term>
528 <para>Execute between two levels of recovery.</para>
535 <term><amkeyword>property</amkeyword> [<amkeyword>append</amkeyword>] [<amkeyword>priority</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
537 <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
538 the property to set, and the others contains its values.
539 <amkeyword>append</amkeyword> keyword append the values to the list of values for that property.
540 <amkeyword>priority</amkeyword> keyword disallow the setting of that property on the server.
548 <manref name="amanda.conf" vol="5"/>,
549 <manref name="amcrypt" vol="8"/>,
550 <manref name="aespipe" vol="1"/>,