git.gag.com Git - debian/amanda/blob - man/xml-source/amanda-scripts.7.xml

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
   4 [
   5   <!-- entities files to use -->
   6   <!ENTITY % global_entities SYSTEM 'global.entities'>
   7   %global_entities;
   8 ]>
   9
  10 <refentry id='amanda-scripts.7'>
  11
  12 <refmeta>
  13 <refentrytitle>amanda-scripts</refentrytitle>
  14 <manvolnum>7</manvolnum>
  15 &rmi.source;
  16 &rmi.version;
  17 &rmi.manual.7;
  18 </refmeta>
  19 <refnamediv>
  20 <refname>amanda-scripts</refname>
  21 <refpurpose>Configuring and using the Script API</refpurpose>
  22 </refnamediv>
  23 <refentryinfo>
  24 &author.jlm;
  25 &author.dustin;
  26 </refentryinfo>
  27 <!-- body begins here -->
  28
  29 <refsect1><title>DESCRIPTION</title>
  30
  31 <para>The Script API is a flexible system for invoking user-supplied scripts at
  32 various points in the execution of Amanda.  This manual page describes the
  33 operation and configuration of the API.  For help writing Script API scripts,
  34 see http://wiki.zmanda.com/index.php/Script_API.</para>
  35
  36 </refsect1>
  37
  38 <refsect1><title>SCRIPTS</title>
  39
  40 <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>
  41
  42 <itemizedlist>
  43 <listitem>
  44 <manref name="amzfs-snapshot" vol="8"/>,
  45 - create/destroy zfs snapshot.
  46 </listitem>
  47 <listitem>
  48 <manref name="script-email" vol="8"/>,
  49 - send email.
  50 </listitem>
  51 </itemizedlist>
  52
  53 <para>Script properties work just like application properties: they are
  54 insensitive to case, and <literal>-</literal> (dash) and
  55 <literal>_</literal> (underscore) may be used interchangeably.</para>
  56
  57 </refsect1>
  58
  59 <refsect1><title>SCRIPTS OUTPUT PROPERTY</title>
  60
  61 <para>A pre-dle-amcheck, pre-dle-estimate or pre-dle-backup executed on the
  62 client can output property on stdout that are sent to the application.
  63 If the output line matches "PROPERTY str1 str2", Amanda sets a property called
  64 "str1" by the value of "str2", that property is sent to the application.</para>
  65
  66 </refsect1>
  67
  68 <seealso>
  69 <manref name="amanda.conf" vol="5"/>
  70 </seealso>
  71
  72 </refentry>