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 vsnapshot_8273 <http://docbook.sf.net/>
   5 .\"      Date: 10/18/2010
   6 .\"    Manual: System Administration Commands
   7 .\"    Source: Amanda 3.2.0
   8 .\"  Language: English
   9 .\"
  10 .TH "SCRIPT\-EMAIL" "8" "10/18/2010" "Amanda 3\&.2\&.0" "System Administration Commands"
  11 .\" -----------------------------------------------------------------
  12 .\" * set default formatting
  13 .\" -----------------------------------------------------------------
  14 .\" disable hyphenation
  15 .nh
  16 .\" disable justification (adjust text to left margin only)
  17 .ad l
  18 .\" -----------------------------------------------------------------
  19 .\" * MAIN CONTENT STARTS HERE *
  20 .\" -----------------------------------------------------------------
  21 .SH "NAME"
  22 script-email \- Amanda script to send email notifications
  23 .SH "DESCRIPTION"
  24 .PP
  25 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\&.
  26 .SH "PROPERTIES"
  27 .PP
  28 This section lists the properties that control script\-email\'s functionality\&. See
  29 \fBamanda-scripts\fR(7)
  30 for information on the Script API, script configuration\&.
  31 .PP
  32 MAILTO
  33 .RS 4
  34
  35 List of email addresses that will receive an email on command execution\&. It is a multi\-valued property:
  36 .nf
  37   property "MAILTO" "amanda@domain\&.com" "sysadmin@domain\&.com" "amandauser@domain\&.com"
  38 .fi
  39 .RE
  40 .SH "EXAMPLE"
  41
  42
  43 In this example, script\-email is scheduled to be run before the DLE, on the
  44 server\&.  The unqualified email address \fIamanda\fR will be
  45 passed to the email system unchanged\&.  The script is then attached to a
  46 dumptype, which can then be specified for any DLEs which require notification\&.
  47 .nf
  48  define script\-tool pre\-email {
  49    comment "email me before this DLE is backed up"
  50    plugin  "script\-email"
  51    execute\-on pre\-dle\-backup
  52    execute\-where server
  53    property "mailto" "amanda"
  54  }
  55
  56  define dumptype user\-tar\-email {
  57    user\-tar
  58    script "pre\-email"
  59  }
  60 .fi
  61 .SH "SEE ALSO"
  62 .PP
  63 \fBamanda\fR(8),
  64 \fBamanda.conf\fR(5),
  65 \fBamanda-client.conf\fR(5),
  66 \fBamanda-scripts\fR(7)
  67 .PP
  68 The Amanda Wiki:
  69 : http://wiki.zmanda.com/
  70 .SH "AUTHORS"
  71 .PP
  72 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
  73 .RS 4
  74 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
  75 .RE
  76 .PP
  77 \fBDustin J\&. Mitchell\fR <\&dustin@zmanda\&.com\&>
  78 .RS 4
  79 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
  80 .RE