How To:Use Amanda Applications on a Client: Difference between revisions

From wiki.zmanda.com
Jump to navigation Jump to search
 
(rewrite)
Line 1: Line 1:
== The application must be defined in '''amanda.conf''' ==
The [[Application API]] provides for pluggable "applications" that are designed to back up specific kinds of data.  Applications are executables that live on the Amanda client.  Note that, for security reasons, you cannot provide a full path to the executable; it must reside in the application directory.
Define the '''my_application''' application using the '''myapplication''' binary.
 
   define application-tool my_application {
= Configuration =
Define the '''my_app_engineering''' application using the '''myapplication''' binary.
   define application-tool my_app_engineering {
     comment "a comment"
     comment "a comment"
     "my_app"                          # inherit config of the my_app application
     "my_app"                          # inherit config of the my_app application
     plugin  "myapplication"          # name of the application, it must be installed in dumper dir
     plugin  "myapplication"          # name of the application
     property "mailto" "amandabackup" # can set property
     property "mailto" "engineering"   # can set property
   }
   }


== The '''dumptype''' must specify the application ==
Now you have an application named '''my_app_engineering'''.  Next, define the '''engineering_app''' dumptype using the '''my_app_engineering''' application-tool
Define the "my_dumptype" dumptype using the "my_application" application
   define dumptype engineering_app {
   define dumptype my_dumptype {
     program "APPLICATION"
     program "APPLICATION"
     application "my_application"
     application "my_app_engineering"
   }
   }


Define the '''my_dumptype_2''' using a modified '''my_application''' application
Any [[DLE]] with dumptype '''engineering-app''' will then use '''myapplication'''.
   define dumptype my_dumptype_2 {
 
You can get a bit fancier than this, using nested definitions:  Define the '''my_dumptype_root''' using a modified '''my_app''' application
   define dumptype my_dumptype_root {
     program "APPLICATION"
     program "APPLICATION"
     application {                # define a custom application
     application {                # define a custom application
         "my_application"         # inherit setting from another application
         "my_app"                 # inherit setting from another application
         property "mailto" "root"  # override property
         property "mailto" "root"  # override property
     }
     }
   }
   }


Disk List Entries using '''my_dumptype''' or '''my_dumptype_2''' will use the '''myapplication''' application to back up the client.
[[DLE]]s using '''my_dumptype_root''' will use the '''myapplication''' plugin to back up the client.
 
== Available application ==
 
=== amgtar ===
  define application-tool app_amgtar {
      comment "amgtar"
      plugin  "amgtar"
      #property "GNUTAR-PATH" "/path/to/gtar"
      #property "GNUTAR-LISTDIR" "/path/to/gnutar_list_dir"
                    #default from gnutar_list_dir setting in amanda-client.conf
      #property "ONE-FILE-SYSTEM" "yes"  #use '--one-file-system' option
      #property "SPARSE" "yes"          #use '--sparse' option
      #property "ATIME-PRESERVE" "yes"  #use '--atime-preserve=system' option
      #property "CHECK-DEVICE" "yes"    #use '--no-check-device' if set to "no"
  }


  define dumptype dt_amgtar {
= Available Applications =
      program "APPLICATION"
      application "app_amgtar"
  }
 
Your DLE must inherit from the dt_amgtar dumptype.
 
=== amstar ===
  define application-tool app_amstar {
      comment "amstar"
      plugin  "amstar"
      #property "STAR-PATH" "/path/to/star"
      #property "STAR-TARDUMP" "/path/to/tardumps"  # default /etc/tardumps
      #property "STAR-DLE-TARDUMP" "no"
          # if 'yes' then create a different tardump file for each DLE,
          # it is required if you do many dump in parallel (maxdump>1)
      #property "ONE-FILE-SYSTEM" "yes"  #use '-xdev' option
      #property "SPARSE" "yes"          #use '-sparse' option
  }
 
  define dumptype dt_amstar {
      program "APPLICATION"
      application "app_amstar"
  }


Your DLE must inherit from the dt_amstar dumptype.
For the most up-to-date list, see {{man|7|amanda-applications}}.
amstar can only be used to backup full disk, i.e. the mount point.
* {{man|8|amstar}}
* {{man|8|amgtar}}

Revision as of 16:25, 12 December 2008

The Application API provides for pluggable "applications" that are designed to back up specific kinds of data. Applications are executables that live on the Amanda client. Note that, for security reasons, you cannot provide a full path to the executable; it must reside in the application directory.

Configuration

Define the my_app_engineering application using the myapplication binary. 

 define application-tool my_app_engineering {
    comment "a comment"
    "my_app"                          # inherit config of the my_app application
    plugin  "myapplication"           # name of the application
    property "mailto" "engineering"   # can set property
 }

Now you have an application named my_app_engineering. Next, define the engineering_app dumptype using the my_app_engineering application-tool 

 define dumptype engineering_app {
    program "APPLICATION"
    application "my_app_engineering"
 }

Any DLE with dumptype engineering-app will then use myapplication.

You can get a bit fancier than this, using nested definitions: Define the my_dumptype_root using a modified my_app application 

 define dumptype my_dumptype_root {
    program "APPLICATION"
    application {                # define a custom application
       "my_app"                  # inherit setting from another application
       property "mailto" "root"  # override property
    }
 }

DLEs using my_dumptype_root will use the myapplication plugin to back up the client.

Available Applications

For the most up-to-date list, see amanda-applications(7).

Retrieved from ‘http://wiki.zmanda.com/index.php?title=How_To:Use_Amanda_Applications_on_a_Client&oldid=6529’