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

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
   4 [
   5   <!-- entities files to use -->
   6   <!ENTITY % global_entities SYSTEM 'global.entities'>
   7   %global_entities;
   8 ]>
   9
  10 <refentry id='amanda-interactivity.7'>
  11
  12 <refmeta>
  13 <refentrytitle>amanda-interactivity</refentrytitle>
  14 <manvolnum>7</manvolnum>
  15 &rmi.source;
  16 &rmi.version;
  17 &rmi.manual.7;
  18 </refmeta>
  19 <refnamediv>
  20 <refname>amanda-interactivity</refname>
  21 <refpurpose>Configuring Interactivity with Amanda Amanda</refpurpose>
  22 </refnamediv>
  23 <refentryinfo>
  24 &author.jlm;
  25 </refentryinfo>
  26 <!-- body begins here -->
  27
  28 <refsect1><title>DESCRIPTION</title>
  29
  30 <para>Amanda uses interactivity to ask user to load specific volumes when
  31 they are needed.  This manual page describes the interactivity modules
  32 included with Amanda.</para>
  33
  34 <para>This is a <emphasis>user-level</emphasis> description of the API, and
  35 does not address details that are only of concern to developers of new
  36 interactivity plugins.  For that purpose, consult the Amanda source code,
  37 perldoc 'Amanda::Interactivity' and http://wiki.zmanda.com.</para>
  38
  39 </refsect1>
  40
  41 <refsect1><title>DEFINING INTERACTIVITY</title>
  42
  43 <para>Interactivity is specified in &amconf; as follows:
  44
  45 <programlisting>
  46 define interactivity $interactivity_name {
  47    comment "$comment"
  48    plugin "$pluginname"
  49    property "$PROPERTY_NAME" "$PROPERTY_VALUE"
  50    ...
  51 }
  52 </programlisting>
  53 and then referenced in the global section as
  54 <programlisting>
  55   interactivity "$interactivity_name"
  56 </programlisting></para>
  57
  58 <para>Interactivity properties, like Amanda configuration parameters, are
  59 insensitive to case, and <literal>-</literal> (dash) and
  60 <literal>_</literal> (underscore) may be used interchangeably.</para>
  61
  62 <para>See the individual plugin sections, below for properties applicable to
  63 each plugin.</para>
  64
  65 </refsect1>
  66
  67 <refsect1><title>INTERACTIVITY MODULES</title>
  68
  69 <para>Amanda provides three interactivity modules, <emphasis>tty</emphasis>,
  70 <emphasis>email</emphasis> and <emphasis>tty_email</emphasis>.</para>
  71
  72 <refsect2><title>TTY</title>
  73
  74 <para>The <emphasis>tty</emphasis> interactivity module uses the tty to
  75 communicate with the user, it works only if a terminal is available, which is
  76 the case if amanda is executed from a command line.</para>
  77
  78 <para>When promted for a volume, the user must put the requested volume
  79 in the changer and type &lt;enter&gt;. User can type the name of another
  80 changer if the volume is available in that changer. Typing 'abort' will
  81 abort the operation.</para>
  82
  83 </refsect2>
  84
  85 <refsect2><title>EMAIL</title>
  86
  87 <para>The <emphasis>email</emphasis> interactivity module uses email to send requests to the user, and reads replies from the filesystem.</para>
  88
  89 <para>The <emphasis>email</emphasis> module has many properties:</para>
  90
  91 <variablelist>
  92  <!-- ==== -->
  93  <varlistentry><term>check-file</term><listitem>
  94 If set, amanda will check this file for user input.  The user can touch the
  95 file to tell amanda that the requested volume was inserted in the changer.  If the user
  96 writes the name of a changer into the file, Amanda will use that changer.  If the user
  97 writes the word 'abort' into the file, the scan will be aborted.
  98 </listitem></varlistentry>
  99  <!-- ==== -->
 100  <varlistentry><term>check-file-delay</term><listitem>
 101 Default: 10. This integer property indicates the time in seconds between each check of the check-file.
 102 </listitem></varlistentry>
 103  <!-- ==== -->
 104  <varlistentry><term>mailto</term><listitem>
 105 Default: global value of <amkeyword>mailto</amkeyword>.  The email addresses to which
 106 the email should be sent.  If multiple addresses are given, they should be
 107 separated by spaces.
 108 </listitem></varlistentry>
 109  <!-- ==== -->
 110  <varlistentry><term>resend-delay</term><listitem>
 111 Default 0. The time in seconds between emails.  Amanda will resend the same
 112 email at this frequency, which can be useful if <amkeyword>mailto</amkeyword>
 113 is a pager or phone.  If set to 0, only one email is sent.
 114 </listitem></varlistentry>
 115 </variablelist>
 116
 117 </refsect2>
 118
 119 <refsect2><title>TTY_EMAIL</title>
 120
 121 <para>The <emphasis>tty_email</emphasis> interactivity module uses the
 122 <emphasis>tty</emphasis> module if a terminal is available and uses the
 123 <emphasis>email</emphasis> module otherwise.  Its properties are a
 124 combination of properties from each module.</para>
 125
 126 </refsect2>
 127 </refsect1>
 128
 129 <refsect1><title>EXAMPLE</title>
 130
 131 <para><programlisting>
 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 </programlisting></para>
 141
 142 </refsect1>
 143
 144 <seealso>
 145 <manref name="amanda.conf" vol="5"/>,
 146 </seealso>
 147
 148 </refentry>