2 .\" Title: amanda-client.conf
3 .\" Author: James da Silva <jds@amanda.org>
4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
6 .\" Manual: File formats and conventions
7 .\" Source: Amanda 3.3.1
10 .TH "AMANDA\-CLIENT\&.CON" "5" "02/21/2012" "Amanda 3\&.3\&.1" "File formats and conventions"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
25 .\" disable justification (adjust text to left margin only)
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
31 amanda-client.conf \- Client configuration file for Amanda, the Advanced Maryland Automatic Network Disk Archiver
34 \fBamanda-client.conf\fR(5)
35 is the client configuration file for Amanda\&. This manpage lists the relevant sections and parameters of this file for quick reference\&.
38 \fB<CONFIG_DIR>/amanda\-client\&.conf\fR
40 \fB<CONFIG_DIR>/<config>/amanda\-client\&.conf\fR
45 The syntax of \fBamanda-client.conf\fR(5) is identical to that for
46 \fBamanda.conf\fR(5)\&.
47 .SH "GLOBAL PARAMETERS"
49 \fBconf\fR \fIstring\fR
52 \fISet by configure\fR\&. The conf use by amrecover\&.
55 \fBclient\-username\fR \fIstring\fR
58 \fICLIENT_LOGIN\fR\&. Similar to the parameter of the same name in
59 \fBamanda.conf\fR(5), this specifies the username that
61 should send when connecting to the server\&. It should match the username specified in
66 \fBclient\-port\fR [ \fIint\fR | \fIstring\fR ]
69 \fI"amanda"\fR\&. Similar to the parameter of the same name in
70 \fBamanda.conf\fR(5), this specifies the port to connect on the server\&. It can be a service name or a numeric port number\&.
73 \fBamdump\-server\fR \fIstring\fR
76 \fISet by configure\fR\&. The amanda server to connect with the amdump_client program\&.
79 \fBindex\-server\fR \fIstring\fR
82 \fISet by configure\fR\&. The amindexd server amrecover will connect to\&.
85 \fBtape\-server\fR \fIstring\fR
88 \fISet by configure\fR\&. The amidxtaped server amrecover will connect to\&.
91 \fBtapedev\fR \fIstring\fR
94 \fISet by configure\fR\&. The tapedev amrecover will use\&.
97 \fBauth\fR \fIstring\fR
100 \fB"bsdtcp"\fR\&. Type of authorization to perform between tape server and backup client hosts\&.
102 \fB"bsd"\fR, bsd authorization with udp initial connection and one tcp connection by data stream\&.
104 \fB"bsdtcp"\fR, bsd authorization but use only one tcp connection\&.
106 \fB"bsdudp"\fR, like bsd, but will use only one tcp connection for all data stream\&.
109 to use Kerberos\-V authorization\&.
111 \fB"local"\fR, if the client is the server, it doesn\*(Aqt require authencation setup\&.
114 to use rsh authorization\&.
117 to use OpenSSH authorization\&.
120 \fBssh\-keys\fR \fIstring\fR
123 \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\&.
126 \fBgnutar\-list\-dir\fR \fIstring\fR
128 Default from configure
129 \fI\-\-with\-gnutar\-listdir=DIR\fR\&. The directory where gnutar keep its state file\&.
132 \fBmailer\fR \fIstring\fR
134 Default found by configure\&. A mail program that can send mail with \*(Aq\fIMAILER \-s "subject" user < message_file\fR\*(Aq\&.
137 \fBamandates\fR \fIstring\fR
140 \fI/etc/amandates\fR\&. The file where amanda keep the last date of each dumplevel\&.
143 \fBconnect\-tries\fR \fIint\fR
146 \fI3\fR\&. How many times the server will try a connection\&.
149 \fBrep\-tries\fR \fIint\fR
152 \fI5\fR\&. How many times amandad will resend a REP packet if it doesn\*(Aqt get the ACK packet\&.
155 \fBdebug\-days\fR \fIint\fR
158 \fI3\fR\&. The number of days the debug files are kept\&.
161 \fBdebug\-amandad\fR \fIint\fR
164 \fI0\fR\&. Debug level of the amandad process
167 \fBdebug\-amidxtaped\fR \fIint\fR
170 \fI0\fR\&. Debug level of the amidxtaped process
173 \fBdebug\-amindexd\fR \fIint\fR
176 \fI0\fR\&. Debug level of the amindexd process
179 \fBdebug\-amrecover\fR \fIint\fR
182 \fI0\fR\&. Debug level of the amrecover process
185 \fBdebug\-auth\fR \fIint\fR
188 \fI0\fR\&. Debug level of the auth module
191 \fBdebug\-event\fR \fIint\fR
194 \fI0\fR\&. Debug level of the event module
197 \fBdebug\-holding\fR \fIint\fR
200 \fI0\fR\&. Debug level of the holdingdisk module
203 \fBdebug\-protocol\fR \fIint\fR
206 \fI0\fR\&. Debug level of the protocol module
209 \fBdebug\-selfcheck\fR \fIint\fR
212 \fI0\fR\&. Debug level of the selfcheck process
215 \fBdebug\-sendsize\fR \fIint\fR
218 \fI0\fR\&. Debug level of the sendsize process
221 \fBdebug\-sendbackup\fR \fIint\fR
224 \fI0\fR\&. Debug level of the sendbackup process
227 \fBreserved\-udp\-port\fR \fIint\fR,\fIint\fR
229 Default: \-\-with\-udpportrange or
230 \fI512,1023\fR\&. Reserved udp port that will be used (amrecover with bsd or bsdudp)
233 \fBreserved\-tcp\-port\fR \fIint\fR,\fIint\fR
235 Default: \-\-with\-low\-tcpportrange or
236 \fI512,1023\fR\&. Reserved tcp port that will be used (amrecover with bsdtcp)
239 \fBunreserved\-tcp\-port\fR \fIint\fR,\fIint\fR
241 Default: \-\-with\-tcpportrange or
242 \fI1025,65536\fR\&. Unreserved tcp port that will be used (bsd, bsdudp)
245 \fBproperty\fR \fIstring\fR \fIstring\fR+
247 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
249 .SH "APPLICATION SECTION"
252 \fBamanda\-client\&.conf\fR
253 file may define multiple types of application\&. The information is entered in a
255 section, which looks like this:
257 define application "\fIname\fR" {
258 \fIapplication\-option\fR \fIapplication\-value\fR
264 is the name of this type of application\&.
266 The setting from an application is merged with the dle setting if the
269 \fBclient\-application\-name\fR
270 from the dle or if the
271 \fBclient\-application\-name\fR
272 from the dle is not set and the
278 The application options and values are:
280 \fBclient\-application\-name\fR \fIstring\fR
283 \fInone\fR\&. Not use on the client\&.
286 \fBcomment\fR \fIstring\fR
289 \fInone\fR\&. A comment string describing this application\&.
292 \fBplugin\fR \fIstring\fR
294 No default\&. Must be set to the name of the program\&. This program must be in the
295 \fI$libexecdir/amanda/application\fR
296 directory on the client\&. If set, it must be the same as the dle
300 \fBproperty\fR [\fBappend\fR] [\fBpriority\fR] \fIstring\fR \fIstring\fR+
302 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\&.
304 keyword append the values to the list of values for that property\&.
306 keyword disallow the setting of that property on the server\&.
311 \fBamanda\-client\&.conf\fR
312 file may define multiple types of script\&. The information is entered in a
314 section, which looks like this:
316 define script "\fIname\fR" {
317 \fIscript\-option\fR \fIscript\-value\fR
323 is the name of this type of script\&.
325 The setting from a script is merged with the dle setting if the
328 \fBclient\-script\-name\fR
329 from the dle or if the
330 \fBclient\-script\-name\fR
331 from the dle is not set and the
337 The script options and values are:
339 \fBclient\-script\-name\fR \fIstring\fR
342 \fInone\fR\&. Not used on the client\&.
345 \fBcomment\fR \fIstring\fR
348 \fInone\fR\&. A comment string describing this script\&.
351 \fBplugin\fR \fIstring\fR
353 No default\&. Must be set to the name of the program\&. This program must be in the
354 \fI$libdir/amanda/application\fR
355 directory on the client\&. If set, it must be the same as the dle
359 \fBexecute\-where\fR \fBclient\fR
362 \fBclient\fR\&. Value can\*(Aqt be changed\&.
365 \fBexecute\-on\fR \fIexecute_on\fR[,\fIexecute_on\fR]*
367 No default\&. When the script must be executed, you can specify many of them:
369 \fBpre\-dle\-amcheck\fR
371 Execute before the amcheck command for the dle\&.
374 \fBpre\-host\-amcheck\fR
376 Execute before the amcheck command for all dle for the client\&.
379 \fBpost\-dle\-amcheck\fR
381 Execute after the amcheck command for the dle\&.
384 \fBpost\-host\-amcheck\fR
386 Execute after the amcheck command for all dle for the client\&.
389 \fBpre\-dle\-estimate\fR
391 Execute before the estimate command for the dle\&.
394 \fBpre\-host\-estimate\fR
396 Execute before the estimate command for all dle for the client\&.
399 \fBpost\-dle\-estimate\fR
401 Execute after the estimate command for the dle\&.
404 \fBpost\-host\-estimate\fR
406 Execute after the estimate command for all dle for the client\&.
409 \fBpre\-dle\-backup\fR
411 Execute before the backup command for the dle\&.
414 \fBpost\-dle\-backup\fR
416 Execute after the backup command for the dle\&.
421 Execute before any level is recovered\&.
426 Execute after all levels are recovered\&.
429 \fBpre\-level\-recover\fR
431 Execute before each level recovery\&.
434 \fBpost\-level\-recover\fR
436 Execute after each level recovery\&.
439 \fBinter\-level\-recover\fR
441 Execute between two levels of recovery\&.
445 \fBproperty\fR [\fBappend\fR] [\fBpriority\fR] \fIstring\fR \fIstring\fR+
447 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\&.
449 keyword append the values to the list of values for that property\&.
451 keyword disallow the setting of that property on the server\&.
456 \fBamanda.conf\fR(5),
461 : http://wiki.zmanda.com/
464 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
466 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>