amanda-scripts7
Configuring and using the script api
Overview
The Script API is a flexible system for invoking user-supplied scripts at various points in the execution of Amanda. This manual page describes the operation and configuration of the API. For help writing Script API scripts, see http://wiki.zmanda.com/index.php/Script_API.
Scripts
This section lists the scripts included with Amanda, see the individual man page for instructions on using them. For complete How-To information, consult the Amanda wiki at http://wiki.zmanda.com.
• amzfs-snapshot(8), - create/destroy zfs snapshot.
• script-email(8), - send email.
Script properties work just like application properties: they are insensitive to case, and - (dash) and _ (underscore) may be used interchangeably.
Scripts output property
A pre-dle-amcheck, pre-dle-estimate or pre-dle-backup executed on the client can output property on stdout that are sent to the application. If the output line matches "PROPERTY str1 str2", Amanda sets a property called "str1" by the value of "str2", that property is sent to the application.
Scripts failure (to abort a backup)
A pre-host-estimate, pre-dle-estimate or pre-dle-backup executed on the client can abort a backup by writing an error message (single line) to STDERR and exit with != 0.
A post-dle-backup executed on the client can make a backup a failure by writing an error message (single line) to STDERR and exit with != 0.
Releases
8 releases since Debian 6.0 (Squeeze); the text changed 5 times.