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: 11/05/2009
   6 .\"    Manual: System Administration Commands
   7 .\"    Source: Amanda 2.6.1p2
   8 .\"  Language: English
   9 .\"
  10 .TH "SCRIPT\-EMAIL" "8" "11/05/2009" "Amanda 2\&.6\&.1p2" "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
  26 \fIAmanda\fR
  27 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\&.
  28 .SH "PROPERTIES"
  29 .PP
  30 This section lists the properties that control script\-email\'s functionality\&. See
  31 \fBamanda-scripts\fR(7)
  32 for information on the Script API, script configuration\&.
  33 .PP
  34 MAILTO
  35 .RS 4
  36
  37 List of email addresses that will receive an email on command execution\&. It is a multi\-valued property:
  38 .nf
  39   property "MAILTO" "amanda@domain\&.com" "sysadmin@domain\&.com" "amandauser@domain\&.com"
  40 .fi
  41 .RE
  42 .SH "EXAMPLE"
  43
  44
  45 In this example, script\-email is scheduled to be run before the DLE, on the
  46 server\&.  The unqualified email address \fIamanda\fR will be
  47 passed to the email system unchanged\&.  The script is then attached to a
  48 dumptype, which can then be specified for any DLEs which require notification\&.
  49 .nf
  50  define script\-tool pre\-email {
  51    comment "email me before this DLE is backed up"
  52    plugin  "script\-email"
  53    execute\-on pre\-dle\-backup
  54    execute\-where server
  55    property "mailto" "amanda"
  56  }
  57
  58  define dumptype user\-tar\-email {
  59    user\-tar
  60    script "pre\-email"
  61  }
  62 .fi
  63 .SH "SEE ALSO"
  64 .PP
  65
  66 \fBamanda.conf\fR(5),
  67 \fBamanda-client.conf\fR(5),
  68 \fBamanda-scripts\fR(7)
  69 .SH "AUTHORS"
  70 .PP
  71 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
  72 .RS 4
  73 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
  74 .RE
  75 .PP
  76 \fBDustin J\&. Mitchell\fR <\&dustin@zmanda\&.com\&>
  77 .RS 4
  78 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
  79 .RE