git.gag.com Git - debian/amanda/blob - man/xml-source/script-email.8.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 '../entities/global.entities'>
   7   %global_entities;
   8 ]>
   9
  10 <refentry id='script-email.8'>
  11
  12 <refmeta>
  13 <refentrytitle>script-email</refentrytitle>
  14 <manvolnum>8</manvolnum>
  15 &rmi.source;
  16 &rmi.version;
  17 &rmi.manual.8;
  18 </refmeta>
  19 <refnamediv>
  20 <refname>script-email</refname>
  21 <refpurpose>Amanda script to send email notifications</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>script-email is an &A; script implementing the Script API.  It should not
  32 be run by users directly.  It sends a notification email to the addresses
  33 specified in the MAILTO property.</para>
  34
  35 </refsect1>
  36
  37 <refsect1><title>PROPERTIES</title>
  38
  39 <para>This section lists the properties that control script-email's functionality.
  40 See <citerefentry><refentrytitle>amanda-scripts</refentrytitle><manvolnum>7</manvolnum></citerefentry>
  41 for information on the Script API, script configuration.</para>
  42
  43 <!-- PLEASE KEEP THIS LIST IN ALPHABETICAL ORDER -->
  44 <variablelist>
  45  <!-- ==== -->
  46  <varlistentry><term>MAILTO</term><listitem>
  47 List of email addresses that will receive an email on command execution. It is a multi-valued property:
  48 <programlisting>
  49   property "MAILTO" "amanda@domain.com" "sysadmin@domain.com" "amandauser@domain.com"
  50 </programlisting>
  51 </listitem></varlistentry>
  52  <!-- ==== -->
  53 </variablelist>
  54
  55 </refsect1>
  56
  57 <refsect1><title>EXAMPLE</title>
  58
  59 In this example, script-email is scheduled to be run before the DLE, on the
  60 server.  The unqualified email address <emphasis>amanda</emphasis> will be
  61 passed to the email system unchanged.  The script is then attached to a
  62 dumptype, which can then be specified for any DLEs which require notification.
  63
  64 <programlisting>
  65  define script-tool pre-email {
  66    comment "email me before this DLE is backed up"
  67    plugin  "script-email"
  68    execute-on pre-dle-backup
  69    execute-where server
  70    property "mailto" "amanda"
  71  }
  72
  73  define dumptype user-tar-email {
  74    user-tar
  75    script "pre-email"
  76  }
  77 </programlisting>
  78 </refsect1>
  79
  80 <refsect1><title>SEE ALSO</title>
  81 <para>
  82 <citerefentry><refentrytitle>amanda.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
  83 <citerefentry><refentrytitle>amanda-client.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
  84 <citerefentry><refentrytitle>amanda-scripts</refentrytitle><manvolnum>7</manvolnum></citerefentry>
  85 </para>
  86
  87 </refsect1>
  88 </refentry>