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