1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
[
<!-- entities files to use -->
<!ENTITY % global_entities SYSTEM 'global.entities'>
%global_entities;
]>
<refentry id='amanda-scripts.7'>
<refmeta>
<refentrytitle>amanda-scripts</refentrytitle>
<manvolnum>7</manvolnum>
&rmi.source;
&rmi.version;
&rmi.manual.7;
</refmeta>
<refnamediv>
<refname>amanda-scripts</refname>
<refpurpose>Configuring and using the Script API</refpurpose>
</refnamediv>
<refentryinfo>
&author.jlm;
&author.dustin;
</refentryinfo>
<!-- body begins here -->
<refsect1><title>DESCRIPTION</title>
<para>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.</para>
</refsect1>
<refsect1><title>SCRIPTS</title>
<para>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.</para>
<itemizedlist>
<listitem>
<manref name="amzfs-snapshot" vol="8"/>,
- create/destroy zfs snapshot.
</listitem>
<listitem>
<manref name="script-email" vol="8"/>,
- send email.
</listitem>
</itemizedlist>
<para>Script properties work just like application properties: they are
insensitive to case, and <literal>-</literal> (dash) and
<literal>_</literal> (underscore) may be used interchangeably.</para>
</refsect1>
<refsect1><title>SCRIPTS OUTPUT PROPERTY</title>
<para>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.</para>
</refsect1>
<refsect1><title>SCRIPTS FAILURE (to abort a backup)</title>
<para>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.</para>
<para>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.</para>
</refsect1>
<seealso>
<manref name="amanda.conf" vol="5"/>
</seealso>
</refentry>
|
