2 .\" Author: James da Silva <jds@amanda.org>
3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
5 .\" Manual: System Administration Commands
6 .\" Source: Amanda 2.6.1
9 .TH "AMANDA" "8" "01/22/2009" "Amanda 2\&.6\&.1" "System Administration Commands"
10 .\" -----------------------------------------------------------------
11 .\" * (re)Define some macros
12 .\" -----------------------------------------------------------------
13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14 .\" toupper - uppercase a string (locale-aware)
15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22 .\" SH-xref - format a cross-reference to an SH section
23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33 .\" SH - level-one heading that works better for non-TTY output
34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
36 .\" put an extra blank line of space above the head in non-TTY output
43 .nr an-prevailing-indent \\n[IN]
47 .HTML-TAG ".NH \\n[an-level]"
49 .nr an-no-space-flag 1
51 \." make the size of the head bigger
56 .\" if n (TTY output), use uppercase
61 .\" if not n (not TTY), use normal case (not uppercase)
65 .\" if not n (not TTY), put a border/line under subheading
70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71 .\" SS - level-two heading that works better for non-TTY output
72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
77 .nr an-prevailing-indent \\n[IN]
82 .nr an-no-space-flag 1
85 \." make the size of the head bigger
91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
92 .\" BB/BE - put background/screen (filled box) around block of text
93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
106 .if "\\$2"adjust-for-leading-newline" \{\
114 .nr BW \\n(.lu-\\n(.i
117 .ie "\\$2"adjust-for-leading-newline" \{\
118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133 .\" BM/EM - put colored marker in margin next to block of text
134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
159 .\" -----------------------------------------------------------------
160 .\" * set default formatting
161 .\" -----------------------------------------------------------------
162 .\" disable hyphenation
164 .\" disable justification (adjust text to left margin only)
166 .\" -----------------------------------------------------------------
167 .\" * MAIN CONTENT STARTS HERE *
168 .\" -----------------------------------------------------------------
170 amanda \- The Open Source Backup Platform
173 This manual page gives an overview of the
175 commands and configuration files for quick reference\&.
180 commands\&. Each one has its own manual page\&. See them for all the gory details\&.
190 \fBamaddclient\fR(8),
245 \fBamcheckdump\fR(8),
267 \fBamcrypt-ossl-asym\fR(8),
278 \fBamcrypt-ossl\fR(8),
300 \fBamcryptsimple\fR(8),
344 \fBamfetchdump\fR(8),
498 \fBamserverconfig\fR(8),
586 \fBamzfs-sendrecv\fR(8),
597 \fBamzfs-snapshot\fR(8),
608 \fBscript-email\fR(8),
610 .SS "CONFIGURATION FILES"
620 \fBamanda.conf\fR(5),
631 \fBamanda-client.conf\fR(5),
665 \fBamanda-archive-format\fR(5),
677 \fBamanda-applications\fR(7),
688 \fBamanda-auth\fR(7),
699 \fBamanda-changers\fR(7),
710 \fBamanda-devices\fR(7),
721 \fBamanda-scripts\fR(7),
725 There are four user\-editable files that control the behavior of
731 \fBamanda-client.conf\fR(5), the main configuration files for the server and client, respectively\&. They contain parameters to customize
737 file, which lists hosts and disk partitions to back up\&.
739 Last is the seldom\-edited
741 file, which lists tapes that are currently active\&. These files are described in more detail in the following sections\&.
743 All files are stored in individual configuration directories, usually under
744 \FC/etc/amanda/\F[]\&. A site will often have more than one configuration\&. For example, it might have a
746 configuration for everyday backups and an
748 configuration for infrequent full archival backups\&. The configuration files would be stored under directories
749 \FC/etc/amanda/normal/\F[]
751 \FC/etc/amanda/archive/\F[], respectively\&. Part of the job of an
753 administrator is to create, populate and maintain these directories\&.
756 All log and database files generated by
758 go in corresponding directories somewhere\&. The exact location is controlled by entries in
759 \fBamanda.conf\fR(5)\&. A typical location would be under
760 \FC/var/adm/amanda\F[]\&. For the above example, the files might go in
761 \FC/var/adm/amanda/normal/\F[]
763 \FC/var/adm/amanda/archive/\F[]\&.
765 As log files are no longer needed (no longer contain relevant information),
767 cycles them out in various ways, depending on the type of file\&.
769 Detailed information about
771 runs are stored in dump logs \-\- files named
772 \fBamdump\&.\fR\fINN\fR
775 is a sequence number, with 1 being the most recent file\&.
777 rotates these files each run, keeping roughly the last
779 (see below) worth of them\&.
783 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
784 \fBlog\&.\fR\fIYYYYMMDDHHMMSS\&.NN\fR
787 is the datestamp of the start of the
793 is a sequence number started at 0\&. At the end of each
795 run, log files for runs whose tapes have been reused are renamed into a subdirectory of the main log directory (see the
797 parameter below) named
798 \fBoldlog\fR\&. It is up to the
800 administrator to remove them from this directory when desired\&.
802 Index (backup image catalogue) files older than the full dump matching the oldest backup image for a given client and disk are removed by
804 at the end of each run\&.
809 needs a file on the Samba server (which may or may not also be the tape server) named
810 \FC/etc/amandapass\F[]
811 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
812 \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:
814 //some\-pc/home normalpw
815 //another\-pc/disk otheruser%otherpw
818 With clear text passwords, this file should obviously be tightly protected\&. It only needs to be readable by the
819 \fIAmanda\fR\-user on the Samba server\&.
820 .SH "HOST & DISK EXPRESSION"
822 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\&.
824 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\&.
828 word separator for a host
833 word separator for a disk
848 match exactly one character except the separator
853 match zero or more characters except the separator
858 match zero or more characters including the separator
867 \FCfoo\&.hosta\&.org\F[], and
868 \FChoSTA\&.dOMAIna\&.ORG\F[]
886 \FChostb\F[], but not
895 \FCho\&.aina\&.org\F[]\&.
903 \FCho\&.aina\&.org\F[]\&.
911 \FCfoo\&.hosta\&.org\F[]\&.
930 (note dots:) \&.opt\&.
960 .SH "DATESTAMP EXPRESSION"
964 expression is a range expression where we only match the prefix\&. Leading ^ is removed\&. Trailing $ forces an exact match\&.
968 match all dates beginning with 20001212, 20001213 or 20001214
978 match all dates between 20001212 and 20001224
983 match all dates that start with 2000121 (20001210\-20001219)
988 match all dates that start with 2 (20000101\-29991231)
993 match all dates between 20000101\-20101231
1000 .SH "DUMP SPECIFICATIONS"
1002 A dump specification selects one or more dumps\&. It has the form
1003 \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\'\&.
1009 all dumps of client17
1014 All dumps on with datestamps matching 20080615
1019 All dumps of /var/www on host webserver
1022 webserver:/var/www@200806150317
1024 The dump of webserver with datestamp 200806150317
1029 All dumps of /var/www on any host
1031 .SH "CONFIGURATION OVERRIDE"
1033 Most commands allow the override of specific configuration options on the command line, using the
1035 option\&. This option has the form
1036 \-o\fIname\fR=\fIvalue\fR\&. An optional space is allowed after the
1037 \-o\&. Each configuration option should be specified in a separate command\-line option\&.
1041 is simply the name of the option, e\&.g\&.,
1044 amdump \-oruntapes=2
1046 For options in a named section of the configuration,
1049 \fISECTION\fR:\fIsection_name\fR:\fIname\fR, where
1051 is one of TAPETYPE, DUMPTYPE, HOLDINGDISK, or INTERFACE, and
1053 is the name of the tapetype, dumptype, holdingdisk, or interface\&. Examples:
1056 amdump \-o TAPETYPE:HP\-DAT:length=2000m
1057 amdump \-o DUMPTYPE:no\-compress:compress="server fast"
1058 amdump \-o HOLDINGDISK:hd1:use="\-100 mb"
1059 amdump \-o INTERFACE:local:use="2000 kbps"
1062 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:
1065 amdump \-o \'device\-property="PROPERTY_MAX_VOLUME_USAGE" "100000"\'
1068 Note that configuration overrides are not effective for tape changers, which supply a tapedev based on their own configuration\&. In order to override
1069 \fItapedev\fR, you must also disable any changer:
1072 amdump \-otapedev=/dev/nst1 \-otpchanger=\'\'
1076 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
1078 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>