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 3.2.0
10 .TH "AMANDA\-CLIENT\&.CON" "5" "10/18/2010" "Amanda 3\&.2\&.0" "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 Amanda, the Advanced Maryland Automatic Network Disk Archiver
25 \fBamanda-client.conf\fR(5)
26 is the client configuration file for Amanda\&. This manpage lists the relevant sections and parameters of this file for quick reference\&.
29 \fB<CONFIG_DIR>/amanda\-client\&.conf\fR
31 \fB<CONFIG_DIR>/<config>/amanda\-client\&.conf\fR
36 The syntax of \fBamanda-client.conf\fR(5) is identical to that for
37 \fBamanda.conf\fR(5)\&.
38 .SH "GLOBAL PARAMETERS"
40 \fBconf\fR \fIstring\fR
43 \fISet by configure\fR\&. The conf use by amrecover\&.
46 \fBclient\-username\fR \fIstring\fR
49 \fICLIENT_LOGIN\fR\&. Similar to the parameter of the same name in
50 \fBamanda.conf\fR(5), this specifies the username that
52 should send when connecting to the server\&. It should match the username specified in
57 \fBclient\-port\fR [ \fIint\fR | \fIstring\fR ]
60 \fI"amanda"\fR\&. Similar to the parameter of the same name in
61 \fBamanda.conf\fR(5), this specifies the port to connect on the server\&. It can be a service name or a numeric port number\&.
64 \fBindex\-server\fR \fIstring\fR
67 \fISet by configure\fR\&. The amindexd server amrecover will connect to\&.
70 \fBtape\-server\fR \fIstring\fR
73 \fISet by configure\fR\&. The amidxtaped server amrecover will connect to\&.
76 \fBtapedev\fR \fIstring\fR
79 \fISet by configure\fR\&. The tapedev amrecover will use\&.
82 \fBauth\fR \fIstring\fR
85 \fB"bsd"\fR\&. Type of authorization to perform between tape server and backup client hosts\&.
87 \fB"bsd"\fR, bsd authorization with udp initial connection and one tcp connection by data stream\&.
89 \fB"bsdtcp"\fR, bsd authorization but use only one tcp connection\&.
91 \fB"bsdudp"\fR, like bsd, but will use only one tcp connection for all data stream\&.
94 to use Kerberos\-V authorization\&.
96 \fB"local"\fR, if the client is the server, it doesn\'t require authencation setup\&.
99 to use rsh authorization\&.
102 to use OpenSSH authorization\&.
105 \fBssh\-keys\fR \fIstring\fR
108 \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 default ssh key will be used\&.
111 \fBgnutar\-list\-dir\fR \fIstring\fR
113 Default from configure
114 \fI\-\-with\-gnutar\-listdir=DIR\fR\&. The directory where gnutar keep its state file\&.
117 \fBmailer\fR \fIstring\fR
119 Default found by configure\&. A mail program that can send mail with \'\fIMAILER \-s "subject" user < message_file\fR\'\&.
122 \fBamandates\fR \fIstring\fR
125 \fI/etc/amandates\fR\&. The file where amanda keep the last date of each dumplevel\&.
128 \fBconnect\-tries\fR \fIint\fR
131 \fI3\fR\&. How many times the server will try a connection\&.
134 \fBrep\-tries\fR \fIint\fR
137 \fI5\fR\&. How many times amandad will resend a REP packet if it doesn\'t get the ACK packet\&.
140 \fBdebug\-days\fR \fIint\fR
143 \fI3\fR\&. The number of days the debug files are kept\&.
146 \fBdebug\-amandad\fR \fIint\fR
149 \fI0\fR\&. Debug level of the amandad process
152 \fBdebug\-amidxtaped\fR \fIint\fR
155 \fI0\fR\&. Debug level of the amidxtaped process
158 \fBdebug\-amindexd\fR \fIint\fR
161 \fI0\fR\&. Debug level of the amindexd process
164 \fBdebug\-amrecover\fR \fIint\fR
167 \fI0\fR\&. Debug level of the amrecover process
170 \fBdebug\-auth\fR \fIint\fR
173 \fI0\fR\&. Debug level of the auth module
176 \fBdebug\-event\fR \fIint\fR
179 \fI0\fR\&. Debug level of the event module
182 \fBdebug\-holding\fR \fIint\fR
185 \fI0\fR\&. Debug level of the holdingdisk module
188 \fBdebug\-protocol\fR \fIint\fR
191 \fI0\fR\&. Debug level of the protocol module
194 \fBdebug\-selfcheck\fR \fIint\fR
197 \fI0\fR\&. Debug level of the selfcheck process
200 \fBdebug\-sendsize\fR \fIint\fR
203 \fI0\fR\&. Debug level of the sendsize process
206 \fBdebug\-sendbackup\fR \fIint\fR
209 \fI0\fR\&. Debug level of the sendbackup process
212 \fBreserved\-udp\-port\fR \fIint\fR,\fIint\fR
214 Default: \-\-with\-udpportrange or
215 \fI512,1023\fR\&. Reserved udp port that will be used (amrecover with bsd or bsdudp)
218 \fBreserved\-tcp\-port\fR \fIint\fR,\fIint\fR
220 Default: \-\-with\-low\-tcpportrange or
221 \fI512,1023\fR\&. Reserved tcp port that will be used (amrecover with bsdtcp)
224 \fBunreserved\-tcp\-port\fR \fIint\fR,\fIint\fR
226 Default: \-\-with\-tcpportrange or
227 \fI1025,65536\fR\&. Unreserved tcp port that will be used (bsd, bsdudp)
230 \fBproperty\fR \fIstring\fR \fIstring\fR+
232 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
234 .SH "APPLICATION SECTION"
238 file may define multiple types of application\&. The information is entered in a
240 section, which looks like this:
242 define application "\fIname\fR" {
243 \fIapplication\-option\fR \fIapplication\-value\fR
249 is the name of this type of application\&. It is referenced from the
252 The application options and values are:
254 \fBcomment\fR \fIstring\fR
257 \fInone\fR\&. A comment string describing this application\&.
260 \fBplugin\fR \fIstring\fR
262 No default\&. Must be set to the name of the program\&. This program must be in the
263 \fI$libexecdir/amanda/application\fR
264 directory on the client\&.
267 \fBproperty\fR [\fBappend\fR] [\fBpriority\fR] \fIstring\fR \fIstring\fR+
269 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\&.
271 keyword append the values to the list of values for that property\&.
273 keyword disallow the setting of that property on the server\&.
279 file may define multiple types of script\&. The information is entered in a
281 section, which looks like this:
283 define script "\fIname\fR" {
284 \fIscript\-option\fR \fIscript\-value\fR
290 is the name of this type of script\&. It is referenced from the
293 The script options and values are:
295 \fBcomment\fR \fIstring\fR
298 \fInone\fR\&. A comment string describing this script\&.
301 \fBplugin\fR \fIstring\fR
303 No default\&. Must be set to the name of the program\&. This program must be in the
304 \fI$libdir/amanda/application\fR
305 directory on the client and/or server\&.
308 \fBexecute\-where\fR [ \fBclient\fR | \fBserver\fR ]
311 \fBclient\fR\&. Where the script must be executed, on the client or server\&. Only
316 \fBexecute\-on\fR \fIexecute_on\fR[,\fIexecute_on\fR]*
318 No default\&. When the script must be executed, you can specify many of them:
320 \fBpre\-dle\-amcheck\fR
322 Execute before the amcheck command for the dle\&.
325 \fBpre\-host\-amcheck\fR
327 Execute before the amcheck command for all dle for the client\&.
330 \fBpost\-dle\-amcheck\fR
332 Execute after the amcheck command for the dle\&.
335 \fBpost\-host\-amcheck\fR
337 Execute after the amcheck command for all dle for the client\&.
340 \fBpre\-dle\-estimate\fR
342 Execute before the estimate command for the dle\&.
345 \fBpre\-host\-estimate\fR
347 Execute before the estimate command for all dle for the client\&.
350 \fBpost\-dle\-estimate\fR
352 Execute after the estimate command for the dle\&.
355 \fBpost\-host\-estimate\fR
357 Execute after the estimate command for all dle for the client\&.
360 \fBpre\-dle\-backup\fR
362 Execute before the backup command for the dle\&.
365 \fBpre\-host\-backup\fR
367 Execute before the backup command for all dle for the client\&.
370 \fBpost\-dle\-backup\fR
372 Execute after the backup command for the dle\&.
375 \fBpost\-host\-backup\fR
377 Execute after the backup command for all dle for the client\&.
382 Execute before any level is recovered\&.
387 Execute after all levels are recovered\&.
390 \fBpre\-level\-recover\fR
392 Execute before each level recovery\&.
395 \fBpost\-level\-recover\fR
397 Execute after each level recovery\&.
400 \fBinter\-level\-recover\fR
402 Execute between two levels of recovery\&.
406 \fBproperty\fR [\fBappend\fR] [\fBpriority\fR] \fIstring\fR \fIstring\fR+
408 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\&.
410 keyword append the values to the list of values for that property\&.
412 keyword disallow the setting of that property on the server\&.
417 \fBamanda.conf\fR(5),
422 : http://wiki.zmanda.com/
425 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
427 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>