1AMANDA-INTERACTIVIT(7)            Miscellanea           AMANDA-INTERACTIVIT(7)
2
3
4

NAME

6       amanda-interactivity - Configuring Interactivity with Amanda Amanda
7

DESCRIPTION

9       Amanda uses interactivity to ask user to load specific volumes when
10       they are needed. This manual page describes the interactivity modules
11       included with Amanda.
12
13       This is a user-level description of the API, and does not address
14       details that are only of concern to developers of new interactivity
15       plugins. For that purpose, consult the Amanda source code, perldoc
16       'Amanda::Interactivity' and http://wiki.zmanda.com.
17

DEFINING INTERACTIVITY

19       Interactivity is specified in amanda.conf(5) as follows:
20
21       define interactivity $interactivity_name {
22          comment "$comment"
23          plugin "$pluginname"
24          property "$PROPERTY_NAME" "$PROPERTY_VALUE"
25          ...
26       }
27       and then referenced in the global section as
28
29         interactivity "$interactivity_name"
30
31       Interactivity properties, like Amanda configuration parameters, are
32       insensitive to case, and - (dash) and _ (underscore) may be used
33       interchangeably.
34
35       See the individual plugin sections, below for properties applicable to
36       each plugin.
37

INTERACTIVITY MODULES

39       Amanda provides three interactivity modules, tty, email and tty_email.
40
41   TTY
42       The tty interactivity module uses the tty to communicate with the user,
43       it works only if a terminal is available, which is the case if amanda
44       is executed from a command line.
45
46       When promted for a volume, the user must put the requested volume in
47       the changer and type <enter>. User can type the name of another changer
48       if the volume is available in that changer. Typing 'abort' will abort
49       the operation.
50
51   EMAIL
52       The email interactivity module uses email to send requests to the user,
53       and reads replies from the filesystem.
54
55       The email module has many properties:
56
57       check-file
58
59           If set, amanda will check this file for user input.  The user can
60           touch the file to tell amanda that the requested volume was
61           inserted in the changer.  If the user writes the name of a changer
62           into the file, Amanda will use that changer.  If the user writes
63           the word 'abort' into the file, the scan will be aborted.
64
65       check-file-delay
66
67           Default: 10. This integer property indicates the time in seconds
68           between each check of the check-file.
69
70       mailto
71
72           Default: global value of mailto.  The email addresses to which the
73           email should be sent.  If multiple addresses are given, they should
74           be separated by spaces.
75
76       resend-delay
77
78           Default 0. The time in seconds between emails.  Amanda will resend
79           the same email at this frequency, which can be useful if mailto is
80           a pager or phone.  If set to 0, only one email is sent.
81
82   TTY_EMAIL
83       The tty_email interactivity module uses the tty module if a terminal is
84       available and uses the email module otherwise. Its properties are a
85       combination of properties from each module.
86

EXAMPLE

88         define interactivity "by-tty-or-email" {
89           comment "Send email on runs from cron; use terminal on command line"
90           plugin "tty_email"
91           property "mailto" "admin1" "admin2" "me@home"
92           property "resend-delay" "1800"               #every 30 minutes
93           property "check-file" "/tmp/email_input"
94           property "check-file-delay" "10"             #every 10 seconds
95         }
96

SEE ALSO

98       amanda(8), amanda.conf(5)
99
100       The Amanda Wiki: : http://wiki.zmanda.com/
101

AUTHOR

103       Jean-Louis Martineau <martineau@zmanda.com>
104           Zmanda, Inc. (http://www.zmanda.com)
105
106
107
108Amanda 3.5.4                      07/27/2023            AMANDA-INTERACTIVIT(7)
Impressum