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 v1.76.1 <http://docbook.sf.net/>
   5 .\"      Date: 07/25/2012
   6 .\"    Manual: File formats and conventions
   7 .\"    Source: Amanda 3.3.2
   8 .\"  Language: English
   9 .\"
  10 .TH "AMANDA\-CLIENT\&.CON" "5" "07/25/2012" "Amanda 3\&.3\&.2" "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 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 amanda-client.conf \- Client configuration file for Amanda, the Advanced Maryland Automatic Network Disk Archiver
  32 .SH "DESCRIPTION"
  33 .PP
  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\&.
  36 .PP
  37 The files
  38 \fB<CONFIG_DIR>/amanda\-client\&.conf\fR
  39 and
  40 \fB<CONFIG_DIR>/<config>/amanda\-client\&.conf\fR
  41 are loaded\&.
  42 .SH "SYNTAX"
  43
  44
  45 The syntax of \fBamanda-client.conf\fR(5) is identical to that for
  46 \fBamanda.conf\fR(5)\&.
  47 .SH "GLOBAL PARAMETERS"
  48 .PP
  49 \fBconf\fR \fIstring\fR
  50 .RS 4
  51 Default:
  52 \fISet by configure\fR\&. The conf use by amrecover\&.
  53 .RE
  54 .PP
  55 \fBclient\-username\fR \fIstring\fR
  56 .RS 4
  57 Default:
  58 \fICLIENT_LOGIN\fR\&. Similar to the parameter of the same name in
  59 \fBamanda.conf\fR(5), this specifies the username that
  60 \fBamrecover\fR
  61 should send when connecting to the server\&. It should match the username specified in
  62 \&.amandahosts
  63 on the server\&.
  64 .RE
  65 .PP
  66 \fBclient\-port\fR [ \fIint\fR | \fIstring\fR ]
  67 .RS 4
  68 Default:
  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\&.
  71 .RE
  72 .PP
  73 \fBamdump\-server\fR \fIstring\fR
  74 .RS 4
  75 No default:
  76 \fISet by configure\fR\&. The amanda server to connect with the amdump_client program\&.
  77 .RE
  78 .PP
  79 \fBindex\-server\fR \fIstring\fR
  80 .RS 4
  81 Default:
  82 \fISet by configure\fR\&. The amindexd server amrecover will connect to\&.
  83 .RE
  84 .PP
  85 \fBtape\-server\fR \fIstring\fR
  86 .RS 4
  87 Default:
  88 \fISet by configure\fR\&. The amidxtaped server amrecover will connect to\&.
  89 .RE
  90 .PP
  91 \fBtapedev\fR \fIstring\fR
  92 .RS 4
  93 Default:
  94 \fISet by configure\fR\&. The tapedev amrecover will use\&.
  95 .RE
  96 .PP
  97 \fBauth\fR \fIstring\fR
  98 .RS 4
  99 Default:
 100 \fB"bsdtcp"\fR\&. Type of authorization to perform between tape server and backup client hosts\&.
 101 .sp
 102 \fB"bsd"\fR, bsd authorization with udp initial connection and one tcp connection by data stream\&.
 103 .sp
 104 \fB"bsdtcp"\fR, bsd authorization but use only one tcp connection\&.
 105 .sp
 106 \fB"bsdudp"\fR, like bsd, but will use only one tcp connection for all data stream\&.
 107 .sp
 108 \fB"krb5"\fR
 109 to use Kerberos\-V authorization\&.
 110 .sp
 111 \fB"local"\fR, if the client is the server, it doesn\*(Aqt require authencation setup\&.
 112 .sp
 113 \fB"rsh"\fR
 114 to use rsh authorization\&.
 115 .sp
 116 \fB"ssh"\fR
 117 to use OpenSSH authorization\&.
 118 .RE
 119 .PP
 120 \fBssh\-keys\fR \fIstring\fR
 121 .RS 4
 122 Default:
 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\&.
 124 .RE
 125 .PP
 126 \fBgnutar\-list\-dir\fR \fIstring\fR
 127 .RS 4
 128 Default from configure
 129 \fI\-\-with\-gnutar\-listdir=DIR\fR\&. The directory where gnutar keep its state file\&.
 130 .RE
 131 .PP
 132 \fBmailer\fR \fIstring\fR
 133 .RS 4
 134 Default found by configure\&. A mail program that can send mail with \*(Aq\fIMAILER \-s "subject" user < message_file\fR\*(Aq\&.
 135 .RE
 136 .PP
 137 \fBamandates\fR \fIstring\fR
 138 .RS 4
 139 Default:
 140 \fI/etc/amandates\fR\&. The file where amanda keep the last date of each dumplevel\&.
 141 .RE
 142 .PP
 143 \fBconnect\-tries\fR \fIint\fR
 144 .RS 4
 145 Default:
 146 \fI3\fR\&. How many times the server will try a connection\&.
 147 .RE
 148 .PP
 149 \fBrep\-tries\fR \fIint\fR
 150 .RS 4
 151 Default:
 152 \fI5\fR\&. How many times amandad will resend a REP packet if it doesn\*(Aqt get the ACK packet\&.
 153 .RE
 154 .PP
 155 \fBdebug\-days\fR \fIint\fR
 156 .RS 4
 157 Default:
 158 \fI3\fR\&. The number of days the debug files are kept\&.
 159 .RE
 160 .PP
 161 \fBdebug\-amandad\fR \fIint\fR
 162 .RS 4
 163 Default:
 164 \fI0\fR\&. Debug level of the amandad process
 165 .RE
 166 .PP
 167 \fBdebug\-amidxtaped\fR \fIint\fR
 168 .RS 4
 169 Default:
 170 \fI0\fR\&. Debug level of the amidxtaped process
 171 .RE
 172 .PP
 173 \fBdebug\-amindexd\fR \fIint\fR
 174 .RS 4
 175 Default:
 176 \fI0\fR\&. Debug level of the amindexd process
 177 .RE
 178 .PP
 179 \fBdebug\-amrecover\fR \fIint\fR
 180 .RS 4
 181 Default:
 182 \fI0\fR\&. Debug level of the amrecover process
 183 .RE
 184 .PP
 185 \fBdebug\-auth\fR \fIint\fR
 186 .RS 4
 187 Default:
 188 \fI0\fR\&. Debug level of the auth module
 189 .RE
 190 .PP
 191 \fBdebug\-event\fR \fIint\fR
 192 .RS 4
 193 Default:
 194 \fI0\fR\&. Debug level of the event module
 195 .RE
 196 .PP
 197 \fBdebug\-holding\fR \fIint\fR
 198 .RS 4
 199 Default:
 200 \fI0\fR\&. Debug level of the holdingdisk module
 201 .RE
 202 .PP
 203 \fBdebug\-protocol\fR \fIint\fR
 204 .RS 4
 205 Default:
 206 \fI0\fR\&. Debug level of the protocol module
 207 .RE
 208 .PP
 209 \fBdebug\-selfcheck\fR \fIint\fR
 210 .RS 4
 211 Default:
 212 \fI0\fR\&. Debug level of the selfcheck process
 213 .RE
 214 .PP
 215 \fBdebug\-sendsize\fR \fIint\fR
 216 .RS 4
 217 Default:
 218 \fI0\fR\&. Debug level of the sendsize process
 219 .RE
 220 .PP
 221 \fBdebug\-sendbackup\fR \fIint\fR
 222 .RS 4
 223 Default:
 224 \fI0\fR\&. Debug level of the sendbackup process
 225 .RE
 226 .PP
 227 \fBreserved\-udp\-port\fR \fIint\fR,\fIint\fR
 228 .RS 4
 229 Default: \-\-with\-udpportrange or
 230 \fI512,1023\fR\&. Reserved udp port that will be used (amrecover with bsd or bsdudp)
 231 .RE
 232 .PP
 233 \fBreserved\-tcp\-port\fR \fIint\fR,\fIint\fR
 234 .RS 4
 235 Default: \-\-with\-low\-tcpportrange or
 236 \fI512,1023\fR\&. Reserved tcp port that will be used (amrecover with bsdtcp)
 237 .RE
 238 .PP
 239 \fBunreserved\-tcp\-port\fR \fIint\fR,\fIint\fR
 240 .RS 4
 241 Default: \-\-with\-tcpportrange or
 242 \fI1025,65536\fR\&. Unreserved tcp port that will be used (bsd, bsdudp)
 243 .RE
 244 .PP
 245 \fBproperty\fR \fIstring\fR \fIstring\fR+
 246 .RS 4
 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
 248 .RE
 249 .SH "APPLICATION SECTION"
 250 .PP
 251 The
 252 \fBamanda\-client\&.conf\fR
 253 file may define multiple types of application\&. The information is entered in a
 254 \fBapplication\fR
 255 section, which looks like this:
 256 .nf
 257 define application "\fIname\fR" {
 258     \fIapplication\-option\fR \fIapplication\-value\fR
 259     \&.\&.\&.
 260 }
 261 .fi
 262 .PP
 263 \fIname\fR
 264 is the name of this type of application\&.
 265 .PP
 266 The setting from an application is merged with the dle setting if the
 267 \fIname\fR
 268 is the same as 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
 273 \fIname\fR
 274 is the same as the
 275 \fBplugin\fR
 276 from the dle\&.
 277 .PP
 278 The application options and values are:
 279 .PP
 280 \fBclient\-application\-name\fR \fIstring\fR
 281 .RS 4
 282 Default:
 283 \fInone\fR\&. Not use on the client\&.
 284 .RE
 285 .PP
 286 \fBcomment\fR \fIstring\fR
 287 .RS 4
 288 Default:
 289 \fInone\fR\&. A comment string describing this application\&.
 290 .RE
 291 .PP
 292 \fBplugin\fR \fIstring\fR
 293 .RS 4
 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
 297 \fBplugin\fR\&.
 298 .RE
 299 .PP
 300 \fBproperty\fR [\fBappend\fR] [\fBpriority\fR] \fIstring\fR \fIstring\fR+
 301 .RS 4
 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\&.
 303 \fBappend\fR
 304 keyword append the values to the list of values for that property\&.
 305 \fBpriority\fR
 306 keyword disallow the setting of that property on the server\&.
 307 .RE
 308 .SH "SCRIPT SECTION"
 309 .PP
 310 The
 311 \fBamanda\-client\&.conf\fR
 312 file may define multiple types of script\&. The information is entered in a
 313 \fBscript\fR
 314 section, which looks like this:
 315 .nf
 316 define script "\fIname\fR" {
 317     \fIscript\-option\fR \fIscript\-value\fR
 318     \&.\&.\&.
 319 }
 320 .fi
 321 .PP
 322 \fIname\fR
 323 is the name of this type of script\&.
 324 .PP
 325 The setting from a script is merged with the dle setting if the
 326 \fIname\fR
 327 is the same as 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
 332 \fIname\fR
 333 is the same as the
 334 \fBplugin\fR
 335 from the dle\&.
 336 .PP
 337 The script options and values are:
 338 .PP
 339 \fBclient\-script\-name\fR \fIstring\fR
 340 .RS 4
 341 Default:
 342 \fInone\fR\&. Not used on the client\&.
 343 .RE
 344 .PP
 345 \fBcomment\fR \fIstring\fR
 346 .RS 4
 347 Default:
 348 \fInone\fR\&. A comment string describing this script\&.
 349 .RE
 350 .PP
 351 \fBplugin\fR \fIstring\fR
 352 .RS 4
 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
 356 \fBplugin\fR\&.
 357 .RE
 358 .PP
 359 \fBexecute\-where\fR \fBclient\fR
 360 .RS 4
 361 Default:
 362 \fBclient\fR\&. Value can\*(Aqt be changed\&.
 363 .RE
 364 .PP
 365 \fBexecute\-on\fR \fIexecute_on\fR[,\fIexecute_on\fR]*
 366 .RS 4
 367 No default\&. When the script must be executed, you can specify many of them:
 368 .PP
 369 \fBpre\-dle\-amcheck\fR
 370 .RS 4
 371 Execute before the amcheck command for the dle\&.
 372 .RE
 373 .PP
 374 \fBpre\-host\-amcheck\fR
 375 .RS 4
 376 Execute before the amcheck command for all dle for the client\&.
 377 .RE
 378 .PP
 379 \fBpost\-dle\-amcheck\fR
 380 .RS 4
 381 Execute after the amcheck command for the dle\&.
 382 .RE
 383 .PP
 384 \fBpost\-host\-amcheck\fR
 385 .RS 4
 386 Execute after the amcheck command for all dle for the client\&.
 387 .RE
 388 .PP
 389 \fBpre\-dle\-estimate\fR
 390 .RS 4
 391 Execute before the estimate command for the dle\&.
 392 .RE
 393 .PP
 394 \fBpre\-host\-estimate\fR
 395 .RS 4
 396 Execute before the estimate command for all dle for the client\&.
 397 .RE
 398 .PP
 399 \fBpost\-dle\-estimate\fR
 400 .RS 4
 401 Execute after the estimate command for the dle\&.
 402 .RE
 403 .PP
 404 \fBpost\-host\-estimate\fR
 405 .RS 4
 406 Execute after the estimate command for all dle for the client\&.
 407 .RE
 408 .PP
 409 \fBpre\-dle\-backup\fR
 410 .RS 4
 411 Execute before the backup command for the dle\&.
 412 .RE
 413 .PP
 414 \fBpost\-dle\-backup\fR
 415 .RS 4
 416 Execute after the backup command for the dle\&.
 417 .RE
 418 .PP
 419 \fBpre\-recover\fR
 420 .RS 4
 421 Execute before any level is recovered\&.
 422 .RE
 423 .PP
 424 \fBpost\-recover\fR
 425 .RS 4
 426 Execute after all levels are recovered\&.
 427 .RE
 428 .PP
 429 \fBpre\-level\-recover\fR
 430 .RS 4
 431 Execute before each level recovery\&.
 432 .RE
 433 .PP
 434 \fBpost\-level\-recover\fR
 435 .RS 4
 436 Execute after each level recovery\&.
 437 .RE
 438 .PP
 439 \fBinter\-level\-recover\fR
 440 .RS 4
 441 Execute between two levels of recovery\&.
 442 .RE
 443 .RE
 444 .PP
 445 \fBproperty\fR [\fBappend\fR] [\fBpriority\fR] \fIstring\fR \fIstring\fR+
 446 .RS 4
 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\&.
 448 \fBappend\fR
 449 keyword append the values to the list of values for that property\&.
 450 \fBpriority\fR
 451 keyword disallow the setting of that property on the server\&.
 452 .RE
 453 .SH "SEE ALSO"
 454 .PP
 455 \fBamanda\fR(8),
 456 \fBamanda.conf\fR(5),
 457 \fBamcrypt\fR(8),
 458 \fBaespipe\fR(1)
 459 .PP
 460 The Amanda Wiki:
 461 : http://wiki.zmanda.com/
 462 .SH "AUTHORS"
 463 .PP
 464 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
 465 .PP
 466 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>