git.gag.com Git - debian/amanda/blob - man/script-email.8

   1 '\" t
   2 .\"     Title: script-email
   3 .\"    Author: Jean-Louis Martineau <martineau@zmanda.com>
   4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
   5 .\"      Date: 02/21/2012
   6 .\"    Manual: System Administration Commands
   7 .\"    Source: Amanda 3.3.1
   8 .\"  Language: English
   9 .\"
  10 .TH "SCRIPT\-EMAIL" "8" "02/21/2012" "Amanda 3\&.3\&.1" "System Administration Commands"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 script-email \- Amanda script to send email notifications
  32 .SH "DESCRIPTION"
  33 .PP
  34 script\-email is an Amanda script implementing the Script API\&. It should not be run by users directly\&. It sends a notification email to the addresses specified in the MAILTO property\&.
  35 .SH "PROPERTIES"
  36 .PP
  37 This section lists the properties that control script\-email\*(Aqs functionality\&. See
  38 \fBamanda-scripts\fR(7)
  39 for information on the Script API, script configuration\&.
  40 .PP
  41 MAILTO
  42 .RS 4
  43
  44 List of email addresses that will receive an email on command execution\&. It is a multi\-valued property:
  45 .nf
  46   property "MAILTO" "amanda@domain\&.com" "sysadmin@domain\&.com" "amandauser@domain\&.com"
  47 .fi
  48 .RE
  49 .SH "EXAMPLE"
  50
  51
  52 In this example, script\-email is scheduled to be run before the DLE, on the
  53 server\&.  The unqualified email address \fIamanda\fR will be
  54 passed to the email system unchanged\&.  The script is then attached to a
  55 dumptype, which can then be specified for any DLEs which require notification\&.
  56 .nf
  57  define script\-tool pre\-email {
  58    comment "email me before this DLE is backed up"
  59    plugin  "script\-email"
  60    execute\-on pre\-dle\-backup
  61    execute\-where server
  62    property "mailto" "amanda"
  63  }
  64
  65  define dumptype user\-tar\-email {
  66    user\-tar
  67    script "pre\-email"
  68  }
  69 .fi
  70 .SH "SEE ALSO"
  71 .PP
  72 \fBamanda\fR(8),
  73 \fBamanda.conf\fR(5),
  74 \fBamanda-client.conf\fR(5),
  75 \fBamanda-scripts\fR(7)
  76 .PP
  77 The Amanda Wiki:
  78 : http://wiki.zmanda.com/
  79 .SH "AUTHORS"
  80 .PP
  81 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
  82 .RS 4
  83 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
  84 .RE
  85 .PP
  86 \fBDustin J\&. Mitchell\fR <\&dustin@zmanda\&.com\&>
  87 .RS 4
  88 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
  89 .RE