git.gag.com Git - debian/amanda/blob - man/amanda-client.conf.5

   1 '\" t
   2 .\"     Title: amanda-client.conf
   3 .\"    Author: James da Silva <jds@amanda.org>
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
   5 .\"      Date: 11/05/2009
   6 .\"    Manual: File formats and conventions
   7 .\"    Source: Amanda 2.6.1p2
   8 .\"  Language: English
   9 .\"
  10 .TH "AMANDA\-CLIENT\&.CON" "5" "11/05/2009" "Amanda 2\&.6\&.1p2" "File formats and conventions"
  11 .\" -----------------------------------------------------------------
  12 .\" * set default formatting
  13 .\" -----------------------------------------------------------------
  14 .\" disable hyphenation
  15 .nh
  16 .\" disable justification (adjust text to left margin only)
  17 .ad l
  18 .\" -----------------------------------------------------------------
  19 .\" * MAIN CONTENT STARTS HERE *
  20 .\" -----------------------------------------------------------------
  21 .SH "NAME"
  22 amanda-client.conf \- Client configuration file for \fIAmanda\fR, the Advanced Maryland Automatic Network Disk Archiver
  23 .SH "DESCRIPTION"
  24 .PP
  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\&.
  28 .PP
  29 The files
  30 \fB<CONFIG_DIR>/amanda\-client\&.conf\fR
  31 and
  32 \fB<CONFIG_DIR>/<config>/amanda\-client\&.conf\fR
  33 are loaded\&.
  34 .SH "SYNTAX"
  35
  36
  37 The syntax of \fBamanda-client.conf\fR(5) is identical to that for
  38 \fBamanda.conf\fR(5)\&.
  39 .SH "GLOBAL PARAMETERS"
  40 .PP
  41 \fBconf\fR \fI string\fR
  42 .RS 4
  43 Default:
  44 \fISet by configure\fR\&. The conf use by amrecover\&.
  45 .RE
  46 .PP
  47 \fBclient_username\fR \fI string\fR
  48 .RS 4
  49 Default:
  50 \fICLIENT_LOGIN\fR\&. Similar to the parameter of the same name in
  51 \fBamanda.conf\fR(5), this specifies the username that
  52 \fBamrecover\fR
  53 should send when connecting to the server\&. It should match the username specified in
  54 \&.amandahosts
  55 on the server\&.
  56 .RE
  57 .PP
  58 \fBindex_server\fR \fI string\fR
  59 .RS 4
  60 Default:
  61 \fISet by configure\fR\&. The amindexd server amrecover will connect to\&.
  62 .RE
  63 .PP
  64 \fBtape_server\fR \fI string\fR
  65 .RS 4
  66 Default:
  67 \fISet by configure\fR\&. The amidxtaped server amrecover will connect to\&.
  68 .RE
  69 .PP
  70 \fBtapedev\fR \fI string\fR
  71 .RS 4
  72 Default:
  73 \fISet by configure\fR\&. The tapedev amrecover will use\&.
  74 .RE
  75 .PP
  76 \fBauth\fR \fI string\fR
  77 .RS 4
  78 Default:
  79 \fIbsd\fR\&. Type of authorization to perform between tape server and backup client hosts\&.
  80 .sp
  81 \fBbsd\fR, bsd authorization with udp initial connection and one tcp connection by data stream\&.
  82 .sp
  83 \fBbsdtcp\fR, bsd authorization but use only one tcp connection\&.
  84 .sp
  85 \fBbsdudp\fR, like bsd, but will use only one tcp connection for all data stream\&.
  86 .sp
  87 \fBkrb4\fR
  88 to use Kerberos\-IV authorization\&.
  89 .sp
  90 \fBkrb5\fR
  91 to use Kerberos\-V authorization\&.
  92 .sp
  93 \fBlocal\fR, if the client is the server, it doesn\'t require authencation setup\&.
  94 .sp
  95 \fBrsh\fR
  96 to use rsh authorization\&.
  97 .sp
  98 \fBssh\fR
  99 to use OpenSSH authorization\&.
 100 .RE
 101 .PP
 102 \fBssh_keys\fR \fI string\fR
 103 .RS 4
 104 Default:
 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 default ssh key will be used\&.
 106 .RE
 107 .PP
 108 \fBgnutar_list_dir\fR \fI string\fR
 109 .RS 4
 110 Default from configure
 111 \fI\-\-with\-gnutar\-listdir=DIR\fR\&. The directory where gnutar keep its state file\&.
 112 .RE
 113 .PP
 114 \fBmailer\fR \fI string\fR
 115 .RS 4
 116 Default found by configure\&. A mail program that can send mail with \'\fIMAILER \-s "subject" user < message_file\fR\'\&.
 117 .RE
 118 .PP
 119 \fBamandates\fR \fI string\fR
 120 .RS 4
 121 Default:
 122 \fI/etc/amandates\fR\&. The file where amanda keep the last date of each dumplevel\&.
 123 .RE
 124 .PP
 125 \fBconnect_tries\fR int
 126 .RS 4
 127 Default:
 128 \fI3\fR\&. How many times the server will try a connection\&.
 129 .RE
 130 .PP
 131 \fBrep_tries\fR int
 132 .RS 4
 133 Default:
 134 \fI5\fR\&. How many times amandad will resend a REP packet if it doesn\'t get the ACK packet\&.
 135 .RE
 136 .PP
 137 \fBdebug_amandad\fR int
 138 .RS 4
 139 Default:
 140 \fI0\fR\&. Debug level of the amandad process
 141 .RE
 142 .PP
 143 \fBdebug_amidxtaped\fR int
 144 .RS 4
 145 Default:
 146 \fI0\fR\&. Debug level of the amidxtaped process
 147 .RE
 148 .PP
 149 \fBdebug_amindexd\fR int
 150 .RS 4
 151 Default:
 152 \fI0\fR\&. Debug level of the amindexd process
 153 .RE
 154 .PP
 155 \fBdebug_amrecover\fR int
 156 .RS 4
 157 Default:
 158 \fI0\fR\&. Debug level of the amrecover process
 159 .RE
 160 .PP
 161 \fBdebug_auth\fR int
 162 .RS 4
 163 Default:
 164 \fI0\fR\&. Debug level of the auth module
 165 .RE
 166 .PP
 167 \fBdebug_event\fR int
 168 .RS 4
 169 Default:
 170 \fI0\fR\&. Debug level of the event module
 171 .RE
 172 .PP
 173 \fBdebug_holding\fR int
 174 .RS 4
 175 Default:
 176 \fI0\fR\&. Debug level of the holdingdisk module
 177 .RE
 178 .PP
 179 \fBdebug_protocol\fR int
 180 .RS 4
 181 Default:
 182 \fI0\fR\&. Debug level of the protocol module
 183 .RE
 184 .PP
 185 \fBdebug_selfcheck\fR int
 186 .RS 4
 187 Default:
 188 \fI0\fR\&. Debug level of the selfcheck process
 189 .RE
 190 .PP
 191 \fBdebug_sendsize\fR int
 192 .RS 4
 193 Default:
 194 \fI0\fR\&. Debug level of the sendsize process
 195 .RE
 196 .PP
 197 \fBdebug_sendbackup\fR int
 198 .RS 4
 199 Default:
 200 \fI0\fR\&. Debug level of the sendbackup process
 201 .RE
 202 .PP
 203 \fBreserved\-udp\-port\fR int,int
 204 .RS 4
 205 Default: \-\-with\-udpportrange or
 206 \fI512,1023\fR\&. Reserved udp port that will be used (amrecover with bsd or bsdudp)
 207 .RE
 208 .PP
 209 \fBreserved\-tcp\-port\fR int,int
 210 .RS 4
 211 Default: \-\-with\-low\-tcpportrange or
 212 \fI512,1023\fR\&. Reserved tcp port that will be used (amrecover with bsdtcp)
 213 .RE
 214 .PP
 215 \fBunreserved\-tcp\-port\fR int,int
 216 .RS 4
 217 Default: \-\-with\-tcpportrange or
 218 \fI1025,65536\fR\&. Unreserved tcp port that will be used (bsd, bsdudp)
 219 .RE
 220 .PP
 221 \fBproperty\fR "name" "value"
 222 .RS 4
 223 Adds a global property for this client host, useful for e\&.g\&., Application API plugins\&.
 224 .RE
 225 .SH "APPLICATION SECTION"
 226 .PP
 227 The
 228 \fBamanda\&.conf\fR
 229 file may define multiple types of application\&. The information is entered in a
 230 \fBapplication\-tool\fR
 231 section, which looks like this:
 232 .nf
 233 define application\-tool "\fIname\fR" {
 234     \fIapplication\-option\fR \fIappli
 235 cation\-value\fR
 236     \&.\&.\&.
 237 }
 238 .fi
 239 .PP
 240 \fIname\fR
 241 is the name of this type of application\&. It is referenced from the
 242 \fIdumptype\fR
 243 .PP
 244 The application\-tool options and values are:
 245 .PP
 246 \fBcomment\fR \fIstring\fR
 247 .RS 4
 248 Default:
 249 \fInone\fR\&. A comment string describing this application\&.
 250 .RE
 251 .PP
 252 \fBplugin\fR \fIstring\fR
 253 .RS 4
 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\&.
 257 .RE
 258 .PP
 259 \fBproperty\fR [append] [priority] \fIstring\fR \fIstring\fR+
 260 .RS 4
 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\&.
 262 \fBappend\fR
 263 keyword append the values to the list of values for that property\&.
 264 \fBpriority\fR
 265 keyword disallow the setting of that property on the server\&.
 266 .RE
 267 .SH "SCRIPT SECTION"
 268 .PP
 269 The
 270 \fBamanda\&.conf\fR
 271 file may define multiple types of script\&. The information is entered in a
 272 \fBscript\-tool\fR
 273 section, which looks like this:
 274 .nf
 275 define script\-tool "\fIname\fR" {
 276     \fIscript\-option\fR \fIscript\-value\fR
 277     \&.\&.\&.
 278 }
 279 .fi
 280 .PP
 281 \fIname\fR
 282 is the name of this type of script\&. It is referenced from the
 283 \fIdumptype\fR
 284 .PP
 285 The script\-tool options and values are:
 286 .PP
 287 \fBcomment\fR \fIstring\fR
 288 .RS 4
 289 Default:
 290 \fInone\fR\&. A comment string describing this script\&.
 291 .RE
 292 .PP
 293 \fBplugin\fR \fIstring\fR
 294 .RS 4
 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\&.
 298 .RE
 299 .PP
 300 \fBexecute_where\fR [client|server]
 301 .RS 4
 302 Default:
 303 \fIclient\fR\&. Where the script must be executed, on the client or server\&. Only
 304 \fIclient\fR
 305 is valid\&.
 306 .RE
 307 .PP
 308 \fBexecute_on\fR \fIexecute_on\fR[,\fIexecute_on\fR]*
 309 .RS 4
 310 No default\&. When the script must be executed, you can specify many of them:
 311 .PP
 312 \fBpre\-dle\-amcheck\fR
 313 .RS 4
 314 Execute before the amcheck command for the dle\&.
 315 .RE
 316 .PP
 317 \fBpre\-host\-amcheck\fR
 318 .RS 4
 319 Execute before the amcheck command for all dle for the client\&.
 320 .RE
 321 .PP
 322 \fBpost\-dle\-amcheck\fR
 323 .RS 4
 324 Execute after the amcheck command for the dle\&.
 325 .RE
 326 .PP
 327 \fBpost\-host\-amcheck\fR
 328 .RS 4
 329 Execute after the amcheck command for all dle for the client\&.
 330 .RE
 331 .PP
 332 \fBpre\-dle\-estimate\fR
 333 .RS 4
 334 Execute before the estimate command for the dle\&.
 335 .RE
 336 .PP
 337 \fBpre\-host\-estimate\fR
 338 .RS 4
 339 Execute before the estimate command for all dle for the client\&.
 340 .RE
 341 .PP
 342 \fBpost\-dle\-estimate\fR
 343 .RS 4
 344 Execute after the estimate command for the dle\&.
 345 .RE
 346 .PP
 347 \fBpost\-host\-estimate\fR
 348 .RS 4
 349 Execute after the estimate command for all dle for the client\&.
 350 .RE
 351 .PP
 352 \fBpre\-dle\-backup\fR
 353 .RS 4
 354 Execute before the backup command for the dle\&.
 355 .RE
 356 .PP
 357 \fBpre\-host\-backup\fR
 358 .RS 4
 359 Execute before the backup command for all dle for the client\&.
 360 .RE
 361 .PP
 362 \fBpost\-dle\-backup\fR
 363 .RS 4
 364 Execute after the backup command for the dle\&.
 365 .RE
 366 .PP
 367 \fBpost\-host\-backup\fR
 368 .RS 4
 369 Execute after the backup command for all dle for the client\&.
 370 .RE
 371 .PP
 372 \fBpre\-recover\fR
 373 .RS 4
 374 Execute before any level is recovered\&.
 375 .RE
 376 .PP
 377 \fBpost\-recover\fR
 378 .RS 4
 379 Execute after all levels are recovered\&.
 380 .RE
 381 .PP
 382 \fBpre\-level\-recover\fR
 383 .RS 4
 384 Execute before each level recovery\&.
 385 .RE
 386 .PP
 387 \fBpost\-level\-recover\fR
 388 .RS 4
 389 Execute after each level recovery\&.
 390 .RE
 391 .PP
 392 \fBinter\-level\-recover\fR
 393 .RS 4
 394 Execute between two levels of recovery\&.
 395 .RE
 396 .RE
 397 .PP
 398 \fBproperty\fR [append] [priority] \fIstring\fR \fIstring\fR+
 399 .RS 4
 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\&.
 401 \fBappend\fR
 402 keyword append the values to the list of values for that property\&.
 403 \fBpriority\fR
 404 keyword disallow the setting of that property on the server\&.
 405 .RE
 406 .SH "SEE ALSO"
 407 .PP
 408
 409 \fBamanda\fR(8),
 410 \fBamanda.conf\fR(5),
 411 \fBamcrypt\fR(8),
 412 \fBaespipe\fR(1),
 413 : http://wiki.zmanda.com
 414 .SH "AUTHORS"
 415 .PP
 416 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
 417 .PP
 418 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>