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>
17 <refname>amanda-client.conf</refname>
18 <refpurpose>Client configuration file for &A;, the Advanced Maryland Automatic Network Disk Archiver</refpurpose>
20 <!-- body begins here -->
22 <refsect1><title>DESCRIPTION</title>
23 <para>&amclientconf; is the client configuration file for &A;. This manpage lists the
24 relevant sections and parameters of this file for quick reference.</para>
25 <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>
28 <refsect1><title>PARAMETERS</title>
30 <para>There are a number of configuration parameters that control the
31 behavior of the &A; programs.
32 All have default values,
33 so you need not specify the parameter in
34 <emphasis remap='B'>amanda-client.conf</emphasis>
35 if the default is suitable.</para>
37 <para>Lines starting with # are ignored, as are blank lines.
38 Comments may be placed on a line with a directive by starting
40 The remainder of the line is ignored.</para>
42 <para>Keywords are case insensitive, i.e.
43 <emphasis remap='B'>auth</emphasis>
45 <emphasis remap='B'>Auth</emphasis>
46 are treated the same.</para>
48 <para>Integer arguments may have one of the following (case insensitive) suffixes,
49 some of which have a multiplier effect:</para>
51 <refsect2><title>POSSIBLE SUFFIXES</title>
53 <variablelist remap='TP'>
55 <term><emphasis remap='B'>b byte bytes</emphasis></term>
57 <para>Some number of bytes.</para>
61 <term><emphasis remap='B'>bps</emphasis></term>
63 <para>Some number of bytes per second.</para>
67 <term><emphasis remap='B'>k kb kbyte kbytes kilobyte kilobytes</emphasis></term>
69 <para>Some number of kilobytes (bytes*1024).</para>
73 <term><emphasis remap='B'>kps kbps</emphasis></term>
75 <para>Some number of kilobytes per second (bytes*1024).</para>
79 <term><emphasis remap='B'>m mb meg mbyte mbytes megabyte megabytes</emphasis></term>
81 <para>Some number of megabytes (bytes*1024*1024).</para>
85 <term><emphasis remap='B'>mps mbps</emphasis></term>
87 <para>Some number of megabytes per second (bytes*1024*1024).</para>
91 <term><emphasis remap='B'>g gb gbyte gbytes gigabyte gigabytes</emphasis></term>
93 <para>Some number of gigabytes (bytes*1024*1024*1024).</para>
97 <term><emphasis remap='B'>tape tapes</emphasis></term>
99 <para>Some number of tapes.</para>
103 <term><emphasis remap='B'>day days</emphasis></term>
105 <para>Some number of days.</para>
109 <term><emphasis remap='B'>week weeks</emphasis></term>
111 <para>Some number of weeks (days*7).</para>
113 <note><para>The value
114 <emphasis remap='B'>inf</emphasis>
115 may be used in most places where an integer is expected
116 to mean an infinite amount.</para>
118 <para>Boolean arguments may have any of the values
119 <emphasis remap='B'>y</emphasis>,
120 <emphasis remap='B'>yes</emphasis>,
121 <emphasis remap='B'>t</emphasis>,
122 <emphasis remap='B'>true</emphasis>
124 <emphasis remap='B'>on</emphasis>
125 to indicate a true state, or
126 <emphasis remap='B'>n</emphasis>,
127 <emphasis remap='B'>no</emphasis>,
128 <emphasis remap='B'>f</emphasis>,
129 <emphasis remap='B'>false</emphasis>
131 <emphasis remap='B'>off</emphasis>
132 to indicate a false state.
133 If no argument is given,
134 <emphasis remap='B'>true</emphasis>
144 <title>PARAMETERS</title>
146 <variablelist remap='TP'>
148 <term><emphasis remap='B'>conf</emphasis> <emphasis remap='I'> string</emphasis></term>
151 <emphasis remap='I'>Set by configure</emphasis>.
152 The conf use by amrecover.</para>
157 <term><emphasis remap='B'>index_server</emphasis> <emphasis remap='I'> string</emphasis></term>
160 <emphasis remap='I'>Set by configure</emphasis>.
161 The amindexd server amrecover will connect to.</para>
166 <term><emphasis remap='B'>tape_server</emphasis> <emphasis remap='I'> string</emphasis></term>
169 <emphasis remap='I'>Set by configure</emphasis>.
170 The amidxtaped server amrecover will connect to.</para>
175 <term><emphasis remap='B'>tapedev</emphasis> <emphasis remap='I'> string</emphasis></term>
178 <emphasis remap='I'>Set by configure</emphasis>.
179 The tapedev amrecover will use.</para>
184 <term><emphasis remap='B'>auth</emphasis> <emphasis remap='I'> string</emphasis></term>
187 <emphasis remap='I'>bsd</emphasis>.
188 Type of authorization to perform between tape server and backup client hosts.</para>
189 <para><emphasis remap='B'>bsd</emphasis>, bsd authorization with udp initial
190 connection and one tcp connection by data stream.</para>
191 <para><emphasis remap='B'>bsdtcp</emphasis>, bsd authorization but use only
192 one tcp connection.</para>
193 <para><emphasis remap='B'>bsdudp</emphasis>, like bsd, but will use only one
194 tcp connection for all data stream.</para>
195 <para><emphasis remap='B'>krb4</emphasis> to use Kerberos-IV
196 authorization.</para>
197 <para><emphasis remap='B'>krb5</emphasis> to use Kerberos-V
198 authorization.</para>
199 <para><emphasis remap='B'>local</emphasis>, if the client is the server, it
200 doesn't require authencation setup.</para>
201 <para><emphasis remap='B'>rsh</emphasis> to use rsh
202 authorization.</para>
203 <para><emphasis remap='B'>ssh</emphasis> to use OpenSSH
204 authorization.</para>
210 <term><emphasis remap='B'>ssh_keys</emphasis> <emphasis remap='I'> string</emphasis></term>
213 <emphasis remap='I'>No default</emphasis>.
214 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>
219 <term><emphasis remap='B'>gnutar_list_dir</emphasis> <emphasis remap='I'> string</emphasis></term>
221 <para>Default from configure
222 <emphasis remap='I'>--with-gnutar-listdir=DIR</emphasis>.
223 The directory where gnutar keep its state file.</para>
228 <term><emphasis remap='B'>amandates</emphasis> <emphasis remap='I'> string</emphasis></term>
231 <emphasis remap='I'>/etc/amandates</emphasis>.
232 The file where amanda keep the last date of each dumplevel.</para>
237 <term><emphasis remap='B'>connect_tries</emphasis> int</term>
240 <emphasis remap='I'>3</emphasis>.
241 How many times the server will try a connection.</para>
246 <term><emphasis remap='B'>rep_tries</emphasis> int</term>
249 <emphasis remap='I'>5</emphasis>.
250 How many times amandad will resend a REP packet if it doesn't get the ACK packet.</para>
255 <term><emphasis remap='B'>debug_amandad</emphasis> int</term>
258 <emphasis remap='I'>0</emphasis>.
259 Debug level of the amandad process</para>
264 <term><emphasis remap='B'>debug_amidxtaped</emphasis> int</term>
267 <emphasis remap='I'>0</emphasis>.
268 Debug level of the amidxtaped process</para>
273 <term><emphasis remap='B'>debug_amindexd</emphasis> int</term>
276 <emphasis remap='I'>0</emphasis>.
277 Debug level of the amindexd process</para>
282 <term><emphasis remap='B'>debug_amrecover</emphasis> int</term>
285 <emphasis remap='I'>0</emphasis>.
286 Debug level of the amrecover process</para>
291 <term><emphasis remap='B'>debug_auth</emphasis> int</term>
294 <emphasis remap='I'>0</emphasis>.
295 Debug level of the auth module</para>
300 <term><emphasis remap='B'>debug_event</emphasis> int</term>
303 <emphasis remap='I'>0</emphasis>.
304 Debug level of the event module</para>
309 <term><emphasis remap='B'>debug_holding</emphasis> int</term>
312 <emphasis remap='I'>0</emphasis>.
313 Debug level of the holdingdisk module</para>
318 <term><emphasis remap='B'>debug_protocol</emphasis> int</term>
321 <emphasis remap='I'>0</emphasis>.
322 Debug level of the protocol module</para>
327 <term><emphasis remap='B'>debug_selfcheck</emphasis> int</term>
330 <emphasis remap='I'>0</emphasis>.
331 Debug level of the selfcheck process</para>
336 <term><emphasis remap='B'>debug_sendsize</emphasis> int</term>
339 <emphasis remap='I'>0</emphasis>.
340 Debug level of the sendsize process</para>
345 <term><emphasis remap='B'>debug_sendbackup</emphasis> int</term>
348 <emphasis remap='I'>0</emphasis>.
349 Debug level of the sendbackup process</para>
354 <term><emphasis remap='B'>reserved-udp-port</emphasis> int,int</term>
356 <para>Default: --with-udpportrange or
357 <emphasis remap='I'>512,1023</emphasis>.
358 Reserved udp port that will be used (amrecover with bsd or bsdudp)</para>
363 <term><emphasis remap='B'>reserved-tcp-port</emphasis> int,int</term>
365 <para>Default: --with-low-tcpportrange or
366 <emphasis remap='I'>512,1023</emphasis>.
367 Reserved tcp port that will be used (amrecover with bsdtcp)</para>
372 <term><emphasis remap='B'>unreserved-tcp-port</emphasis> int,int</term>
374 <para>Default: --with-tcpportrange or
375 <emphasis remap='I'>1025,65536</emphasis>.
376 Unreserved tcp port that will be used (bsd, bsdudp)</para>
384 <refsect1><title>AUTHOR</title>
385 <para>James da Silva, &email.jds;: Original text</para>
386 <para>&maintainer.sgw;: XML-conversion, major update, splitting</para>
389 <refsect1><title>SEE ALSO</title>
391 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
392 <citerefentry><refentrytitle>amanda.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
393 <citerefentry><refentrytitle>amcrypt</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
394 <citerefentry><refentrytitle>aespipe</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
395 <ulink url="http://wiki.zmanda.com"/>