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-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 &A;, 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 &A;. 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 <citerefentry><refentrytitle>amanda.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
43 <title>GLOBAL PARAMETERS</title>
45 <variablelist remap='TP'>
47 <term><emphasis remap='B'>conf</emphasis> <emphasis remap='I'> string</emphasis></term>
50 <emphasis remap='I'>Set by configure</emphasis>.
51 The conf use by amrecover.</para>
56 <term><emphasis remap='B'>client_username</emphasis> <emphasis remap='I'> string</emphasis></term>
59 <emphasis remap='I'>CLIENT_LOGIN</emphasis>.
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><emphasis remap='B'>index_server</emphasis> <emphasis remap='I'> string</emphasis></term>
70 <emphasis remap='I'>Set by configure</emphasis>.
71 The amindexd server amrecover will connect to.</para>
76 <term><emphasis remap='B'>tape_server</emphasis> <emphasis remap='I'> string</emphasis></term>
79 <emphasis remap='I'>Set by configure</emphasis>.
80 The amidxtaped server amrecover will connect to.</para>
85 <term><emphasis remap='B'>tapedev</emphasis> <emphasis remap='I'> string</emphasis></term>
88 <emphasis remap='I'>Set by configure</emphasis>.
89 The tapedev amrecover will use.</para>
94 <term><emphasis remap='B'>auth</emphasis> <emphasis remap='I'> string</emphasis></term>
97 <emphasis remap='I'>bsd</emphasis>.
98 Type of authorization to perform between tape server and backup client hosts.</para>
99 <para><emphasis remap='B'>bsd</emphasis>, bsd authorization with udp initial
100 connection and one tcp connection by data stream.</para>
101 <para><emphasis remap='B'>bsdtcp</emphasis>, bsd authorization but use only
102 one tcp connection.</para>
103 <para><emphasis remap='B'>bsdudp</emphasis>, like bsd, but will use only one
104 tcp connection for all data stream.</para>
105 <para><emphasis remap='B'>krb4</emphasis> to use Kerberos-IV
106 authorization.</para>
107 <para><emphasis remap='B'>krb5</emphasis> to use Kerberos-V
108 authorization.</para>
109 <para><emphasis remap='B'>local</emphasis>, if the client is the server, it
110 doesn't require authencation setup.</para>
111 <para><emphasis remap='B'>rsh</emphasis> to use rsh
112 authorization.</para>
113 <para><emphasis remap='B'>ssh</emphasis> to use OpenSSH
114 authorization.</para>
120 <term><emphasis remap='B'>ssh_keys</emphasis> <emphasis remap='I'> string</emphasis></term>
123 <emphasis remap='I'>No default</emphasis>.
124 The key file the ssh auth will use, it must be the private key. If this parameter is not specified, then the deafult ssh key will be used.</para>
129 <term><emphasis remap='B'>gnutar_list_dir</emphasis> <emphasis remap='I'> string</emphasis></term>
131 <para>Default from configure
132 <emphasis remap='I'>--with-gnutar-listdir=DIR</emphasis>.
133 The directory where gnutar keep its state file.</para>
138 <term><emphasis remap='B'>mailer</emphasis> <emphasis remap='I'> string</emphasis></term>
140 <para>Default found by configure. A mail program that can send mail with '<emphasis remap='I'>MAILER -s "subject" user < message_file</emphasis>'.</para>
145 <term><emphasis remap='B'>amandates</emphasis> <emphasis remap='I'> string</emphasis></term>
148 <emphasis remap='I'>/etc/amandates</emphasis>.
149 The file where amanda keep the last date of each dumplevel.</para>
154 <term><emphasis remap='B'>connect_tries</emphasis> int</term>
157 <emphasis remap='I'>3</emphasis>.
158 How many times the server will try a connection.</para>
163 <term><emphasis remap='B'>rep_tries</emphasis> int</term>
166 <emphasis remap='I'>5</emphasis>.
167 How many times amandad will resend a REP packet if it doesn't get the ACK packet.</para>
172 <term><emphasis remap='B'>debug_amandad</emphasis> int</term>
175 <emphasis remap='I'>0</emphasis>.
176 Debug level of the amandad process</para>
181 <term><emphasis remap='B'>debug_amidxtaped</emphasis> int</term>
184 <emphasis remap='I'>0</emphasis>.
185 Debug level of the amidxtaped process</para>
190 <term><emphasis remap='B'>debug_amindexd</emphasis> int</term>
193 <emphasis remap='I'>0</emphasis>.
194 Debug level of the amindexd process</para>
199 <term><emphasis remap='B'>debug_amrecover</emphasis> int</term>
202 <emphasis remap='I'>0</emphasis>.
203 Debug level of the amrecover process</para>
208 <term><emphasis remap='B'>debug_auth</emphasis> int</term>
211 <emphasis remap='I'>0</emphasis>.
212 Debug level of the auth module</para>
217 <term><emphasis remap='B'>debug_event</emphasis> int</term>
220 <emphasis remap='I'>0</emphasis>.
221 Debug level of the event module</para>
226 <term><emphasis remap='B'>debug_holding</emphasis> int</term>
229 <emphasis remap='I'>0</emphasis>.
230 Debug level of the holdingdisk module</para>
235 <term><emphasis remap='B'>debug_protocol</emphasis> int</term>
238 <emphasis remap='I'>0</emphasis>.
239 Debug level of the protocol module</para>
244 <term><emphasis remap='B'>debug_selfcheck</emphasis> int</term>
247 <emphasis remap='I'>0</emphasis>.
248 Debug level of the selfcheck process</para>
253 <term><emphasis remap='B'>debug_sendsize</emphasis> int</term>
256 <emphasis remap='I'>0</emphasis>.
257 Debug level of the sendsize process</para>
262 <term><emphasis remap='B'>debug_sendbackup</emphasis> int</term>
265 <emphasis remap='I'>0</emphasis>.
266 Debug level of the sendbackup process</para>
271 <term><emphasis remap='B'>reserved-udp-port</emphasis> int,int</term>
273 <para>Default: --with-udpportrange or
274 <emphasis remap='I'>512,1023</emphasis>.
275 Reserved udp port that will be used (amrecover with bsd or bsdudp)</para>
280 <term><emphasis remap='B'>reserved-tcp-port</emphasis> int,int</term>
282 <para>Default: --with-low-tcpportrange or
283 <emphasis remap='I'>512,1023</emphasis>.
284 Reserved tcp port that will be used (amrecover with bsdtcp)</para>
289 <term><emphasis remap='B'>unreserved-tcp-port</emphasis> int,int</term>
291 <para>Default: --with-tcpportrange or
292 <emphasis remap='I'>1025,65536</emphasis>.
293 Unreserved tcp port that will be used (bsd, bsdudp)</para>
298 <term><emphasis remap='B'>property</emphasis> "name" "value"</term>
300 <para>Adds a global property for this client host, useful for e.g., Application API plugins.</para>
307 <refsect1><title>APPLICATION SECTION</title>
309 <emphasis remap='B'>amanda.conf</emphasis>
310 file may define multiple types of application.
311 The information is entered in a <emphasis remap='B'>application-tool</emphasis>
312 section, which looks like this:</para>
315 define application-tool "<emphasis remap='I'>name</emphasis>" {
316 <emphasis remap='I'>application-option</emphasis> <emphasis remap='I'>appli
317 cation-value</emphasis>
318 <literal>...</literal>
322 <para><emphasis remap='I'>name</emphasis>
323 is the name of this type of application. It is referenced from the
324 <emphasis remap='I'>dumptype</emphasis></para>
326 <para>The application-tool options and values are:</para>
327 <variablelist remap='TP'>
329 <term><emphasis remap='B'>comment</emphasis> <emphasis remap='I'>string</emphasis></term>
332 <emphasis remap='I'>none</emphasis>.
333 A comment string describing this application.</para>
337 <term><emphasis remap='B'>plugin</emphasis> <emphasis remap='I'>string</emphasis></term>
339 <para>No default. Must be set to the name of the program. This program must be
340 in the <emphasis remap='I'>$libexecdir/amanda/application</emphasis> directory
341 on the client.</para>
345 <term><emphasis remap='B'>property</emphasis> [append] [priority] <emphasis remap='I'>string</emphasis> <emphasis remap='I'>string</emphasis>+</term>
347 <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
348 the property to set, and the others contains its values.
349 <emphasis remap='B'>append</emphasis> keyword append the values to the list of values for that property.
350 <emphasis remap='B'>priority</emphasis> keyword disallow the setting of that property on the server.
357 <refsect1><title>SCRIPT SECTION</title>
359 <emphasis remap='B'>amanda.conf</emphasis>
360 file may define multiple types of script.
361 The information is entered in a <emphasis remap='B'>script-tool</emphasis>
362 section, which looks like this:</para>
365 define script-tool "<emphasis remap='I'>name</emphasis>" {
366 <emphasis remap='I'>script-option</emphasis> <emphasis remap='I'>script-value</emphasis>
367 <literal>...</literal>
371 <para><emphasis remap='I'>name</emphasis>
372 is the name of this type of script. It is referenced from the
373 <emphasis remap='I'>dumptype</emphasis></para>
375 <para>The script-tool options and values are:</para>
376 <variablelist remap='TP'>
378 <term><emphasis remap='B'>comment</emphasis> <emphasis remap='I'>string</emphasis></term>
381 <emphasis remap='I'>none</emphasis>.
382 A comment string describing this script.</para>
386 <term><emphasis remap='B'>plugin</emphasis> <emphasis remap='I'>string</emphasis></term>
388 <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>
392 <term><emphasis remap='B'>execute_where</emphasis> [client|server]</term>
394 <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>
398 <term><emphasis remap='B'>execute_on</emphasis> <emphasis remap='I'>execute_on</emphasis>[,<emphasis remap='I'>execute_on</emphasis>]*</term>
400 <para>No default. When the script must be executed, you can specify many of them:</para>
402 <variablelist remap='TP'>
404 <term><emphasis remap='B'>pre-dle-amcheck</emphasis></term>
406 <para>Execute before the amcheck command for the dle.</para>
410 <term><emphasis remap='B'>pre-host-amcheck</emphasis></term>
412 <para>Execute before the amcheck command for all dle for the client.</para>
416 <term><emphasis remap='B'>post-dle-amcheck</emphasis></term>
418 <para>Execute after the amcheck command for the dle.</para>
422 <term><emphasis remap='B'>post-host-amcheck</emphasis></term>
424 <para>Execute after the amcheck command for all dle for the client.</para>
428 <term><emphasis remap='B'>pre-dle-estimate</emphasis></term>
430 <para>Execute before the estimate command for the dle.</para>
434 <term><emphasis remap='B'>pre-host-estimate</emphasis></term>
436 <para>Execute before the estimate command for all dle for the client.</para>
440 <term><emphasis remap='B'>post-dle-estimate</emphasis></term>
442 <para>Execute after the estimate command for the dle.</para>
446 <term><emphasis remap='B'>post-host-estimate</emphasis></term>
448 <para>Execute after the estimate command for all dle for the client.</para>
452 <term><emphasis remap='B'>pre-dle-backup</emphasis></term>
454 <para>Execute before the backup command for the dle.</para>
458 <term><emphasis remap='B'>pre-host-backup</emphasis></term>
460 <para>Execute before the backup command for all dle for the client.</para>
464 <term><emphasis remap='B'>post-dle-backup</emphasis></term>
466 <para>Execute after the backup command for the dle.</para>
470 <term><emphasis remap='B'>post-host-backup</emphasis></term>
472 <para>Execute after the backup command for all dle for the client.</para>
476 <term><emphasis remap='B'>pre-recover</emphasis></term>
478 <para>Execute before any level is recovered.</para>
482 <term><emphasis remap='B'>post-recover</emphasis></term>
484 <para>Execute after all levels are recovered.</para>
488 <term><emphasis remap='B'>pre-level-recover</emphasis></term>
490 <para>Execute before each level recovery.</para>
494 <term><emphasis remap='B'>post-level-recover</emphasis></term>
496 <para>Execute after each level recovery.</para>
500 <term><emphasis remap='B'>inter-level-recover</emphasis></term>
502 <para>Execute between two levels of recovery.</para>
509 <term><emphasis remap='B'>property</emphasis> [append] [priority] <emphasis remap='I'>string</emphasis> <emphasis remap='I'>string</emphasis>+</term>
511 <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
512 the property to set, and the others contains its values.
513 <emphasis remap='B'>append</emphasis> keyword append the values to the list of values for that property.
514 <emphasis remap='B'>priority</emphasis> keyword disallow the setting of that property on the server.
521 <refsect1><title>SEE ALSO</title>
523 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
524 <citerefentry><refentrytitle>amanda.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
525 <citerefentry><refentrytitle>amcrypt</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
526 <citerefentry><refentrytitle>aespipe</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
527 <ulink url="http://wiki.zmanda.com"/>