3 .\" Author: James da Silva <jds@amanda.org>
4 .\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
6 .\" Manual: System Administration Commands
7 .\" Source: Amanda 3.1.0
10 .TH "AMANDA" "8" "06/01/2010" "Amanda 3\&.1\&.0" "System Administration Commands"
11 .\" -----------------------------------------------------------------
12 .\" * set default formatting
13 .\" -----------------------------------------------------------------
14 .\" disable hyphenation
16 .\" disable justification (adjust text to left margin only)
18 .\" -----------------------------------------------------------------
19 .\" * MAIN CONTENT STARTS HERE *
20 .\" -----------------------------------------------------------------
22 amanda \- The Open Source Backup Platform
25 This manual page gives an overview of the Amanda commands and configuration files for quick reference\&.
28 Here are all the Amanda commands\&. Each one has its own manual page\&. See them for all the gory details\&.
104 \fBamcheckdump\fR(8),
126 \fBamcrypt-ossl-asym\fR(8),
137 \fBamcrypt-ossl\fR(8),
159 \fBamcryptsimple\fR(8),
192 \fBamfetchdump\fR(8),
357 \fBamserverconfig\fR(8),
456 \fBamzfs-sendrecv\fR(8),
467 \fBamzfs-snapshot\fR(8),
478 \fBscript-email\fR(8),
480 .SS "CONFIGURATION FILES"
490 \fBamanda.conf\fR(5),
501 \fBamanda-client.conf\fR(5),
535 \fBamanda-archive-format\fR(5),
547 \fBamanda-applications\fR(7),
558 \fBamanda-auth\fR(7),
569 \fBamanda-changers\fR(7),
580 \fBamanda-compatibility\fR(7),
591 \fBamanda-devices\fR(7),
602 \fBamanda-scripts\fR(7),
613 \fBamanda-taperscan\fR(7),
617 There are four user\-editable files that control the behavior of Amanda\&.
622 \fBamanda-client.conf\fR(5), the main configuration files for the server and client, respectively\&. They contain parameters to customize Amanda for the site\&.
626 file, which lists hosts and disk partitions to back up\&.
628 Last is the seldom\-edited
630 file, which lists tapes that are currently active\&. These files are described in more detail in the following sections\&.
632 All configuration files are stored in individual configuration directories, usually under
633 /etc/amanda/\&. A site will often have more than one configuration\&. For example, it might have a
635 configuration for everyday backups and an
637 configuration for infrequent full archival backups\&. The configuration files would be stored under directories
640 /etc/amanda/archive/, respectively\&. Part of the job of an Amanda administrator is to create, populate and maintain these directories\&.
642 Most Amanda applications take a "config" parameter; this is generally the (unqualified) name of the configuration directory, e\&.g\&.,
643 normal\&. If the parameter is
645 (dot), the current directory is used\&. This feature is present for backward compatibility, but is not commonly used\&.
648 All log and database files generated by Amanda go in corresponding directories somewhere\&. The exact location is controlled by entries in
649 \fBamanda.conf\fR(5)\&. A typical location would be under
650 /var/adm/amanda\&. For the above example, the files might go in
651 /var/adm/amanda/normal/
653 /var/adm/amanda/archive/\&.
655 As log files are no longer needed (no longer contain relevant information), Amanda cycles them out in various ways, depending on the type of file\&.
657 Detailed information about
659 runs are stored in dump logs \-\- files named
660 \fBamdump\&.\fR\fINN\fR
663 is a sequence number, with 1 being the most recent file\&.
665 rotates these files each run, keeping roughly the last
667 (see below) worth of them\&.
671 to generate the mail summary is the trace log\&. This file constitutes the "catalog" describing the data on the tapes written in a run\&. It is named
672 \fBlog\&.\fR\fIYYYYMMDDHHMMSS\&.NN\fR
675 is the datestamp of the start of the
681 is a sequence number started at 0\&. At the end of each
683 run, log files for runs whose tapes have been reused are renamed into a subdirectory of the main log directory (see the
685 parameter below) named
686 \fBoldlog\fR\&. It is up to the Amanda administrator to remove them from this directory when desired\&.
688 Index (backup image catalogue) files older than the full dump matching the oldest backup image for a given client and disk are removed by
690 at the end of each run\&.
693 For Samba access, Amanda needs a file on the Samba server (which may or may not also be the tape server) named
695 with share names, (clear text) passwords and (optional) domain names, in that order, one per line, whitespace separated\&. By default, the user used to connect to the PC is the same for all PC\'s and is compiled into Amanda\&. It may be changed on a host by host basis by listing it first in the password field followed by a percent sign and then the password\&. For instance:
697 //some\-pc/home normalpw
698 //another\-pc/disk otheruser%otherpw
701 With clear text passwords, this file should obviously be tightly protected\&. It only needs to be readable by the Amanda\-user on the Samba server\&.
702 .SH "HOST & DISK EXPRESSION"
704 All host and disk arguments to programs are special expressions\&. The command applies to all DLEs that match the arguments\&. This section describes the matcher\&.
706 The matcher matches by word, each word is a glob expression, words are separated by the separator \'\&.\' for host and \'/\' for disk\&. You can anchor the expression at left with a \'^\'\&. You can anchor the expression at right with a \'$\'\&. The matcher is case insensitive for host but is case sensitive for disk\&. A match succeeds if all words in your expression match contiguous words in the host or disk\&.
708 If the disk is a UNC ("\e\ewindows\eshare") then all \'\e\' are converted to \'/\' before the match\&. Using \'\e\' is complicated because of the extra quoting required by the shell and amanda\&. It\'s easier to use \'/\' because it require less quoting ("//windows/share")
712 word separator for a host
717 word separator for a disk
722 word separator for a UNC disk
737 match exactly one character except the separator
742 match zero or more characters except the separator
747 match zero or more characters including the separator
752 match a single character, namely any of the characters enclosed by the brackets\&.
757 match a single character, namely any characters that is not enclosed by the brackets\&.
760 The shell interpret some of these characters, they must be escaped by a backslash \'\e\' and/or the expression must be enclosed in simple or double quote\&.
768 foo\&.hosta\&.org, and
769 hoSTA\&.dOMAIna\&.ORG
831 (note dots:) \&.opt\&.
867 \e\ewindows2\eshare\&.
875 \e\ewindows\eshare2\&.
881 \e\ewindows\eshare\&.
883 .SH "DATESTAMP EXPRESSION"
887 expression is a range expression where we only match the prefix\&. Leading ^ is removed\&. Trailing $ forces an exact match\&.
891 match all dates beginning with 20001212, 20001213 or 20001214
901 match all dates between 20001212 and 20001224
906 match all dates that start with 2000121 (20001210\-20001219)
911 match all dates that start with 2 (20000101\-29991231)
916 match all dates between 20000101\-20101231
923 .SH "DUMP SPECIFICATIONS"
925 A dump specification selects one or more dumps\&. It has the form
926 \fI[host][:disk][@datestamp]\fR, where each component is a pattern as described above\&. If a component is missing, it is treated as a wildcard\&. The characters \':\', \'@\', and \'\e\' may be escaped within any component by preceding them with a \'\e\'\&.
932 all dumps of client17
937 All dumps on with datestamps matching 20080615
942 All dumps of /var/www on host webserver
945 webserver:/var/www@200806150317
947 The dump of webserver with datestamp 200806150317
952 All dumps of /var/www on any host
954 .SH "CONFIGURATION OVERRIDE"
956 Most commands allow the override of specific configuration options on the command line, using the
958 option\&. This option has the form
959 \-o\fIname\fR=\fIvalue\fR\&. An optional space is allowed after the
960 \-o\&. Each configuration option should be specified in a separate command\-line option\&.
964 is simply the name of the option, e\&.g\&.,
969 For options in a named section of the configuration,
972 \fISECTION\fR:\fIsection_name\fR:\fIname\fR, where
974 is one of TAPETYPE, DUMPTYPE, HOLDINGDISK, or INTERFACE, and
976 is the name of the tapetype, dumptype, holdingdisk, or interface\&. Examples:
979 amdump \-o TAPETYPE:HP\-DAT:length=2000m
980 amdump \-o DUMPTYPE:no\-compress:compress="server fast"
981 amdump \-o HOLDINGDISK:hd1:use="\-100 mb"
982 amdump \-o INTERFACE:local:use="2000 kbps"
985 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:
988 amdump \-o \'device\-property="PROPERTY_MAX_VOLUME_USAGE" "100000"\'
991 Note that configuration overrides are not effective for tape changers, which supply a tapedev based on their own configuration\&. In order to override
992 \fItapedev\fR, you must also disable any changer:
995 amdump \-otapedev=/dev/nst1 \-otpchanger=\'\'
999 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
1001 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>