Imported Upstream version 2.5.1
[debian/amanda] / docs / amanda.8.txt
index 1deec2631f1eb0ba48931c68d1862031ab89946a..6572c6294589e27fc7cd23c9a3583a936009f90b 100644 (file)
@@ -1,6 +1,6 @@
 
                                amanda
-Prev  Chapter 35. The AMANDA Manual Pages.  Next
+Prev  Chapter 36. The Amanda Manual Pages.  Next
 
 -------------------------------------------------------------------------------
 
@@ -14,8 +14,10 @@ amadmin config command [options]
 amcheck [options] config
 amcheckdb config
 amcleanup config
+amcrypt
 amdd [options]
 amdump config
+amaespipe
 amflush [-f ] config
 amgetconf [config] parameter
 amlabel config label [ slot slot ]
@@ -25,6 +27,7 @@ amplot [options] amdump-files
 amrecover [config] [options]
 amreport [config] [options]
 amrestore [options] tapedevice [ hostname [diskname]]
+amfetchdump [options] config [ hostname [ diskname [ date [level]]]]
 amrmtape [options] config label
 amstatus config [options]
 amtape config command [options]
@@ -35,15 +38,15 @@ amverifyrun config
 
 DESCRIPTION
 
-AMANDA is the "Advanced Maryland Automatic Network Disk Archiver". This manual
-page gives an overview of the AMANDA commands and configuration files for quick
+Amanda is the "Advanced Maryland Automatic Network Disk Archiver". This manual
+page gives an overview of the Amanda commands and configuration files for quick
 reference.
-Here are all the AMANDA commands. Each one has its own manual page. See them
+Here are all the Amanda commands. Each one has its own manual page. See them
 for all the gory details.
 
 
   amdump
-      Take care of automatic AMANDA backups. This is normally executed by cron
+      Take care of automatic Amanda backups. This is normally executed by cron
       on a computer called the tape server host and requests backups of file
       systems located on backup clients. Amdump backs up all disks in the
       disklist file (discussed below) to tape or, if there is a problem, to a
@@ -62,18 +65,24 @@ for all the gory details.
       server host crashed while amdump was running.
 
   amrecover
-      Provides an interactive interface to browse the AMANDA index files
+      Provides an interactive interface to browse the Amanda index files
       (backup image catalogues) and select which tapes to recover files from.
       It can also run amrestore and a restore program (e.g. tar) to actually
       recover the files.
 
   amrestore
-      Read an AMANDA tape, searching for requested backups. Amrestore is
+      Read an Amanda tape, searching for requested backups. Amrestore is
       suitable for everything from interactive restores of single files to a
       full restore of all partitions on a failed disk.
 
+  amfetchdump
+      Performs Amanda tape restoration, similar to amrestore. Additional
+      capabilities include "hands-off" searching of multiple tapes, automatic
+      retrieval of specific dump files based on dump logs, and assembly of
+      tape-spanning split dump files.
+
   amlabel
-      Write an AMANDA format label onto a tape. All AMANDA tapes must be
+      Write an Amanda format label onto a tape. All Amanda tapes must be
       labeled with amlabel. Amdump and amflush will not write to an unlabeled
       tape (see TAPE MANAGEMENT below).
 
@@ -93,10 +102,10 @@ for all the gory details.
       tapes, ejecting tapes and scanning the tape storage slots.
 
   amverify
-      Check AMANDA backup tapes for errors.
+      Check Amanda backup tapes for errors.
 
   amrmtape
-      Delete a tape from the AMANDA databases.
+      Delete a tape from the Amanda databases.
 
   amstatus
       Report the status of a running or completed amdump.
@@ -105,30 +114,36 @@ for all the gory details.
       Display a chart of hosts and file systems backed up every run.
 
   amplot
-      Generate utilization plots of AMANDA runs for performance tuning.
+      Generate utilization plots of Amanda runs for performance tuning.
 
   amreport
-      Generate an AMANDA summary E-mail report.
+      Generate an Amanda summary E-mail report.
 
   amtoc
-      Generate table of content files for AMANDA tapes.
+      Generate table of content files for Amanda tapes.
 
   amcheckdb
-      Verify every tape AMANDA knows about is consistent in the database.
+      Verify every tape Amanda knows about is consistent in the database.
 
   amgetconf
-      Look up parameters in the AMANDA configuration file.
+      Look up parameters in the Amanda configuration file.
 
   amtapetype
       Generate a tapetype definition.
 
+  amaespipe
+      Wrapper program from aespipe (data encryption utility)
+
+  amcrypt
+      Reference encryption program for Amanda symmetric data encryption
+
 
 CONFIGURATION
 
-There are three user-editable files that control the behavior of AMANDA.
+There are three user-editable files that control the behavior of Amanda.
 The first is amanda.conf, the main configuration file. It contains parameters
-to customize AMANDA for the site. Refer to the amanda.conf(5), manpage for
-details on AMANDA configuration parameters.
+to customize Amanda for the site. Refer to the amanda.conf(5), manpage for
+details on Amanda configuration parameters.
 Second is the disklist file, which lists hosts and disk partitions to back up.
 Third is the tapelist file, which lists tapes that are currently active. These
 files are described in more detail in the following sections.
@@ -137,14 +152,14 @@ etc/amanda/. A site will often have more than one configuration. For example,
 it might have a normal configuration for everyday backups and an archive
 configuration for infrequent full archival backups. The configuration files
 would be stored under directories /usr/local/etc/amanda/normal/ and /usr/local/
-etc/amanda/archive/, respectively. Part of the job of an AMANDA administrator
+etc/amanda/archive/, respectively. Part of the job of an Amanda administrator
 is to create, populate and maintain these directories.
-All log and database files generated by AMANDA go in corresponding directories
+All log and database files generated by Amanda go in corresponding directories
 somewhere. The exact location is controlled by entries in amanda.conf. A
 typical location would be under /var/adm/amanda. For the above example, the
 files might go in /var/adm/amanda/normal/ and /var/adm/amanda/archive/.
 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.
+Amanda cycles them out in various ways, depending on the type of file.
 Detailed information about amdump runs are stored in files named amdump.NN
 where NN is a sequence number, with 1 being the most recent file. Amdump
 rotates these files each run, keeping roughly the last tapecycle (see below)
@@ -153,7 +168,7 @@ The file used by amreport to generate the mail summary is named log.YYYYMMDD.NN
 where YYYYMMDD is the datestamp of the start of the amdump run and NN is a
 sequence number started at 0. At the end of each amdump run, log files for runs
 whose tapes have been reused are renamed into a subdirectory of the main log
-directory (see the logdir parameter below) named oldlog. It is up to the AMANDA
+directory (see the logdir parameter below) named oldlog. It is up to the Amanda
 administrator to remove them from this directory when desired.
 Index (backup image catalogue) files older than the full dump matching the
 oldest backup image for a given client and disk are removed by amdump at the
@@ -161,7 +176,7 @@ end of each run.
 
 DISKLIST FILE
 
-The disklist file determines which disks will be backed up by AMANDA. The file
+The disklist file determines which disks will be backed up by Amanda. The file
 usually contains one line per disk:
 
   hostname diskname [diskdevice] dumptype [spindle [interface] ]
@@ -173,7 +188,7 @@ following meanings:
 
   hostname
       The name of the host to be backed up. If diskdevice refers to a PC share,
-      this is the host AMANDA will run the Samba smbclient program on to back
+      this is the host Amanda will run the Samba smbclient program on to back
       up the share.
 
   diskname
@@ -181,7 +196,7 @@ following meanings:
       the diskdevice and you don't set the diskdevice. If you want multiple
       entries with the same diskdevice, you must set a different diskname for
       each entry. It's the diskname that you use on the commandline for any
-      AMANDA command. Look at the example/disklist file for example.
+      Amanda command. Look at the example/disklist file for example.
 
   diskdevice
       Default: same as diskname. The name of the disk device to be backed up.
@@ -200,7 +215,7 @@ following meanings:
       priority, etc.
 
   spindle
-      Default: -1. A number used to balance backup load on a host. AMANDA will
+      Default: -1. A number used to balance backup load on a host. Amanda will
       not run multiple backups at the same time on the same spindle, unless the
       spindle number is -1, which means there is no spindle restriction.
 
@@ -226,13 +241,13 @@ work instead of defining a new dumptype:
 TAPE MANAGEMENT
 
 The tapelist file contains the list of tapes in active use. This file is
-maintained entirely by AMANDA and should not be created or edited during normal
+maintained entirely by Amanda and should not be created or edited during normal
 operation. It contains lines of the form:
 
   YYYYMMDD label flags
 
 Where YYYYMMDD is the date the tape was written, label is a label for the tape
-as written by amlabel and flags tell AMANDA whether the tape may be reused, etc
+as written by amlabel and flags tell Amanda whether the tape may be reused, etc
 (see the reuse options of amadmin).
 Amdump and amflush will refuse to write to an unlabeled tape, or to a labeled
 tape that is considered active. There must be more tapes in active rotation
@@ -245,7 +260,7 @@ OUTPUT DRIVERS
 The normal value for the tapedev parameter, or for what a tape changer returns,
 is a full path name to a non-rewinding tape device, such as /dev/nst0 or /dev/
 rmt/0mn or /dev/nst0.1 or whatever conventions the operating system uses.
-AMANDA provides additional application level drivers that support non-
+Amanda provides additional application level drivers that support non-
 traditional tape-simulations or features. To access a specific output driver,
 set tapedev (or configure your changer to return) a string of the form driver:
 driver-info where driver is one of the supported drivers and driver-info is
@@ -268,7 +283,7 @@ The supported drivers are:
   null
       This driver throws away anything written to it and returns EOF for any
       reads except a special case is made for reading a label, in which case a
-      "fake" value is returned that AMANDA checks for and allows through
+      "fake" value is returned that Amanda checks for and allows through
       regardless of what you have set in labelstr. The driver-info field is not
       used and may be left blank:
 
@@ -315,7 +330,7 @@ The supported drivers are:
       for the actual data. Create a symlink named data in the file directory to
       one of the data directories. Set the tapetype length to whatever the
       medium will hold.
-      When AMANDA fills the file device, remove the symlink and (optionally)
+      When Amanda fills the file device, remove the symlink and (optionally)
       create a new symlink to another data area. Use a CD writer software
       package to burn the image from the first data area.
       To read the CD, mount it and create the data symlink in the file device
@@ -324,34 +339,37 @@ The supported drivers are:
 
 AUTHORIZATION
 
-AMANDA processes on the tape server host run as the dumpuser user listed in
-amanda.conf. When they connect to a backup client, they do so with an AMANDA-
+Amanda processes on the tape server host run as the dumpuser user listed in
+amanda.conf. When they connect to a backup client, they do so with an Amanda-
 specific protocol. They do not, for instance, use rsh or ssh directly.
 On the client side, the amandad daemon validates the connection using one of
 several methods, depending on how it was compiled and on options it is passed:
 
 
   .rhosts
-      Even though AMANDA does not use rsh, it can use .rhosts-style
+      Even though Amanda does not use rsh, it can use .rhosts-style
       authentication and a .rhosts file.
 
   .amandahosts
       This is essentially the same as .rhosts authentication except a different
       file, with almost the same format, is used. This is the default mechanism
-      built into AMANDA.
+      built into Amanda.
       The format of the .amandahosts file is:
-      hostname [ username ]
+      hostname [ username [ service ]*]
       If username is ommitted, it defaults to the user running amandad, i.e.
       the user listed in the inetd or xinetd configuration file.
+      The service is a list of the service the client is authorized to execute:
+      amdump, noop, selfcheck, sendsize, sendbackup, amindexd, amidxtaped.
+      amdump is a shortcut for "noop selfcheck sendsize sendbackup"
 
   Kerberos
-      AMANDA may use the Kerberos authentication system. Further information is
-      in the docs/KERBEROS file that comes with an AMANDA distribution.
-      For Samba access, AMANDA needs a file on the Samba server (which may or
+      Amanda may use the Kerberos authentication system. Further information is
+      in the docs/KERBEROS file that comes with an Amanda distribution.
+      For Samba access, Amanda needs a file on the Samba server (which may or
       may not also be the tape server) named /etc/amandapass 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
+      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:
 
@@ -359,10 +377,10 @@ several methods, depending on how it was compiled and on options it is passed:
           //another-pc/disk otheruser%otherpw
 
       With clear text passwords, this file should obviously be tightly
-      protected. It only needs to be readable by the AMANDA-user on the Samba
+      protected. It only needs to be readable by the Amanda-user on the Samba
       server.
       You can find further information in the docs/SAMBA file that comes with
-      an AMANDA distribution.
+      an Amanda distribution.
 
 
 HOST & DISK EXPRESSION
@@ -376,37 +394,35 @@ 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.
- ________________________________________________________
-|._|word_separator_for_a_host____________________________|
-|/_|word_separator_for_a_disk____________________________|
-|^_|anchor_at_left_______________________________________|
-|$_|anchor_at_right______________________________________|
-|?_|match_exactly_one_character_except_the_separator_____|
-|*_|match_zero_or_more_characters_except_the_separator___|
-|**|match_zero_or_more_characters_including_the_separator|
 
+.  word separator for a host
+/  word separator for a disk
+^  anchor at left
+$  anchor at right
+?  match exactly one character except the separator
+*  match zero or more characters except the separator
+** match zero or more characters including the separator
 Some examples:
- ___________________________________________
-|EXPRESSION|WILL_MATCH_______|WILL_NOT_MATCH|
-|hosta_____|hosta____________|hostb_________|
-|__________|hoSTA.dOMAIna.ORG|______________|
-|__________|foo.hosta.org____|______________|
-|host______|host_____________|hosta_________|
-|host?_____|hosta____________|host__________|
-|__________|hostb____________|______________|
-|ho*na_____|hoina____________|ho.aina.org___|
-|ho**na____|hoina____________|______________|
-|__________|ho.aina.org______|______________|
-|^hosta____|hosta____________|foo.hosta.org_|
-|sda*______|/dev/sda1________|______________|
-|__________|/dev/sda12_______|______________|
-|/opt/_____|opt_(disk)_______|opt_(host)____|
-|.opt._____|opt_(host)_______|opt_(disk)____|
-|/_________|/________________|any_other_disk|
-|/usr______|/usr_____________|______________|
-|__________|/usr/opt_________|______________|
-|/usr$_____|/usr_____________|/usr/opt______|
 
+EXPRESSION     WILL MATCH           WILL NOT MATCH
+hosta          hosta                hostb
+               hoSTA.dOMAIna.ORG 
+               foo.hosta.org 
+host           host                 hosta
+host?          hosta                host
+               hostb 
+ho*na          hoina                ho.aina.org
+ho**na         hoina 
+               ho.aina.org 
+^hosta         hosta                foo.hosta.org
+sda*           /dev/sda1 
+               /dev/sda12 
+/opt/          opt (disk)           opt (host)
+.opt.          opt (host)           opt (disk)
+/              /                    any other disk
+/usr           /usr 
+               /usr/opt 
+/usr$          /usr                 /usr/opt
 
 DATESTAMP EXPRESSION
 
@@ -422,20 +438,31 @@ Leading ^ is removed. Trailing $ forces an exact match.
 |200010$____|match_only_200010____________________________________________|
 
 
+CONFIGURATION OVERWRITE
+
+Most command allow to overwrite any configuration parameter on the command line
+with the -o option.
+-o NAME=value
+eg. -o runtapes=2
+eg. -o DUMPTYPE:no-compress:compress="server fast"
+eg. -o TAPETYPE:HP-DAT:length=2000m
+eg. -o INTERFACE:local:use="2000 kbps"
+
 AUTHOR
 
 James da Silva, <jds@amanda.org> : Original text
-Stefan G. Weichinger, <sgw@amanda.org>, maintainer of the AMANDA-documentation:
+Stefan G. Weichinger, <sgw@amanda.org>, maintainer of the Amanda-documentation:
 XML-conversion, major update
 
 SEE ALSO
 
-amadmin(8), amanda.conf(5), amcheck(8), amcheckdb(8), amcleanup(8), amdd(8),
-amdump(8), amflush(8), amgetconf(8), amlabel(8), ammt(8), amoverview(8), amplot
-(8), amrecover(8), amreport(8), amrestore(8), amrmtape(8), amstatus(8), amtape
-(8), amtapetype(8), amtoc(8), amverify(8), amverifyrun(8)
+amadmin(8), amanda.conf(5), amanda-client.conf(5), amcheck(8), amcheckdb(8),
+amcleanup(8), amdd(8), amdump(8), amfetchdump(8) amflush(8), amgetconf(8),
+amlabel(8), ammt(8), amoverview(8), amplot(8), amrecover(8), amreport(8),
+amrestore(8), amrmtape(8), amstatus(8), amtape(8), amtapetype(8), amtoc(8),
+amverify(8), amverifyrun(8)
 -------------------------------------------------------------------------------
 
-Prev      Up          Next
-amadmin  Home  amanda.conf
+Prev        Up          Next
+amaespipe  Home  amanda.conf