'\" t
.\"     Title: amanda-interactivity
.\"    Author: Jean-Louis Martineau <martineau@zmanda.com>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 12/01/2017
.\"    Manual: Miscellanea
.\"    Source: Amanda 3.5.1
.\"  Language: English
.\"
.TH "AMANDA\-INTERACTIVIT" "7" "12/01/2017" "Amanda 3\&.5\&.1" "Miscellanea"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
amanda-interactivity \- Configuring Interactivity with Amanda Amanda
.SH "DESCRIPTION"
.PP
Amanda uses interactivity to ask user to load specific volumes when they are needed\&. This manual page describes the interactivity modules included with Amanda\&.
.PP
This is a
\fIuser\-level\fR
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 \*(AqAmanda::Interactivity\*(Aq and http://wiki\&.zmanda\&.com\&.
.SH "DEFINING INTERACTIVITY"
.PP
Interactivity is specified in
\fBamanda.conf\fR(5)
as follows:
.sp
.nf
define interactivity $interactivity_name {
   comment "$comment"
   plugin "$pluginname"
   property "$PROPERTY_NAME" "$PROPERTY_VALUE"
   \&.\&.\&.
}
.fi
and then referenced in the global section as
.sp
.nf
  interactivity "$interactivity_name"
.fi
.PP
Interactivity properties, like Amanda configuration parameters, are insensitive to case, and
\-
(dash) and
_
(underscore) may be used interchangeably\&.
.PP
See the individual plugin sections, below for properties applicable to each plugin\&.
.SH "INTERACTIVITY MODULES"
.PP
Amanda provides three interactivity modules,
\fItty\fR,
\fIemail\fR
and
\fItty_email\fR\&.
.SS "TTY"
.PP
The
\fItty\fR
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\&.
.PP
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 \*(Aqabort\*(Aq will abort the operation\&.
.SS "EMAIL"
.PP
The
\fIemail\fR
interactivity module uses email to send requests to the user, and reads replies from the filesystem\&.
.PP
The
\fIemail\fR
module has many properties:
.PP
check\-file
.RS 4

If set, amanda will check this file for user input\&.  The user can touch the
file to tell amanda that the requested volume was inserted in the changer\&.  If the user
writes the name of a changer into the file, Amanda will use that changer\&.  If the user
writes the word \*(Aqabort\*(Aq into the file, the scan will be aborted\&.
.RE
.PP
check\-file\-delay
.RS 4

Default: 10\&. This integer property indicates the time in seconds between each check of the check\-file\&.
.RE
.PP
mailto
.RS 4

Default: global value of \fBmailto\fR\&.  The email addresses to which
the email should be sent\&.  If multiple addresses are given, they should be
separated by spaces\&. 
.RE
.PP
resend\-delay
.RS 4

Default 0\&. The time in seconds between emails\&.  Amanda will resend the same
email at this frequency, which can be useful if \fBmailto\fR
is a pager or phone\&.  If set to 0, only one email is sent\&.
.RE
.SS "TTY_EMAIL"
.PP
The
\fItty_email\fR
interactivity module uses the
\fItty\fR
module if a terminal is available and uses the
\fIemail\fR
module otherwise\&. Its properties are a combination of properties from each module\&.
.SH "EXAMPLE"
.PP
.nf
  define interactivity "by\-tty\-or\-email" {
    comment "Send email on runs from cron; use terminal on command line"
    plugin "tty_email"
    property "mailto" "admin1" "admin2" "me@home"
    property "resend\-delay" "1800"               #every 30 minutes
    property "check\-file" "/tmp/email_input"
    property "check\-file\-delay" "10"             #every 10 seconds
  }
.fi
.SH "SEE ALSO"
.PP
\fBamanda\fR(8),
\fBamanda.conf\fR(5)
.PP
The Amanda Wiki:
: http://wiki.zmanda.com/
.SH "AUTHOR"
.PP
\fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
.RS 4
Zmanda, Inc\&. (http://www\&.zmanda\&.com)
.RE