2 .\" Title: amanda-client.conf
3 .\" Author: James da Silva <jds@amanda.org>
4 .\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
6 .\" Manual: File formats and conventions
7 .\" Source: Amanda 2.6.1p1
10 .TH "AMANDA\-CLIENT\&.CON" "5" "04/10/2009" "Amanda 2\&.6\&.1p1" "File formats and conventions"
11 .\" -----------------------------------------------------------------
12 .\" * set default formatting
13 .\" -----------------------------------------------------------------
14 .\" disable hyphenation
16 .\" disable justification (adjust text to left margin only)
18 .\" -----------------------------------------------------------------
19 .\" * MAIN CONTENT STARTS HERE *
20 .\" -----------------------------------------------------------------
22 amanda-client.conf \- Client configuration file for \fIAmanda\fR, the Advanced Maryland Automatic Network Disk Archiver
25 \fBamanda-client.conf\fR(5)
26 is the client configuration file for
27 \fIAmanda\fR\&. This manpage lists the relevant sections and parameters of this file for quick reference\&.
30 \fB<CONFIG_DIR>/amanda\-client\&.conf\fR
32 \fB<CONFIG_DIR>/<config>/amanda\-client\&.conf\fR
37 The syntax of \fBamanda-client.conf\fR(5) is identical to that for
38 \fBamanda.conf\fR(5)\&.
39 .SH "GLOBAL PARAMETERS"
41 \fBconf\fR \fI string\fR
44 \fISet by configure\fR\&. The conf use by amrecover\&.
47 \fBclient_username\fR \fI string\fR
50 \fICLIENT_LOGIN\fR\&. Similar to the parameter of the same name in
51 \fBamanda.conf\fR(5), this specifies the username that
53 should send when connecting to the server\&. It should match the username specified in
58 \fBindex_server\fR \fI string\fR
61 \fISet by configure\fR\&. The amindexd server amrecover will connect to\&.
64 \fBtape_server\fR \fI string\fR
67 \fISet by configure\fR\&. The amidxtaped server amrecover will connect to\&.
70 \fBtapedev\fR \fI string\fR
73 \fISet by configure\fR\&. The tapedev amrecover will use\&.
76 \fBauth\fR \fI string\fR
79 \fIbsd\fR\&. Type of authorization to perform between tape server and backup client hosts\&.
81 \fBbsd\fR, bsd authorization with udp initial connection and one tcp connection by data stream\&.
83 \fBbsdtcp\fR, bsd authorization but use only one tcp connection\&.
85 \fBbsdudp\fR, like bsd, but will use only one tcp connection for all data stream\&.
88 to use Kerberos\-IV authorization\&.
91 to use Kerberos\-V authorization\&.
93 \fBlocal\fR, if the client is the server, it doesn\'t require authencation setup\&.
96 to use rsh authorization\&.
99 to use OpenSSH authorization\&.
102 \fBssh_keys\fR \fI string\fR
105 \fINo default\fR\&. 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\&.
108 \fBgnutar_list_dir\fR \fI string\fR
110 Default from configure
111 \fI\-\-with\-gnutar\-listdir=DIR\fR\&. The directory where gnutar keep its state file\&.
114 \fBmailer\fR \fI string\fR
116 Default found by configure\&. A mail program that can send mail with \'\fIMAILER \-s "subject" user < message_file\fR\'\&.
119 \fBamandates\fR \fI string\fR
122 \fI/etc/amandates\fR\&. The file where amanda keep the last date of each dumplevel\&.
125 \fBconnect_tries\fR int
128 \fI3\fR\&. How many times the server will try a connection\&.
134 \fI5\fR\&. How many times amandad will resend a REP packet if it doesn\'t get the ACK packet\&.
137 \fBdebug_amandad\fR int
140 \fI0\fR\&. Debug level of the amandad process
143 \fBdebug_amidxtaped\fR int
146 \fI0\fR\&. Debug level of the amidxtaped process
149 \fBdebug_amindexd\fR int
152 \fI0\fR\&. Debug level of the amindexd process
155 \fBdebug_amrecover\fR int
158 \fI0\fR\&. Debug level of the amrecover process
164 \fI0\fR\&. Debug level of the auth module
167 \fBdebug_event\fR int
170 \fI0\fR\&. Debug level of the event module
173 \fBdebug_holding\fR int
176 \fI0\fR\&. Debug level of the holdingdisk module
179 \fBdebug_protocol\fR int
182 \fI0\fR\&. Debug level of the protocol module
185 \fBdebug_selfcheck\fR int
188 \fI0\fR\&. Debug level of the selfcheck process
191 \fBdebug_sendsize\fR int
194 \fI0\fR\&. Debug level of the sendsize process
197 \fBdebug_sendbackup\fR int
200 \fI0\fR\&. Debug level of the sendbackup process
203 \fBreserved\-udp\-port\fR int,int
205 Default: \-\-with\-udpportrange or
206 \fI512,1023\fR\&. Reserved udp port that will be used (amrecover with bsd or bsdudp)
209 \fBreserved\-tcp\-port\fR int,int
211 Default: \-\-with\-low\-tcpportrange or
212 \fI512,1023\fR\&. Reserved tcp port that will be used (amrecover with bsdtcp)
215 \fBunreserved\-tcp\-port\fR int,int
217 Default: \-\-with\-tcpportrange or
218 \fI1025,65536\fR\&. Unreserved tcp port that will be used (bsd, bsdudp)
221 \fBproperty\fR "name" "value"
223 Adds a global property for this client host, useful for e\&.g\&., Application API plugins\&.
225 .SH "APPLICATION SECTION"
229 file may define multiple types of application\&. The information is entered in a
230 \fBapplication\-tool\fR
231 section, which looks like this:
233 define application\-tool "\fIname\fR" {
234 \fIapplication\-option\fR \fIappli
241 is the name of this type of application\&. It is referenced from the
244 The application\-tool options and values are:
246 \fBcomment\fR \fIstring\fR
249 \fInone\fR\&. A comment string describing this application\&.
252 \fBplugin\fR \fIstring\fR
254 No default\&. Must be set to the name of the program\&. This program must be in the
255 \fI$libexecdir/amanda/application\fR
256 directory on the client\&.
259 \fBproperty\fR [append] [priority] \fIstring\fR \fIstring\fR+
261 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\&.
263 keyword append the values to the list of values for that property\&.
265 keyword disallow the setting of that property on the server\&.
271 file may define multiple types of script\&. The information is entered in a
273 section, which looks like this:
275 define script\-tool "\fIname\fR" {
276 \fIscript\-option\fR \fIscript\-value\fR
282 is the name of this type of script\&. It is referenced from the
285 The script\-tool options and values are:
287 \fBcomment\fR \fIstring\fR
290 \fInone\fR\&. A comment string describing this script\&.
293 \fBplugin\fR \fIstring\fR
295 No default\&. Must be set to the name of the program\&. This program must be in the
296 \fI$libdir/amanda/application\fR
297 directory on the client and/or server\&.
300 \fBexecute_where\fR [client|server]
303 \fIclient\fR\&. Where the script must be executed, on the client or server\&. Only
308 \fBexecute_on\fR \fIexecute_on\fR[,\fIexecute_on\fR]*
310 No default\&. When the script must be executed, you can specify many of them:
312 \fBpre\-dle\-amcheck\fR
314 Execute before the amcheck command for the dle\&.
317 \fBpre\-host\-amcheck\fR
319 Execute before the amcheck command for all dle for the client\&.
322 \fBpost\-dle\-amcheck\fR
324 Execute after the amcheck command for the dle\&.
327 \fBpost\-host\-amcheck\fR
329 Execute after the amcheck command for all dle for the client\&.
332 \fBpre\-dle\-estimate\fR
334 Execute before the estimate command for the dle\&.
337 \fBpre\-host\-estimate\fR
339 Execute before the estimate command for all dle for the client\&.
342 \fBpost\-dle\-estimate\fR
344 Execute after the estimate command for the dle\&.
347 \fBpost\-host\-estimate\fR
349 Execute after the estimate command for all dle for the client\&.
352 \fBpre\-dle\-backup\fR
354 Execute before the backup command for the dle\&.
357 \fBpre\-host\-backup\fR
359 Execute before the backup command for all dle for the client\&.
362 \fBpost\-dle\-backup\fR
364 Execute after the backup command for the dle\&.
367 \fBpost\-host\-backup\fR
369 Execute after the backup command for all dle for the client\&.
374 Execute before any level is recovered\&.
379 Execute after all levels are recovered\&.
382 \fBpre\-level\-recover\fR
384 Execute before each level recovery\&.
387 \fBpost\-level\-recover\fR
389 Execute after each level recovery\&.
392 \fBinter\-level\-recover\fR
394 Execute between two levels of recovery\&.
398 \fBproperty\fR [append] [priority] \fIstring\fR \fIstring\fR+
400 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\&.
402 keyword append the values to the list of values for that property\&.
404 keyword disallow the setting of that property on the server\&.
410 \fBamanda.conf\fR(5),
413 : http://wiki.zmanda.com
416 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
418 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>