2 .\" Title: amanda-interactivity
3 .\" Author: Jean-Louis Martineau <martineau@zmanda.com>
4 .\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
6 .\" Manual: Miscellanea
7 .\" Source: Amanda 3.3.0
10 .TH "AMANDA\-INTERACTIVIT" "7" "06/02/2011" "Amanda 3\&.3\&.0" "Miscellanea"
11 .\" -----------------------------------------------------------------
12 .\" * set default formatting
13 .\" -----------------------------------------------------------------
14 .\" disable hyphenation
16 .\" disable justification (adjust text to left margin only)
18 .\" -----------------------------------------------------------------
19 .\" * MAIN CONTENT STARTS HERE *
20 .\" -----------------------------------------------------------------
22 amanda-interactivity \- Configuring Interactivity with Amanda Amanda
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\&.
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"
32 Interactivity is specified in
37 define interactivity $interactivity_name {
40 property "$PROPERTY_NAME" "$PROPERTY_VALUE"
44 and then referenced in the global section as
47 interactivity "$interactivity_name"
50 Interactivity properties, like Amanda configuration parameters, are insensitive to case, and
54 (underscore) may be used interchangeably\&.
56 See the individual plugin sections, below for properties applicable to each plugin\&.
57 .SH "INTERACTIVITY MODULES"
59 Amanda provides three interactivity modules,
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\&.
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\&.
75 interactivity module uses email to send requests to the user, and reads replies from the filesystem\&.
79 module has many properties:
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\&.
93 Default: 10\&. This integer property indicates the time in seconds between each check of the check\-file\&.
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\&.
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\&.
115 interactivity module uses the
117 module if a terminal is available and uses the
119 module otherwise\&. Its properties are a combination of properties from each module\&.
123 define interactivity "by\-tty\-or\-email" {
124 comment "Send email on runs from cron; use terminal on command line"
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
138 : http://wiki.zmanda.com/
141 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
143 Zmanda, Inc\&. (http://www\&.zmanda\&.com)