git.gag.com Git - debian/amanda/blob - man/amanda-interactivity.7

   1 '\" t
   2 .\"     Title: amanda-interactivity
   3 .\"    Author: Jean-Louis Martineau <martineau@zmanda.com>
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
   5 .\"      Date: 06/02/2011
   6 .\"    Manual: Miscellanea
   7 .\"    Source: Amanda 3.3.0
   8 .\"  Language: English
   9 .\"
  10 .TH "AMANDA\-INTERACTIVIT" "7" "06/02/2011" "Amanda 3\&.3\&.0" "Miscellanea"
  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 amanda-interactivity \- Configuring Interactivity with Amanda Amanda
  23 .SH "DESCRIPTION"
  24 .PP
  25 Amanda uses interactivity to ask user to load specific volumes when they are needed\&. This manual page describes the interactivity modules included with Amanda\&.
  26 .PP
  27 This is a
  28 \fIuser\-level\fR
  29 description of the API, and does not address details that are only of concern to developers of new interactivity plugins\&. For that purpose, consult the Amanda source code, perldoc \'Amanda::Interactivity\' and http://wiki\&.zmanda\&.com\&.
  30 .SH "DEFINING INTERACTIVITY"
  31 .PP
  32 Interactivity is specified in
  33 \fBamanda.conf\fR(5)
  34 as follows:
  35 .sp
  36 .nf
  37 define interactivity $interactivity_name {
  38    comment "$comment"
  39    plugin "$pluginname"
  40    property "$PROPERTY_NAME" "$PROPERTY_VALUE"
  41    \&.\&.\&.
  42 }
  43 .fi
  44 and then referenced in the global section as
  45 .sp
  46 .nf
  47   interactivity "$interactivity_name"
  48 .fi
  49 .PP
  50 Interactivity properties, like Amanda configuration parameters, are insensitive to case, and
  51 \-
  52 (dash) and
  53 _
  54 (underscore) may be used interchangeably\&.
  55 .PP
  56 See the individual plugin sections, below for properties applicable to each plugin\&.
  57 .SH "INTERACTIVITY MODULES"
  58 .PP
  59 Amanda provides three interactivity modules,
  60 \fItty\fR,
  61 \fIemail\fR
  62 and
  63 \fItty_email\fR\&.
  64 .SS "TTY"
  65 .PP
  66 The
  67 \fItty\fR
  68 interactivity module uses the tty to communicate with the user, it works only if a terminal is available, which is the case if amanda is executed from a command line\&.
  69 .PP
  70 When promted for a volume, the user must put the requested volume in the changer and type <enter>\&. User can type the name of another changer if the volume is available in that changer\&. Typing \'abort\' will abort the operation\&.
  71 .SS "EMAIL"
  72 .PP
  73 The
  74 \fIemail\fR
  75 interactivity module uses email to send requests to the user, and reads replies from the filesystem\&.
  76 .PP
  77 The
  78 \fIemail\fR
  79 module has many properties:
  80 .PP
  81 check\-file
  82 .RS 4
  83
  84 If set, amanda will check this file for user input\&.  The user can touch the
  85 file to tell amanda that the requested volume was inserted in the changer\&.  If the user
  86 writes the name of a changer into the file, Amanda will use that changer\&.  If the user
  87 writes the word \'abort\' into the file, the scan will be aborted\&.
  88 .RE
  89 .PP
  90 check\-file\-delay
  91 .RS 4
  92
  93 Default: 10\&. This integer property indicates the time in seconds between each check of the check\-file\&.
  94 .RE
  95 .PP
  96 mailto
  97 .RS 4
  98
  99 Default: global value of \fBmailto\fR\&.  The email addresses to which
 100 the email should be sent\&.  If multiple addresses are given, they should be
 101 separated by spaces\&.
 102 .RE
 103 .PP
 104 resend\-delay
 105 .RS 4
 106
 107 Default 0\&. The time in seconds between emails\&.  Amanda will resend the same
 108 email at this frequency, which can be useful if \fBmailto\fR
 109 is a pager or phone\&.  If set to 0, only one email is sent\&.
 110 .RE
 111 .SS "TTY_EMAIL"
 112 .PP
 113 The
 114 \fItty_email\fR
 115 interactivity module uses the
 116 \fItty\fR
 117 module if a terminal is available and uses the
 118 \fIemail\fR
 119 module otherwise\&. Its properties are a combination of properties from each module\&.
 120 .SH "EXAMPLE"
 121 .PP
 122 .nf
 123   define interactivity "by\-tty\-or\-email" {
 124     comment "Send email on runs from cron; use terminal on command line"
 125     plugin "tty_email"
 126     property "mailto" "admin1" "admin2" "me@home"
 127     property "resend\-delay" "1800"               #every 30 minutes
 128     property "check\-file" "/tmp/email_input"
 129     property "check\-file\-delay" "10"             #every 10 seconds
 130   }
 131 .fi
 132 .SH "SEE ALSO"
 133 .PP
 134 \fBamanda\fR(8),
 135 \fBamanda.conf\fR(5)
 136 .PP
 137 The Amanda Wiki:
 138 : http://wiki.zmanda.com/
 139 .SH "AUTHOR"
 140 .PP
 141 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
 142 .RS 4
 143 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
 144 .RE