
The Official AMANDA Documentation
                             Next

-------------------------------------------------------------------------------


The Official AMANDA Documentation


Edited by


Stefan G. Weichinger

AMANDA Core Team
<sgw@amanda.org>

Edited by


Amanda Core Team

AMANDA Core Team
-------------------------------------------------------------------------------
Table of Contents


  Abstract

  Copyright_Information

  Attributions

  I._Installation


        1._Amanda_2.5.0_-_System-Specific_Installation_Notes


              Solaris_2.6

              Solaris

              Trusted_Solaris

              SunOS_4.x

              Ultrix

              HP/UX

              Linux

              Digital_Unix_4

              Sinix_5.43_(Reliant_Unix)

              IRIX_(all)

              IRIX_6

              IRIX_6.5.x

              SCO

              FreeBSD_3.0

              FreeBSD_4.9

              FreeBSD_5.1

              AIX

              Microsoft_Windows

              Mac_OS_X


        2._Amanda_Installation_Notes


              Before_doing_anything

              Compiling_the_Amanda_sources

              Setting_up_your_Amanda_Configuration


                    Setting_up_the_Tape_Server_Host

                    Set_up_the_Backup_Client_Hosts



        3._Excluding


              Introduction

              Please_Read

              Before_We_Begin

              Choosing_an_exclude_mechanism


                    Exclude_Mechanisms


              Expression

              Wildcard_Expansion

              Troubleshooting


                    Broken_gnutar?

                    The_ps_command_is_your_friend.



        4._Indexing_with_Amanda


              Database_Format

              Database_Browsing

              File_Extraction

              Protocol_Between_amindexd_and_amrecover

              Installation_Notes

              Permissions

              Changes_from_amindex-1.0

              Changes_from_amindex-0.3

              Changes_from_amindex-0.2

              Changes_from_amindex-0.1

              Changes/additions_to_2.3.0

              Known_Bugs


        5._Backup_PC_hosts_using_Samba


              Installation

              Setup

              Example

              Bugs_and_notes


        6._Restore


  II._About_Tapes_and_Changers


        7._Tapetypes

        8._Amanda_Tape_Changer_Support


              Introduction

              Specifying_a_tape_changer_in_amanda.conf

              Device-specific_tapechanger_script

              Slot_names_and_the_"current"_slot

              Operator_interface

              How_amdump_interacts_with_the_tape_changer

              Builtin_tape-changers


                    chg-multi_(formerly_chg-generic)

                    chg-manual_(formerly_no-changer)

                    chg-mtx_(formerly_hp-changer)

                    chg-zd-mtx

                    chg-scsi-chio_(formerly_seagate-changer,_then_chg-chio)

                    chg-scsi_(new_interface,_try_to_drive_a_robot_with_direct
                    scsi_commands)

                    chg-chio

                    chg-chs

                    chg-rth

                    chg-juke

                    chg-rait

                    chg-disk

                    chg-iomega

                    chg-null



        9._chg-scsi


              Command_line_options

              Notes_about_changer.conf

              Amanda's_actual_usage_of_chg-scsi

              Configuration_notes

              Hacking_notes


        10._RAIT_(Redundant_Array_of_Inexpensive_Tape)_Support


              What_is_a_RAIT?

              Using_a_RAIT

              Disaster_Recovery


        11._Printing_of_Labels


              The_New_Feature

              Labels_provided

              History

              How_it_works



  III._HOWTOs


        12._Amanda_on_Cygwin_HOWTO


              Install_Cygwin

              Other_Preparation

              Compile_Amanda

              Configure_Cygwin_files

              Configure_Windows_System_Files

              Configure_inetd_to_run_automatically_as_a_service

              Windows_98/ME

              Windows_NT/2000/XP

              Notes_on_Amanda_backup_options


                    Compression

                    Exclude_Lists

                    Debugging_Files



        13._How_to_use_the_Amanda_file-driver


              Introduction

              Possible_Uses

              Setup


                    Basics


              Recovery


        14._AFS_HOWTO

        15._How_to_use_a_wrapper


              Bert_de_Ridder's_suggestions

              Paul_Bijnens's_suggestions


        16._How_to_do_Amanda-server-side_gpg-encrypted_backups.


              Setup

              Test

              Plans


        17._How_to_use_different_auth_with_Amanda


              Introduction

              BSD

              BSDTCP

              BSDUDP

              KRB4

              KRB5

              RSH

              SSH


                    For_amdump:

                    For_amrecover:




  IV._Various_Information


        18._Using_Amanda


              An_Introduction

              Amanda_Features

              Future_Capabilities_of_Amanda

              Amanda_Resources

              Installing_Amanda


                    Install_Related_Packages

                    Perform_Preliminary_Setup

                    Configure_the_Amanda_Build

                    Build_and_Install_Amanda

                    Configuring_Amanda

                    Decide_on_a_Tape_Server

                    Decide_Which_Tape_Devices_to_Use

                    Decide_Whether_to_Use_Compression

                    Decide_Where_the_Holding_Space_Will_Be

                    Compute_Your_Dump_Cycle

                    Copy_and_Edit_the_Default_Configuration_File

                    Configure_the_Holding_Disk

                    Configure_Tape_Devices_and_Label_Tapes

                    Configure_Backup_Clients

                    Test_and_Debug_Setup


              Operating_Amanda


                    Run_amdump

                    Read_Amanda's_Reports

                    Monitor_Tape_and_Holding_Disk_Status

                    Adding_Tapes_at_a_Particular_Position_in_the_Cycle

                    Miscellanous_Operational_Notes


              Advanced_Amanda_Configuration


                    Adjust_the_Backup_Cycle

                    Adjust_Parallelism

                    Monitor_for_Possible_Improvements

                    Excluding_Files


              Restoring_with_Amanda


                    Configuring_and_Using_amrecover

                    Using_amrestore

                    Restoring_Without_Amanda



        19._Amanda_FAQ

        20._Collection_of_the_top_ten_Amanda_questions._And_answers.


              Reason_for_starting_this_list.

              the_DLE-question

              the_localhost-question

              the_friday-tape-question

              the_multiple-dumps-question

              the_mailing-list-question

              the_distro-question

              the_index-question

              the_tapetype-questions

              the_size-question

              the_GUI-question

              the_holding-disk_question

              ...


        21._Amanda_WISHLIST


  V._Technical_Background


        22._How_Amanda_uses_UDP_and_TCP_ports


              TCP_port_allocation

              User_TCP_port_range_(--with-tcpportrange)_summary

              UDP_port_allocation

              User_UDP_port_range_(--with-udpportrange)_summary

              Firewalls_and_NAT


        23._Amanda_dumper_API


              Introduction

              The_Problem

              Overview_of_the_API


                    The_`support'_command


              The_`selfcheck'_command

              The_`estimate'_and_`estimate-parse'_commands

              The_`backup'_and_`backup-parse'_commands

              The_`index-from-output'_and_`index-from-image'_commands

              The_`restore'_command

              The_`print-command'_command

              Conclusion


        24._Amanda_Internals


              Protocols

              server_and_amandad_on_client

              planner_and_driver

              driver_and_dumper

              taper(read)_and_taper(write)


        25._Amanda_Event_API


              Introduction

              The_API


                    event_register

                    event_release

                    event_loop

                    event_wait

                    event_wakeup


              Data_types


                    event_handle_t

                    event_id_t

                    event_type_t

                    event_fn_t


              Event_Types


                    EV_READFD

                    EV_WRITEFD

                    EV_SIG

                    EV_TIME

                    EV_WAIT



        26._Amanda_Security_API


              Introduction

              The_Problem

              The_API


                    protocol_packet_transmission_functions

                    stream_functions


              Data_Types


                    security_driver_t

                    security_handle_t

                    security_stream_t

                    security_status_t


              SECURITY_DRIVERS


                    name

                    connect

                    accept

                    close

                    sendpkt

                    recvpkt

                    recvpkt_cancel

                    stream_server

                    stream_accept

                    stream_client

                    stream_close

                    stream_auth

                    stream_id

                    stream_write

                    stream_read

                    stream_read_cancel



        27._Virtual_Tape_API

        28._Using_Kerberos_with_Amanda


              Amanda_2.5.0_-_KERBEROS_v4_SUPPORT_NOTES


                    Configuration

                    Installation

                    conf_file


              Amanda_2.5.0_-_KERBEROS_v5_SUPPORT_NOTES


                    Building

                    Installation

                    conf_file

                    Destination_Host_Permissions_file




  VI._Historical_files


        29._Response_to_CPIO_Security_Notice_Issue_11:


              Affected_Versions

              Workaround

              Acknowledgements


        30._Upgrade_Issues

        31._What_once_was_new


              What's_new_in_Amanda_2.3


                    Indexing_backups_for_easier_restore

                    Samba_Support

                    GnuTar_Support

                    Multiple_backups_in_parallel_from_one_client_host

                    Multiple_tapes_in_one_run

                    Bottleneck_determination

                    2_Gb_limit_removed

                    amadmin_import/export


              What's_new_in_Amanda_2.2


                    Client_side_setup_has_changed

                    Version_suffixes_on_executables

                    Kerberos

                    Multiple_holding_disks

                    Remote_self-checks

                    mmap_support

                    gzip_support

                    Mount_point_names_in_disklist

                    Initial_tape-changer_support_included

                    Generic_tape_changer_wrapper_script

                    New_command_amtape

                    Changer_support_added_to_command_amlabel

                    Tape_changer_support_improved

                    A_few_words_about_multi-tape_runs

                    Big_planner_changes

                    Level-0_dumps_allowed_with_no_tape



        32._Multitape_support_in_Amanda_2.2


              Introduction

              New_Planner_Algorithm


                    Time

                    Full_Backups

                    Schedule_Balancing

                    Overwrite_Detection


              Taper_Algorithm


                    Choosing_a_tape

                    End_of_tape_handling

                    Tape_Format_Changes

                    Tapelist_File_Changes



        33._Thoughts_about_a_Strategy_API

        34._Y2K_Compliancy

        35._Usage_of_floppy_tape_drives_on_Linux


  VII._Appendixes


        36._The_Amanda_Manual_Pages.


              amadmin  administrative interface to control Amanda backups

              amaespipe  wrapper program for aespipe

              amanda  Advanced Maryland Automatic Network Disk Archiver

              amanda.conf  Main configuration file for Amanda, the Advanced
              Maryland Automatic Network Disk Archiver

              amanda-client.conf  Client configuration file for Amanda, the
              Advanced Maryland Automatic Network Disk Archiver

              amcheck  run Amanda self-checks

              amcheckdb  check Amanda database for tape consistency

              amcleanup  run the Amanda cleanup process after a failure

              amcrypt  reference crypt program for Amanda symmetric data
              encryption

              amcrypt-ossl  crypt program for Amanda symmetric data encryption
              using OpenSSL

              amcrypt-ossl-asym  crypt program for Amanda asymmetric data
              encryption using OpenSSL

              amdd  Amanda version of dd

              amdump  back up all disks in an Amanda configuration

              amfetchdump  extract backup images from multiple Amanda tapes.

              amflush  flush Amanda backup files from holding disk to tape

              amgetconf  look up amanda.conf variables

              amlabel  label an Amanda tape

              ammt  Amanda version of mt

              amoverview  display file systems processed by Amanda over time

              amplot  visualize the behavior of Amanda

              amrecover  Amanda index database browser

              amreport  generate a formatted output of statistics for an
              Amanda run

              amrestore  extract backup images from an Amanda tape

              amrmtape  remove a tape from the Amanda database

              amstatus  display the state of an Amanda run

              amtape  user interface to Amanda tape changer controls

              amtapetype  generate a tapetype definition.

              amtoc  generate TOC (Table Of Contents) for an Amanda run

              amverify  check an Amanda tape for errors

              amverifyrun  check the tapes written by the last Amanda run


        37._Web_Ressources


  Index

List of Tables


  4.1. Protocol_between_amindexd_and_amrecover

List of Examples


  2.1. /etc/crontab

  2.2. /etc/services

  2.3. /etc/inetd.conf

  2.4. /etc/xinetd.d/amandaidx

  2.5. /etc/xinetd.d/amidxtape

  2.6. /etc/amanda/supervise/amandaidx/run

  2.7. /etc/amanda/supervise/amidxtape/run

  2.8. /etc/services

  2.9. /etc/inetd.conf

  2.10. /etc/xinetd.d/amanda

  2.11. /etc/amanda/supervise/amanda/run

  15.1.

  15.2.

  16.1. /usr/local/libexec/amgtar

  16.2. /usr/local/bin/amaespipe

  16.3. bz2aespipe.patch

  18.1. A_C_Program_to_Check_the_Amanda_Service_Numbers

-------------------------------------------------------------------------------

         Next
     Abstract

