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