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

   1 .\"     Title: amanda-client.conf
   2 .\"    Author: James da Silva <jds@amanda.org>
   3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
   4 .\"      Date: 01/22/2009
   5 .\"    Manual: File formats and conventions
   6 .\"    Source: Amanda 2.6.1
   7 .\"  Language: English
   8 .\"
   9 .TH "AMANDA\-CLIENT\&.CON" "5" "01/22/2009" "Amanda 2\&.6\&.1" "File formats and conventions"
  10 .\" -----------------------------------------------------------------
  11 .\" * (re)Define some macros
  12 .\" -----------------------------------------------------------------
  13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  14 .\" toupper - uppercase a string (locale-aware)
  15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  16 .de toupper
  17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
  18 \\$*
  19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
  20 ..
  21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  22 .\" SH-xref - format a cross-reference to an SH section
  23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24 .de SH-xref
  25 .ie n \{\
  26 .\}
  27 .toupper \\$*
  28 .el \{\
  29 \\$*
  30 .\}
  31 ..
  32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  33 .\" SH - level-one heading that works better for non-TTY output
  34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35 .de1 SH
  36 .\" put an extra blank line of space above the head in non-TTY output
  37 .if t \{\
  38 .sp 1
  39 .\}
  40 .sp \\n[PD]u
  41 .nr an-level 1
  42 .set-an-margin
  43 .nr an-prevailing-indent \\n[IN]
  44 .fi
  45 .in \\n[an-margin]u
  46 .ti 0
  47 .HTML-TAG ".NH \\n[an-level]"
  48 .it 1 an-trap
  49 .nr an-no-space-flag 1
  50 .nr an-break-flag 1
  51 \." make the size of the head bigger
  52 .ps +3
  53 .ft B
  54 .ne (2v + 1u)
  55 .ie n \{\
  56 .\" if n (TTY output), use uppercase
  57 .toupper \\$*
  58 .\}
  59 .el \{\
  60 .nr an-break-flag 0
  61 .\" if not n (not TTY), use normal case (not uppercase)
  62 \\$1
  63 .in \\n[an-margin]u
  64 .ti 0
  65 .\" if not n (not TTY), put a border/line under subheading
  66 .sp -.6
  67 \l'\n(.lu'
  68 .\}
  69 ..
  70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  71 .\" SS - level-two heading that works better for non-TTY output
  72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  73 .de1 SS
  74 .sp \\n[PD]u
  75 .nr an-level 1
  76 .set-an-margin
  77 .nr an-prevailing-indent \\n[IN]
  78 .fi
  79 .in \\n[IN]u
  80 .ti \\n[SN]u
  81 .it 1 an-trap
  82 .nr an-no-space-flag 1
  83 .nr an-break-flag 1
  84 .ps \\n[PS-SS]u
  85 \." make the size of the head bigger
  86 .ps +2
  87 .ft B
  88 .ne (2v + 1u)
  89 .if \\n[.$] \&\\$*
  90 ..
  91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  92 .\" BB/BE - put background/screen (filled box) around block of text
  93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  94 .de BB
  95 .if t \{\
  96 .sp -.5
  97 .br
  98 .in +2n
  99 .ll -2n
 100 .gcolor red
 101 .di BX
 102 .\}
 103 ..
 104 .de EB
 105 .if t \{\
 106 .if "\\$2"adjust-for-leading-newline" \{\
 107 .sp -1
 108 .\}
 109 .br
 110 .di
 111 .in
 112 .ll
 113 .gcolor
 114 .nr BW \\n(.lu-\\n(.i
 115 .nr BH \\n(dn+.5v
 116 .ne \\n(BHu+.5v
 117 .ie "\\$2"adjust-for-leading-newline" \{\
 118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 119 .\}
 120 .el \{\
 121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 122 .\}
 123 .in 0
 124 .sp -.5v
 125 .nf
 126 .BX
 127 .in
 128 .sp .5v
 129 .fi
 130 .\}
 131 ..
 132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 133 .\" BM/EM - put colored marker in margin next to block of text
 134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 135 .de BM
 136 .if t \{\
 137 .br
 138 .ll -2n
 139 .gcolor red
 140 .di BX
 141 .\}
 142 ..
 143 .de EM
 144 .if t \{\
 145 .br
 146 .di
 147 .ll
 148 .gcolor
 149 .nr BH \\n(dn
 150 .ne \\n(BHu
 151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
 152 .in 0
 153 .nf
 154 .BX
 155 .in
 156 .fi
 157 .\}
 158 ..
 159 .\" -----------------------------------------------------------------
 160 .\" * set default formatting
 161 .\" -----------------------------------------------------------------
 162 .\" disable hyphenation
 163 .nh
 164 .\" disable justification (adjust text to left margin only)
 165 .ad l
 166 .\" -----------------------------------------------------------------
 167 .\" * MAIN CONTENT STARTS HERE *
 168 .\" -----------------------------------------------------------------
 169 .SH "Name"
 170 amanda-client.conf \- Client configuration file for \fIAmanda\fR, the Advanced Maryland Automatic Network Disk Archiver
 171 .SH "DESCRIPTION"
 172 .PP
 173 \fBamanda-client.conf\fR(5)
 174 is the client configuration file for
 175 \fIAmanda\fR\&. This manpage lists the relevant sections and parameters of this file for quick reference\&.
 176 .PP
 177 The files
 178 \fB<CONFIG_DIR>/amanda\-client\&.conf\fR
 179 and
 180 \fB<CONFIG_DIR>/<config>/amanda\-client\&.conf\fR
 181 are loaded\&.
 182 .SH "SYNTAX"
 183
 184
 185 The syntax of \fBamanda-client.conf\fR(5) is identical to that for
 186 \fBamanda.conf\fR(5)\&.
 187 .SH "GLOBAL PARAMETERS"
 188 .PP
 189 \fBconf\fR \fI string\fR
 190 .RS 4
 191 Default:
 192 \fISet by configure\fR\&. The conf use by amrecover\&.
 193 .RE
 194 .PP
 195 \fBclient_username\fR \fI string\fR
 196 .RS 4
 197 Default:
 198 \fICLIENT_LOGIN\fR\&. Similar to the parameter of the same name in
 199 \fBamanda.conf\fR(5), this specifies the username that
 200 \fBamrecover\fR
 201 should send when connecting to the server\&. It should match the username specified in
 202 \FC\&.amandahosts\F[]
 203 on the server\&.
 204 .RE
 205 .PP
 206 \fBindex_server\fR \fI string\fR
 207 .RS 4
 208 Default:
 209 \fISet by configure\fR\&. The amindexd server amrecover will connect to\&.
 210 .RE
 211 .PP
 212 \fBtape_server\fR \fI string\fR
 213 .RS 4
 214 Default:
 215 \fISet by configure\fR\&. The amidxtaped server amrecover will connect to\&.
 216 .RE
 217 .PP
 218 \fBtapedev\fR \fI string\fR
 219 .RS 4
 220 Default:
 221 \fISet by configure\fR\&. The tapedev amrecover will use\&.
 222 .RE
 223 .PP
 224 \fBauth\fR \fI string\fR
 225 .RS 4
 226 Default:
 227 \fIbsd\fR\&. Type of authorization to perform between tape server and backup client hosts\&.
 228 .sp
 229 \fBbsd\fR, bsd authorization with udp initial connection and one tcp connection by data stream\&.
 230 .sp
 231 \fBbsdtcp\fR, bsd authorization but use only one tcp connection\&.
 232 .sp
 233 \fBbsdudp\fR, like bsd, but will use only one tcp connection for all data stream\&.
 234 .sp
 235 \fBkrb4\fR
 236 to use Kerberos\-IV authorization\&.
 237 .sp
 238 \fBkrb5\fR
 239 to use Kerberos\-V authorization\&.
 240 .sp
 241 \fBlocal\fR, if the client is the server, it doesn\'t require authencation setup\&.
 242 .sp
 243 \fBrsh\fR
 244 to use rsh authorization\&.
 245 .sp
 246 \fBssh\fR
 247 to use OpenSSH authorization\&.
 248 .RE
 249 .PP
 250 \fBssh_keys\fR \fI string\fR
 251 .RS 4
 252 Default:
 253 \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\&.
 254 .RE
 255 .PP
 256 \fBgnutar_list_dir\fR \fI string\fR
 257 .RS 4
 258 Default from configure
 259 \fI\-\-with\-gnutar\-listdir=DIR\fR\&. The directory where gnutar keep its state file\&.
 260 .RE
 261 .PP
 262 \fBmailer\fR \fI string\fR
 263 .RS 4
 264 Default found by configure\&. A mail program that can send mail with \'\fIMAILER \-s "subject" user < message_file\fR\'\&.
 265 .RE
 266 .PP
 267 \fBamandates\fR \fI string\fR
 268 .RS 4
 269 Default:
 270 \fI/etc/amandates\fR\&. The file where amanda keep the last date of each dumplevel\&.
 271 .RE
 272 .PP
 273 \fBconnect_tries\fR int
 274 .RS 4
 275 Default:
 276 \fI3\fR\&. How many times the server will try a connection\&.
 277 .RE
 278 .PP
 279 \fBrep_tries\fR int
 280 .RS 4
 281 Default:
 282 \fI5\fR\&. How many times amandad will resend a REP packet if it doesn\'t get the ACK packet\&.
 283 .RE
 284 .PP
 285 \fBdebug_amandad\fR int
 286 .RS 4
 287 Default:
 288 \fI0\fR\&. Debug level of the amandad process
 289 .RE
 290 .PP
 291 \fBdebug_amidxtaped\fR int
 292 .RS 4
 293 Default:
 294 \fI0\fR\&. Debug level of the amidxtaped process
 295 .RE
 296 .PP
 297 \fBdebug_amindexd\fR int
 298 .RS 4
 299 Default:
 300 \fI0\fR\&. Debug level of the amindexd process
 301 .RE
 302 .PP
 303 \fBdebug_amrecover\fR int
 304 .RS 4
 305 Default:
 306 \fI0\fR\&. Debug level of the amrecover process
 307 .RE
 308 .PP
 309 \fBdebug_auth\fR int
 310 .RS 4
 311 Default:
 312 \fI0\fR\&. Debug level of the auth module
 313 .RE
 314 .PP
 315 \fBdebug_event\fR int
 316 .RS 4
 317 Default:
 318 \fI0\fR\&. Debug level of the event module
 319 .RE
 320 .PP
 321 \fBdebug_holding\fR int
 322 .RS 4
 323 Default:
 324 \fI0\fR\&. Debug level of the holdingdisk module
 325 .RE
 326 .PP
 327 \fBdebug_protocol\fR int
 328 .RS 4
 329 Default:
 330 \fI0\fR\&. Debug level of the protocol module
 331 .RE
 332 .PP
 333 \fBdebug_selfcheck\fR int
 334 .RS 4
 335 Default:
 336 \fI0\fR\&. Debug level of the selfcheck process
 337 .RE
 338 .PP
 339 \fBdebug_sendsize\fR int
 340 .RS 4
 341 Default:
 342 \fI0\fR\&. Debug level of the sendsize process
 343 .RE
 344 .PP
 345 \fBdebug_sendbackup\fR int
 346 .RS 4
 347 Default:
 348 \fI0\fR\&. Debug level of the sendbackup process
 349 .RE
 350 .PP
 351 \fBreserved\-udp\-port\fR int,int
 352 .RS 4
 353 Default: \-\-with\-udpportrange or
 354 \fI512,1023\fR\&. Reserved udp port that will be used (amrecover with bsd or bsdudp)
 355 .RE
 356 .PP
 357 \fBreserved\-tcp\-port\fR int,int
 358 .RS 4
 359 Default: \-\-with\-low\-tcpportrange or
 360 \fI512,1023\fR\&. Reserved tcp port that will be used (amrecover with bsdtcp)
 361 .RE
 362 .PP
 363 \fBunreserved\-tcp\-port\fR int,int
 364 .RS 4
 365 Default: \-\-with\-tcpportrange or
 366 \fI1025,65536\fR\&. Unreserved tcp port that will be used (bsd, bsdudp)
 367 .RE
 368 .PP
 369 \fBproperty\fR "name" "value"
 370 .RS 4
 371 Adds a global property for this client host, useful for e\&.g\&., Application API plugins\&.
 372 .RE
 373 .SH "APPLICATION SECTION"
 374 .PP
 375 The
 376 \fBamanda\&.conf\fR
 377 file may define multiple types of application\&. The information is entered in a
 378 \fBapplication\-tool\fR
 379 section, which looks like this:
 380 .nf
 381 define application\-tool "\fIname\fR" {
 382     \fIapplication\-option\fR \fIappli
 383 cation\-value\fR
 384     \FC\&.\&.\&.\F[]
 385 }
 386 .fi
 387 .PP
 388 \fIname\fR
 389 is the name of this type of application\&. It is referenced from the
 390 \fIdumptype\fR
 391 .PP
 392 The application\-tool options and values are:
 393 .PP
 394 \fBcomment\fR \fIstring\fR
 395 .RS 4
 396 Default:
 397 \fInone\fR\&. A comment string describing this application\&.
 398 .RE
 399 .PP
 400 \fBplugin\fR \fIstring\fR
 401 .RS 4
 402 No default\&. Must be set to the name of the program\&. This program must be in the
 403 \fI$libexecdir/amanda/application\fR
 404 directory on the client\&.
 405 .RE
 406 .PP
 407 \fBproperty\fR [append] [priority] \fIstring\fR \fIstring\fR+
 408 .RS 4
 409 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\&.
 410 \fBappend\fR
 411 keyword append the values to the list of values for that property\&.
 412 \fBpriority\fR
 413 keyword disallow the setting of that property on the server\&.
 414 .RE
 415 .SH "SCRIPT SECTION"
 416 .PP
 417 The
 418 \fBamanda\&.conf\fR
 419 file may define multiple types of script\&. The information is entered in a
 420 \fBscript\-tool\fR
 421 section, which looks like this:
 422 .nf
 423 define script\-tool "\fIname\fR" {
 424     \fIscript\-option\fR \fIscript\-value\fR
 425     \FC\&.\&.\&.\F[]
 426 }
 427 .fi
 428 .PP
 429 \fIname\fR
 430 is the name of this type of script\&. It is referenced from the
 431 \fIdumptype\fR
 432 .PP
 433 The script\-tool options and values are:
 434 .PP
 435 \fBcomment\fR \fIstring\fR
 436 .RS 4
 437 Default:
 438 \fInone\fR\&. A comment string describing this script\&.
 439 .RE
 440 .PP
 441 \fBplugin\fR \fIstring\fR
 442 .RS 4
 443 No default\&. Must be set to the name of the program\&. This program must be in the
 444 \fI$libdir/amanda/application\fR
 445 directory on the client and/or server\&.
 446 .RE
 447 .PP
 448 \fBexecute_where\fR [client|server]
 449 .RS 4
 450 Default:
 451 \fIclient\fR\&. Where the script must be executed, on the client or server\&. Only
 452 \fIclient\fR
 453 is valid\&.
 454 .RE
 455 .PP
 456 \fBexecute_on\fR \fIexecute_on\fR[,\fIexecute_on\fR]*
 457 .RS 4
 458 No default\&. When the script must be executed, you can specify many of them:
 459 .PP
 460 \fBpre\-dle\-amcheck\fR
 461 .RS 4
 462 Execute before the amcheck command for the dle\&.
 463 .RE
 464 .PP
 465 \fBpre\-host\-amcheck\fR
 466 .RS 4
 467 Execute before the amcheck command for all dle for the client\&.
 468 .RE
 469 .PP
 470 \fBpost\-dle\-amcheck\fR
 471 .RS 4
 472 Execute after the amcheck command for the dle\&.
 473 .RE
 474 .PP
 475 \fBpost\-host\-amcheck\fR
 476 .RS 4
 477 Execute after the amcheck command for all dle for the client\&.
 478 .RE
 479 .PP
 480 \fBpre\-dle\-estimate\fR
 481 .RS 4
 482 Execute before the estimate command for the dle\&.
 483 .RE
 484 .PP
 485 \fBpre\-host\-estimate\fR
 486 .RS 4
 487 Execute before the estimate command for all dle for the client\&.
 488 .RE
 489 .PP
 490 \fBpost\-dle\-estimate\fR
 491 .RS 4
 492 Execute after the estimate command for the dle\&.
 493 .RE
 494 .PP
 495 \fBpost\-host\-estimate\fR
 496 .RS 4
 497 Execute after the estimate command for all dle for the client\&.
 498 .RE
 499 .PP
 500 \fBpre\-dle\-backup\fR
 501 .RS 4
 502 Execute before the backup command for the dle\&.
 503 .RE
 504 .PP
 505 \fBpre\-host\-backup\fR
 506 .RS 4
 507 Execute before the backup command for all dle for the client\&.
 508 .RE
 509 .PP
 510 \fBpost\-dle\-backup\fR
 511 .RS 4
 512 Execute after the backup command for the dle\&.
 513 .RE
 514 .PP
 515 \fBpost\-host\-backup\fR
 516 .RS 4
 517 Execute after the backup command for all dle for the client\&.
 518 .RE
 519 .PP
 520 \fBpre\-recover\fR
 521 .RS 4
 522 Execute before any level is recovered\&.
 523 .RE
 524 .PP
 525 \fBpost\-recover\fR
 526 .RS 4
 527 Execute after all levels are recovered\&.
 528 .RE
 529 .PP
 530 \fBpre\-level\-recover\fR
 531 .RS 4
 532 Execute before each level recovery\&.
 533 .RE
 534 .PP
 535 \fBpost\-level\-recover\fR
 536 .RS 4
 537 Execute after each level recovery\&.
 538 .RE
 539 .PP
 540 \fBinter\-level\-recover\fR
 541 .RS 4
 542 Execute between two levels of recovery\&.
 543 .RE
 544 .RE
 545 .PP
 546 \fBproperty\fR [append] [priority] \fIstring\fR \fIstring\fR+
 547 .RS 4
 548 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\&.
 549 \fBappend\fR
 550 keyword append the values to the list of values for that property\&.
 551 \fBpriority\fR
 552 keyword disallow the setting of that property on the server\&.
 553 .RE
 554 .SH "SEE ALSO"
 555 .PP
 556
 557 \fBamanda\fR(8),
 558 \fBamanda.conf\fR(5),
 559 \fBamcrypt\fR(8),
 560 \fBaespipe\fR(1),
 561 : http://wiki.zmanda.com
 562 .SH "Authors"
 563 .PP
 564 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
 565 .PP
 566 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>