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 2.6.1p1
10 .TH "AMANDA" "8" "04/10/2009" "Amanda 2\&.6\&.1p1" "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
27 commands and configuration files for quick reference\&.
32 commands\&. Each one has its own manual page\&. See them for all the gory details\&.
119 \fBamcrypt-ossl-asym\fR(8),
130 \fBamcrypt-ossl\fR(8),
152 \fBamcryptsimple\fR(8),
196 \fBamfetchdump\fR(8),
350 \fBamserverconfig\fR(8),
438 \fBamzfs-sendrecv\fR(8),
449 \fBamzfs-snapshot\fR(8),
460 \fBscript-email\fR(8),
462 .SS "CONFIGURATION FILES"
472 \fBamanda.conf\fR(5),
483 \fBamanda-client.conf\fR(5),
517 \fBamanda-archive-format\fR(5),
529 \fBamanda-applications\fR(7),
540 \fBamanda-auth\fR(7),
551 \fBamanda-changers\fR(7),
562 \fBamanda-devices\fR(7),
573 \fBamanda-scripts\fR(7),
577 There are four user\-editable files that control the behavior of
583 \fBamanda-client.conf\fR(5), the main configuration files for the server and client, respectively\&. They contain parameters to customize
589 file, which lists hosts and disk partitions to back up\&.
591 Last is the seldom\-edited
593 file, which lists tapes that are currently active\&. These files are described in more detail in the following sections\&.
595 All files are stored in individual configuration directories, usually under
596 /etc/amanda/\&. A site will often have more than one configuration\&. For example, it might have a
598 configuration for everyday backups and an
600 configuration for infrequent full archival backups\&. The configuration files would be stored under directories
603 /etc/amanda/archive/, respectively\&. Part of the job of an
605 administrator is to create, populate and maintain these directories\&.
608 All log and database files generated by
610 go in corresponding directories somewhere\&. The exact location is controlled by entries in
611 \fBamanda.conf\fR(5)\&. A typical location would be under
612 /var/adm/amanda\&. For the above example, the files might go in
613 /var/adm/amanda/normal/
615 /var/adm/amanda/archive/\&.
617 As log files are no longer needed (no longer contain relevant information),
619 cycles them out in various ways, depending on the type of file\&.
621 Detailed information about
623 runs are stored in dump logs \-\- files named
624 \fBamdump\&.\fR\fINN\fR
627 is a sequence number, with 1 being the most recent file\&.
629 rotates these files each run, keeping roughly the last
631 (see below) worth of them\&.
635 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
636 \fBlog\&.\fR\fIYYYYMMDDHHMMSS\&.NN\fR
639 is the datestamp of the start of the
645 is a sequence number started at 0\&. At the end of each
647 run, log files for runs whose tapes have been reused are renamed into a subdirectory of the main log directory (see the
649 parameter below) named
650 \fBoldlog\fR\&. It is up to the
652 administrator to remove them from this directory when desired\&.
654 Index (backup image catalogue) files older than the full dump matching the oldest backup image for a given client and disk are removed by
656 at the end of each run\&.
661 needs a file on the Samba server (which may or may not also be the tape server) named
663 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
664 \fIAmanda\fR\&. 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:
666 //some\-pc/home normalpw
667 //another\-pc/disk otheruser%otherpw
670 With clear text passwords, this file should obviously be tightly protected\&. It only needs to be readable by the
671 \fIAmanda\fR\-user on the Samba server\&.
672 .SH "HOST & DISK EXPRESSION"
674 All host and disk arguments to programs are special expressions\&. The command applies to all disks that match your arguments\&. This section describes the matcher\&.
676 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\&.
680 word separator for a host
685 word separator for a disk
700 match exactly one character except the separator
705 match zero or more characters except the separator
710 match zero or more characters including the separator
719 foo\&.hosta\&.org, and
720 hoSTA\&.dOMAIna\&.ORG
782 (note dots:) \&.opt\&.
812 .SH "DATESTAMP EXPRESSION"
816 expression is a range expression where we only match the prefix\&. Leading ^ is removed\&. Trailing $ forces an exact match\&.
820 match all dates beginning with 20001212, 20001213 or 20001214
830 match all dates between 20001212 and 20001224
835 match all dates that start with 2000121 (20001210\-20001219)
840 match all dates that start with 2 (20000101\-29991231)
845 match all dates between 20000101\-20101231
852 .SH "DUMP SPECIFICATIONS"
854 A dump specification selects one or more dumps\&. It has the form
855 \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\'\&.
861 all dumps of client17
866 All dumps on with datestamps matching 20080615
871 All dumps of /var/www on host webserver
874 webserver:/var/www@200806150317
876 The dump of webserver with datestamp 200806150317
881 All dumps of /var/www on any host
883 .SH "CONFIGURATION OVERRIDE"
885 Most commands allow the override of specific configuration options on the command line, using the
887 option\&. This option has the form
888 \-o\fIname\fR=\fIvalue\fR\&. An optional space is allowed after the
889 \-o\&. Each configuration option should be specified in a separate command\-line option\&.
893 is simply the name of the option, e\&.g\&.,
898 For options in a named section of the configuration,
901 \fISECTION\fR:\fIsection_name\fR:\fIname\fR, where
903 is one of TAPETYPE, DUMPTYPE, HOLDINGDISK, or INTERFACE, and
905 is the name of the tapetype, dumptype, holdingdisk, or interface\&. Examples:
908 amdump \-o TAPETYPE:HP\-DAT:length=2000m
909 amdump \-o DUMPTYPE:no\-compress:compress="server fast"
910 amdump \-o HOLDINGDISK:hd1:use="\-100 mb"
911 amdump \-o INTERFACE:local:use="2000 kbps"
914 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:
917 amdump \-o \'device\-property="PROPERTY_MAX_VOLUME_USAGE" "100000"\'
920 Note that configuration overrides are not effective for tape changers, which supply a tapedev based on their own configuration\&. In order to override
921 \fItapedev\fR, you must also disable any changer:
924 amdump \-otapedev=/dev/nst1 \-otpchanger=\'\'
928 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
930 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>