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 v1.76.1 <http://docbook.sf.net/>
   5 .\"      Date: 07/25/2012
   6 .\"    Manual: Miscellanea
   7 .\"    Source: Amanda 3.3.2
   8 .\"  Language: English
   9 .\"
  10 .TH "AMANDA\-INTERACTIVIT" "7" "07/25/2012" "Amanda 3\&.3\&.2" "Miscellanea"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 amanda-interactivity \- Configuring Interactivity with Amanda Amanda
  32 .SH "DESCRIPTION"
  33 .PP
  34 Amanda uses interactivity to ask user to load specific volumes when they are needed\&. This manual page describes the interactivity modules included with Amanda\&.
  35 .PP
  36 This is a
  37 \fIuser\-level\fR
  38 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\&.
  39 .SH "DEFINING INTERACTIVITY"
  40 .PP
  41 Interactivity is specified in
  42 \fBamanda.conf\fR(5)
  43 as follows:
  44 .sp
  45 .nf
  46 define interactivity $interactivity_name {
  47    comment "$comment"
  48    plugin "$pluginname"
  49    property "$PROPERTY_NAME" "$PROPERTY_VALUE"
  50    \&.\&.\&.
  51 }
  52 .fi
  53 and then referenced in the global section as
  54 .sp
  55 .nf
  56   interactivity "$interactivity_name"
  57 .fi
  58 .PP
  59 Interactivity properties, like Amanda configuration parameters, are insensitive to case, and
  60 \-
  61 (dash) and
  62 _
  63 (underscore) may be used interchangeably\&.
  64 .PP
  65 See the individual plugin sections, below for properties applicable to each plugin\&.
  66 .SH "INTERACTIVITY MODULES"
  67 .PP
  68 Amanda provides three interactivity modules,
  69 \fItty\fR,
  70 \fIemail\fR
  71 and
  72 \fItty_email\fR\&.
  73 .SS "TTY"
  74 .PP
  75 The
  76 \fItty\fR
  77 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\&.
  78 .PP
  79 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\&.
  80 .SS "EMAIL"
  81 .PP
  82 The
  83 \fIemail\fR
  84 interactivity module uses email to send requests to the user, and reads replies from the filesystem\&.
  85 .PP
  86 The
  87 \fIemail\fR
  88 module has many properties:
  89 .PP
  90 check\-file
  91 .RS 4
  92
  93 If set, amanda will check this file for user input\&.  The user can touch the
  94 file to tell amanda that the requested volume was inserted in the changer\&.  If the user
  95 writes the name of a changer into the file, Amanda will use that changer\&.  If the user
  96 writes the word \*(Aqabort\*(Aq into the file, the scan will be aborted\&.
  97 .RE
  98 .PP
  99 check\-file\-delay
 100 .RS 4
 101
 102 Default: 10\&. This integer property indicates the time in seconds between each check of the check\-file\&.
 103 .RE
 104 .PP
 105 mailto
 106 .RS 4
 107
 108 Default: global value of \fBmailto\fR\&.  The email addresses to which
 109 the email should be sent\&.  If multiple addresses are given, they should be
 110 separated by spaces\&.
 111 .RE
 112 .PP
 113 resend\-delay
 114 .RS 4
 115
 116 Default 0\&. The time in seconds between emails\&.  Amanda will resend the same
 117 email at this frequency, which can be useful if \fBmailto\fR
 118 is a pager or phone\&.  If set to 0, only one email is sent\&.
 119 .RE
 120 .SS "TTY_EMAIL"
 121 .PP
 122 The
 123 \fItty_email\fR
 124 interactivity module uses the
 125 \fItty\fR
 126 module if a terminal is available and uses the
 127 \fIemail\fR
 128 module otherwise\&. Its properties are a combination of properties from each module\&.
 129 .SH "EXAMPLE"
 130 .PP
 131 .nf
 132   define interactivity "by\-tty\-or\-email" {
 133     comment "Send email on runs from cron; use terminal on command line"
 134     plugin "tty_email"
 135     property "mailto" "admin1" "admin2" "me@home"
 136     property "resend\-delay" "1800"               #every 30 minutes
 137     property "check\-file" "/tmp/email_input"
 138     property "check\-file\-delay" "10"             #every 10 seconds
 139   }
 140 .fi
 141 .SH "SEE ALSO"
 142 .PP
 143 \fBamanda\fR(8),
 144 \fBamanda.conf\fR(5)
 145 .PP
 146 The Amanda Wiki:
 147 : http://wiki.zmanda.com/
 148 .SH "AUTHOR"
 149 .PP
 150 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
 151 .RS 4
 152 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
 153 .RE