git.gag.com Git - debian/amanda/blob - man/amanda.8

   1 '\" t
   2 .\"     Title: amanda
   3 .\"    Author: James da Silva <jds@amanda.org>
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
   5 .\"      Date: 10/18/2010
   6 .\"    Manual: System Administration Commands
   7 .\"    Source: Amanda 3.2.0
   8 .\"  Language: English
   9 .\"
  10 .TH "AMANDA" "8" "10/18/2010" "Amanda 3\&.2\&.0" "System Administration Commands"
  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 \- The Open Source Backup Platform
  23 .SH "DESCRIPTION"
  24 .PP
  25 This manual page gives an overview of the Amanda commands and configuration files for quick reference\&.
  26 .SS "COMMANDS"
  27 .PP
  28 Here are all the Amanda commands\&. Each one has its own manual page\&. See them for all the gory details\&.
  29 .sp
  30 .RS 4
  31 .ie n \{\
  32 \h'-04'\(bu\h'+03'\c
  33 .\}
  34 .el \{\
  35 .sp -1
  36 .IP \(bu 2.3
  37 .\}
  38 \fBamaddclient\fR(8),
  39 .RE
  40 .sp
  41 .RS 4
  42 .ie n \{\
  43 \h'-04'\(bu\h'+03'\c
  44 .\}
  45 .el \{\
  46 .sp -1
  47 .IP \(bu 2.3
  48 .\}
  49 \fBamadmin\fR(8),
  50 .RE
  51 .sp
  52 .RS 4
  53 .ie n \{\
  54 \h'-04'\(bu\h'+03'\c
  55 .\}
  56 .el \{\
  57 .sp -1
  58 .IP \(bu 2.3
  59 .\}
  60 \fBamaespipe\fR(8),
  61 .RE
  62 .sp
  63 .RS 4
  64 .ie n \{\
  65 \h'-04'\(bu\h'+03'\c
  66 .\}
  67 .el \{\
  68 .sp -1
  69 .IP \(bu 2.3
  70 .\}
  71 \fBamarchiver\fR(8),
  72 .RE
  73 .sp
  74 .RS 4
  75 .ie n \{\
  76 \h'-04'\(bu\h'+03'\c
  77 .\}
  78 .el \{\
  79 .sp -1
  80 .IP \(bu 2.3
  81 .\}
  82 \fBamcheck\fR(8),
  83 .RE
  84 .sp
  85 .RS 4
  86 .ie n \{\
  87 \h'-04'\(bu\h'+03'\c
  88 .\}
  89 .el \{\
  90 .sp -1
  91 .IP \(bu 2.3
  92 .\}
  93 \fBamcheckdb\fR(8),
  94 .RE
  95 .sp
  96 .RS 4
  97 .ie n \{\
  98 \h'-04'\(bu\h'+03'\c
  99 .\}
 100 .el \{\
 101 .sp -1
 102 .IP \(bu 2.3
 103 .\}
 104 \fBamcheckdump\fR(8),
 105 .RE
 106 .sp
 107 .RS 4
 108 .ie n \{\
 109 \h'-04'\(bu\h'+03'\c
 110 .\}
 111 .el \{\
 112 .sp -1
 113 .IP \(bu 2.3
 114 .\}
 115 \fBamcleanup\fR(8),
 116 .RE
 117 .sp
 118 .RS 4
 119 .ie n \{\
 120 \h'-04'\(bu\h'+03'\c
 121 .\}
 122 .el \{\
 123 .sp -1
 124 .IP \(bu 2.3
 125 .\}
 126 \fBamcrypt-ossl-asym\fR(8),
 127 .RE
 128 .sp
 129 .RS 4
 130 .ie n \{\
 131 \h'-04'\(bu\h'+03'\c
 132 .\}
 133 .el \{\
 134 .sp -1
 135 .IP \(bu 2.3
 136 .\}
 137 \fBamcrypt-ossl\fR(8),
 138 .RE
 139 .sp
 140 .RS 4
 141 .ie n \{\
 142 \h'-04'\(bu\h'+03'\c
 143 .\}
 144 .el \{\
 145 .sp -1
 146 .IP \(bu 2.3
 147 .\}
 148 \fBamcrypt\fR(8),
 149 .RE
 150 .sp
 151 .RS 4
 152 .ie n \{\
 153 \h'-04'\(bu\h'+03'\c
 154 .\}
 155 .el \{\
 156 .sp -1
 157 .IP \(bu 2.3
 158 .\}
 159 \fBamcryptsimple\fR(8),
 160 .RE
 161 .sp
 162 .RS 4
 163 .ie n \{\
 164 \h'-04'\(bu\h'+03'\c
 165 .\}
 166 .el \{\
 167 .sp -1
 168 .IP \(bu 2.3
 169 .\}
 170 \fBamdevcheck\fR(8),
 171 .RE
 172 .sp
 173 .RS 4
 174 .ie n \{\
 175 \h'-04'\(bu\h'+03'\c
 176 .\}
 177 .el \{\
 178 .sp -1
 179 .IP \(bu 2.3
 180 .\}
 181 \fBamdump\fR(8),
 182 .RE
 183 .sp
 184 .RS 4
 185 .ie n \{\
 186 \h'-04'\(bu\h'+03'\c
 187 .\}
 188 .el \{\
 189 .sp -1
 190 .IP \(bu 2.3
 191 .\}
 192 \fBamfetchdump\fR(8),
 193 .RE
 194 .sp
 195 .RS 4
 196 .ie n \{\
 197 \h'-04'\(bu\h'+03'\c
 198 .\}
 199 .el \{\
 200 .sp -1
 201 .IP \(bu 2.3
 202 .\}
 203 \fBamflush\fR(8),
 204 .RE
 205 .sp
 206 .RS 4
 207 .ie n \{\
 208 \h'-04'\(bu\h'+03'\c
 209 .\}
 210 .el \{\
 211 .sp -1
 212 .IP \(bu 2.3
 213 .\}
 214 \fBamgetconf\fR(8),
 215 .RE
 216 .sp
 217 .RS 4
 218 .ie n \{\
 219 \h'-04'\(bu\h'+03'\c
 220 .\}
 221 .el \{\
 222 .sp -1
 223 .IP \(bu 2.3
 224 .\}
 225 \fBamgpgcrypt\fR(8),
 226 .RE
 227 .sp
 228 .RS 4
 229 .ie n \{\
 230 \h'-04'\(bu\h'+03'\c
 231 .\}
 232 .el \{\
 233 .sp -1
 234 .IP \(bu 2.3
 235 .\}
 236 \fBamgtar\fR(8),
 237 .RE
 238 .sp
 239 .RS 4
 240 .ie n \{\
 241 \h'-04'\(bu\h'+03'\c
 242 .\}
 243 .el \{\
 244 .sp -1
 245 .IP \(bu 2.3
 246 .\}
 247 \fBamlabel\fR(8),
 248 .RE
 249 .sp
 250 .RS 4
 251 .ie n \{\
 252 \h'-04'\(bu\h'+03'\c
 253 .\}
 254 .el \{\
 255 .sp -1
 256 .IP \(bu 2.3
 257 .\}
 258 \fBamoverview\fR(8),
 259 .RE
 260 .sp
 261 .RS 4
 262 .ie n \{\
 263 \h'-04'\(bu\h'+03'\c
 264 .\}
 265 .el \{\
 266 .sp -1
 267 .IP \(bu 2.3
 268 .\}
 269 \fBampgsql\fR(8),
 270 .RE
 271 .sp
 272 .RS 4
 273 .ie n \{\
 274 \h'-04'\(bu\h'+03'\c
 275 .\}
 276 .el \{\
 277 .sp -1
 278 .IP \(bu 2.3
 279 .\}
 280 \fBamplot\fR(8),
 281 .RE
 282 .sp
 283 .RS 4
 284 .ie n \{\
 285 \h'-04'\(bu\h'+03'\c
 286 .\}
 287 .el \{\
 288 .sp -1
 289 .IP \(bu 2.3
 290 .\}
 291 \fBamraw\fR(8),
 292 .RE
 293 .sp
 294 .RS 4
 295 .ie n \{\
 296 \h'-04'\(bu\h'+03'\c
 297 .\}
 298 .el \{\
 299 .sp -1
 300 .IP \(bu 2.3
 301 .\}
 302 \fBamrecover\fR(8),
 303 .RE
 304 .sp
 305 .RS 4
 306 .ie n \{\
 307 \h'-04'\(bu\h'+03'\c
 308 .\}
 309 .el \{\
 310 .sp -1
 311 .IP \(bu 2.3
 312 .\}
 313 \fBamreport\fR(8),
 314 .RE
 315 .sp
 316 .RS 4
 317 .ie n \{\
 318 \h'-04'\(bu\h'+03'\c
 319 .\}
 320 .el \{\
 321 .sp -1
 322 .IP \(bu 2.3
 323 .\}
 324 \fBamrestore\fR(8),
 325 .RE
 326 .sp
 327 .RS 4
 328 .ie n \{\
 329 \h'-04'\(bu\h'+03'\c
 330 .\}
 331 .el \{\
 332 .sp -1
 333 .IP \(bu 2.3
 334 .\}
 335 \fBamrmtape\fR(8),
 336 .RE
 337 .sp
 338 .RS 4
 339 .ie n \{\
 340 \h'-04'\(bu\h'+03'\c
 341 .\}
 342 .el \{\
 343 .sp -1
 344 .IP \(bu 2.3
 345 .\}
 346 \fBamsamba\fR(8),
 347 .RE
 348 .sp
 349 .RS 4
 350 .ie n \{\
 351 \h'-04'\(bu\h'+03'\c
 352 .\}
 353 .el \{\
 354 .sp -1
 355 .IP \(bu 2.3
 356 .\}
 357 \fBamserverconfig\fR(8),
 358 .RE
 359 .sp
 360 .RS 4
 361 .ie n \{\
 362 \h'-04'\(bu\h'+03'\c
 363 .\}
 364 .el \{\
 365 .sp -1
 366 .IP \(bu 2.3
 367 .\}
 368 \fBamservice\fR(8),
 369 .RE
 370 .sp
 371 .RS 4
 372 .ie n \{\
 373 \h'-04'\(bu\h'+03'\c
 374 .\}
 375 .el \{\
 376 .sp -1
 377 .IP \(bu 2.3
 378 .\}
 379 \fBamstar\fR(8),
 380 .RE
 381 .sp
 382 .RS 4
 383 .ie n \{\
 384 \h'-04'\(bu\h'+03'\c
 385 .\}
 386 .el \{\
 387 .sp -1
 388 .IP \(bu 2.3
 389 .\}
 390 \fBamstatus\fR(8),
 391 .RE
 392 .sp
 393 .RS 4
 394 .ie n \{\
 395 \h'-04'\(bu\h'+03'\c
 396 .\}
 397 .el \{\
 398 .sp -1
 399 .IP \(bu 2.3
 400 .\}
 401 \fBamsuntar\fR(8),
 402 .RE
 403 .sp
 404 .RS 4
 405 .ie n \{\
 406 \h'-04'\(bu\h'+03'\c
 407 .\}
 408 .el \{\
 409 .sp -1
 410 .IP \(bu 2.3
 411 .\}
 412 \fBamtape\fR(8),
 413 .RE
 414 .sp
 415 .RS 4
 416 .ie n \{\
 417 \h'-04'\(bu\h'+03'\c
 418 .\}
 419 .el \{\
 420 .sp -1
 421 .IP \(bu 2.3
 422 .\}
 423 \fBamtapetype\fR(8),
 424 .RE
 425 .sp
 426 .RS 4
 427 .ie n \{\
 428 \h'-04'\(bu\h'+03'\c
 429 .\}
 430 .el \{\
 431 .sp -1
 432 .IP \(bu 2.3
 433 .\}
 434 \fBamtoc\fR(8),
 435 .RE
 436 .sp
 437 .RS 4
 438 .ie n \{\
 439 \h'-04'\(bu\h'+03'\c
 440 .\}
 441 .el \{\
 442 .sp -1
 443 .IP \(bu 2.3
 444 .\}
 445 \fBamvault\fR(8),
 446 .RE
 447 .sp
 448 .RS 4
 449 .ie n \{\
 450 \h'-04'\(bu\h'+03'\c
 451 .\}
 452 .el \{\
 453 .sp -1
 454 .IP \(bu 2.3
 455 .\}
 456 \fBamzfs-sendrecv\fR(8),
 457 .RE
 458 .sp
 459 .RS 4
 460 .ie n \{\
 461 \h'-04'\(bu\h'+03'\c
 462 .\}
 463 .el \{\
 464 .sp -1
 465 .IP \(bu 2.3
 466 .\}
 467 \fBamzfs-snapshot\fR(8),
 468 .RE
 469 .sp
 470 .RS 4
 471 .ie n \{\
 472 \h'-04'\(bu\h'+03'\c
 473 .\}
 474 .el \{\
 475 .sp -1
 476 .IP \(bu 2.3
 477 .\}
 478 \fBscript-email\fR(8),
 479 .RE
 480 .SS "CONFIGURATION FILES"
 481 .sp
 482 .RS 4
 483 .ie n \{\
 484 \h'-04'\(bu\h'+03'\c
 485 .\}
 486 .el \{\
 487 .sp -1
 488 .IP \(bu 2.3
 489 .\}
 490 \fBamanda.conf\fR(5),
 491 .RE
 492 .sp
 493 .RS 4
 494 .ie n \{\
 495 \h'-04'\(bu\h'+03'\c
 496 .\}
 497 .el \{\
 498 .sp -1
 499 .IP \(bu 2.3
 500 .\}
 501 \fBamanda-client.conf\fR(5),
 502 .RE
 503 .sp
 504 .RS 4
 505 .ie n \{\
 506 \h'-04'\(bu\h'+03'\c
 507 .\}
 508 .el \{\
 509 .sp -1
 510 .IP \(bu 2.3
 511 .\}
 512 \fBdisklist\fR(5),
 513 .RE
 514 .sp
 515 .RS 4
 516 .ie n \{\
 517 \h'-04'\(bu\h'+03'\c
 518 .\}
 519 .el \{\
 520 .sp -1
 521 .IP \(bu 2.3
 522 .\}
 523 \fBtapelist\fR(5),
 524 .RE
 525 .SS "DATA FORMATS"
 526 .sp
 527 .RS 4
 528 .ie n \{\
 529 \h'-04'\(bu\h'+03'\c
 530 .\}
 531 .el \{\
 532 .sp -1
 533 .IP \(bu 2.3
 534 .\}
 535 \fBamanda-archive-format\fR(5),
 536 .RE
 537 .SS "CONCEPTS"
 538 .sp
 539 .RS 4
 540 .ie n \{\
 541 \h'-04'\(bu\h'+03'\c
 542 .\}
 543 .el \{\
 544 .sp -1
 545 .IP \(bu 2.3
 546 .\}
 547 \fBamanda-applications\fR(7),
 548 .RE
 549 .sp
 550 .RS 4
 551 .ie n \{\
 552 \h'-04'\(bu\h'+03'\c
 553 .\}
 554 .el \{\
 555 .sp -1
 556 .IP \(bu 2.3
 557 .\}
 558 \fBamanda-auth\fR(7),
 559 .RE
 560 .sp
 561 .RS 4
 562 .ie n \{\
 563 \h'-04'\(bu\h'+03'\c
 564 .\}
 565 .el \{\
 566 .sp -1
 567 .IP \(bu 2.3
 568 .\}
 569 \fBamanda-changers\fR(7),
 570 .RE
 571 .sp
 572 .RS 4
 573 .ie n \{\
 574 \h'-04'\(bu\h'+03'\c
 575 .\}
 576 .el \{\
 577 .sp -1
 578 .IP \(bu 2.3
 579 .\}
 580 \fBamanda-compatibility\fR(7),
 581 .RE
 582 .sp
 583 .RS 4
 584 .ie n \{\
 585 \h'-04'\(bu\h'+03'\c
 586 .\}
 587 .el \{\
 588 .sp -1
 589 .IP \(bu 2.3
 590 .\}
 591 \fBamanda-devices\fR(7),
 592 .RE
 593 .sp
 594 .RS 4
 595 .ie n \{\
 596 \h'-04'\(bu\h'+03'\c
 597 .\}
 598 .el \{\
 599 .sp -1
 600 .IP \(bu 2.3
 601 .\}
 602 \fBamanda-match\fR(7),
 603 .RE
 604 .sp
 605 .RS 4
 606 .ie n \{\
 607 \h'-04'\(bu\h'+03'\c
 608 .\}
 609 .el \{\
 610 .sp -1
 611 .IP \(bu 2.3
 612 .\}
 613 \fBamanda-scripts\fR(7),
 614 .RE
 615 .sp
 616 .RS 4
 617 .ie n \{\
 618 \h'-04'\(bu\h'+03'\c
 619 .\}
 620 .el \{\
 621 .sp -1
 622 .IP \(bu 2.3
 623 .\}
 624 \fBamanda-taperscan\fR(7),
 625 .RE
 626 .SH "CONFIGURATION FILES"
 627 .PP
 628 There are four user\-editable files that control the behavior of Amanda\&.
 629 .PP
 630 The first two are
 631 \fBamanda.conf\fR(5)
 632 and
 633 \fBamanda-client.conf\fR(5), the main configuration files for the server and client, respectively\&. They contain parameters to customize Amanda for the site\&.
 634 .PP
 635 Next is the
 636 \fBdisklist\fR(5)
 637 file, which lists hosts and disk partitions to back up\&.
 638 .PP
 639 Last is the seldom\-edited
 640 \fBtapelist\fR(5)
 641 file, which lists tapes that are currently active\&. These files are described in more detail in the following sections\&.
 642 .PP
 643 All configuration files are stored in individual configuration directories, usually under
 644 /etc/amanda/\&. A site will often have more than one configuration\&. For example, it might have a
 645 \fInormal\fR
 646 configuration for everyday backups and an
 647 \fIarchive\fR
 648 configuration for infrequent full archival backups\&. The configuration files would be stored under directories
 649 /etc/amanda/normal/
 650 and
 651 /etc/amanda/archive/, respectively\&. Part of the job of an Amanda administrator is to create, populate and maintain these directories\&.
 652 .PP
 653 Most Amanda applications take a "config" parameter; this is generally the (unqualified) name of the configuration directory, e\&.g\&.,
 654 normal\&. If the parameter is
 655 \&.
 656 (dot), the current directory is used\&. This feature is present for backward compatibility, but is not commonly used\&.
 657 .SS "Configuration Override"
 658 .PP
 659 Most commands allow the override of specific configuration options on the command line, using the
 660 \-o
 661 option\&. This option has the form
 662 \-o\fIname\fR=\fIvalue\fR\&. An optional space is allowed after the
 663 \-o\&. Each configuration option should be specified in a separate command\-line option\&.
 664 .PP
 665 For global options,
 666 \fIname\fR
 667 is simply the name of the option, e\&.g\&.,
 668 .sp
 669 .nf
 670 amdump \-oruntapes=2
 671 .fi
 672 For options in a named section of the configuration,
 673 \fIname\fR
 674 has the form
 675 \fISECTION\fR:\fIsection_name\fR:\fIname\fR, where
 676 \fISECTION\fR
 677 is one of TAPETYPE, DUMPTYPE, HOLDINGDISK, or INTERFACE, and
 678 \fIsection_name\fR
 679 is the name of the tapetype, dumptype, holdingdisk, or interface\&. Examples:
 680 .sp
 681 .nf
 682 amdump \-o TAPETYPE:HP\-DAT:length=2000m
 683 amdump \-o DUMPTYPE:no\-compress:compress="server fast"
 684 amdump \-o HOLDINGDISK:hd1:use="\-100 mb"
 685 amdump \-o INTERFACE:local:use="2000 kbps"
 686 .fi
 687 .PP
 688 When overriding device properties, one must carefully quote the command line to simulate the syntax of real configuration files\&. The following example should serve as a guide:
 689 .sp
 690 .nf
 691 amdump \-o \'device\-property="PROPERTY_MAX_VOLUME_USAGE" "100000"\'
 692 .fi
 693 .PP
 694 Note that configuration overrides are not effective for tape changers, which supply a tapedev based on their own configuration\&. In order to override
 695 \fItapedev\fR, you must also disable any changer:
 696 .sp
 697 .nf
 698 amdump \-otapedev=/dev/nst1 \-otpchanger=\'\'
 699 .fi
 700 .SH "AUTHORS"
 701 .PP
 702 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
 703 .PP
 704 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>