git.gag.com Git - debian/amanda/blob - man/xml-source/amtape.8.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 '../entities/global.entities'>
   7   %global_entities;
   8 ]>
   9
  10 <!-- lifted from troff+man by doclifter -->
  11 <refentry id='amtape.8'>
  12
  13 <refmeta>
  14 <refentrytitle>amtape</refentrytitle>
  15 <manvolnum>8</manvolnum>
  16 &rmi.source;
  17 &rmi.version;
  18 &rmi.manual.8;
  19 </refmeta>
  20 <refnamediv>
  21 <refname>amtape</refname>
  22 <refpurpose>user interface to &A; tape changer controls</refpurpose>
  23 </refnamediv>
  24 <refentryinfo>
  25 &author.jds;
  26 &author.sgw.xml;
  27 </refentryinfo>
  28 <!-- body begins here -->
  29 <refsynopsisdiv>
  30 <cmdsynopsis>
  31   <command>amtape</command>
  32     <arg choice='plain'><replaceable>config</replaceable></arg>
  33     <arg choice='plain'><replaceable>command</replaceable></arg>
  34     <arg choice='opt' rep='repeat'><replaceable>command_options</replaceable></arg>
  35     <arg choice='plain' rep='repeat'><group><option>-o </option><replaceable>configoption</replaceable></group></arg>
  36 </cmdsynopsis>
  37 </refsynopsisdiv>
  38
  39
  40 <refsect1><title>DESCRIPTION</title>
  41 <para><emphasis remap='B'>Amtape</emphasis>
  42 performs tape changer control operations.
  43 It uses the underlying tape changer script defined by the
  44 <emphasis remap='B'>tpchanger</emphasis>
  45 option for a particular &A;
  46 configuration as specified by the
  47 <emphasis remap='I'>config</emphasis>
  48 argument.</para>
  49
  50 <para>Tape changers maintain a notion of the
  51 <emphasis remap='I'>current</emphasis>
  52 and
  53 <emphasis remap='I'>next</emphasis>
  54 slot for each configuration.
  55 These may or may not correspond to an actual physical state of the device,
  56 but do tend to minimize searching through the tape storage slots.
  57 If the desired tape is in the current slot,
  58 it is likely the next tape needed is in the next slot
  59 rather than at some random position in the storage slots.</para>
  60
  61 <para>See the
  62 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  63 man page for more details about &A;.</para>
  64 </refsect1>
  65
  66 <refsect1><title>COMMANDS</title>
  67 <variablelist remap='TP'>
  68   <varlistentry>
  69   <term><emphasis remap='B'>reset</emphasis></term>
  70   <listitem>
  71 <para>Reset the tape changer to a known state.
  72 The
  73 <emphasis remap='I'>current</emphasis>
  74 slot is set to the
  75 <emphasis remap='I'>first</emphasis>
  76 slot.
  77 Other device-specific side effects may occur.
  78 Some gravity stackers need to be reset to the top position by hand.
  79 This command notifies &A; the stacker is back in that position.</para>
  80   </listitem>
  81   </varlistentry>
  82   <varlistentry>
  83   <term><emphasis remap='B'>eject</emphasis></term>
  84   <listitem>
  85 <para>If a tape is loaded in the drive, it is ejected and returned to the
  86 slot from which it was loaded.</para>
  87   </listitem>
  88   </varlistentry>
  89   <varlistentry>
  90   <term><emphasis remap='B'>clean</emphasis></term>
  91   <listitem>
  92 <para>If a cleaning tape is defined for the changer,
  93 it is used to clean the drive.</para>
  94   </listitem>
  95   </varlistentry>
  96   <varlistentry>
  97   <term><emphasis remap='B'>show</emphasis></term>
  98   <listitem>
  99 <para>Show the contents of all slots.
 100 This can be slow.</para>
 101   </listitem>
 102   </varlistentry>
 103   <varlistentry>
 104   <term><emphasis remap='B'>label</emphasis> <emphasis remap='I'>label</emphasis></term>
 105   <listitem>
 106 <para>Search for and load the &A; tape with label
 107 <emphasis remap='I'>label</emphasis>.</para>
 108   </listitem>
 109   </varlistentry>
 110   <varlistentry>
 111   <term><emphasis remap='B'>taper</emphasis></term>
 112   <listitem>
 113 <para>Perform the
 114 <emphasis remap='B'>taper</emphasis>
 115 scan algorithm.
 116 Load the next tape in the configuration's tape sequence,
 117 or a fresh tape with a suitable label.</para>
 118   </listitem>
 119   </varlistentry>
 120   <varlistentry>
 121   <term><emphasis remap='B'>device</emphasis></term>
 122   <listitem>
 123 <para>Display the name of the current tape device on
 124 <emphasis remap='I'>stdout</emphasis>.</para>
 125   </listitem>
 126   </varlistentry>
 127   <varlistentry>
 128   <term><emphasis remap='B'>current</emphasis></term>
 129   <listitem>
 130 <para>Display the current slot.</para>
 131   </listitem>
 132   </varlistentry>
 133   <varlistentry>
 134   <term><emphasis remap='B'>update</emphasis></term>
 135   <listitem>
 136 <para>Update the changer label database, if it has one,
 137 to match the tapes now available.</para>
 138   </listitem>
 139   </varlistentry>
 140   <varlistentry>
 141   <term><emphasis remap='B'>slot</emphasis> <emphasis remap='I'>slot</emphasis></term>
 142   <listitem>
 143 <para>Eject any tape in the drive and put it away,
 144 then load the tape from slot
 145 <emphasis remap='I'>slot</emphasis>
 146 and reset
 147 <emphasis remap='I'>current</emphasis>.</para>
 148   </listitem>
 149   </varlistentry>
 150   <varlistentry>
 151   <term><emphasis remap='B'>slot current</emphasis></term>
 152   <listitem>
 153 <para>Eject any tape in the drive and put it away,
 154 then load the tape from the current slot.</para>
 155   </listitem>
 156   </varlistentry>
 157   <varlistentry>
 158   <term><emphasis remap='B'>slot next</emphasis></term>
 159   <listitem>
 160 <para>Eject any tape in the drive and put it away,
 161 then load the tape from the next slot and reset
 162 <emphasis remap='I'>current</emphasis>.</para>
 163   </listitem>
 164   </varlistentry>
 165   <varlistentry>
 166   <term><emphasis remap='B'>slot first</emphasis></term>
 167   <listitem>
 168 <para>Eject any tape in the drive and put it away,
 169 then load the tape from the first slot and reset
 170 <emphasis remap='I'>current</emphasis>.</para>
 171   </listitem>
 172   </varlistentry>
 173   <varlistentry>
 174   <term><emphasis remap='B'>slot advance</emphasis></term>
 175   <listitem>
 176 <para>Synonym for <emphasis remap='B'>slot next</emphasis>.</para>
 177   </listitem>
 178   </varlistentry>
 179
 180   <varlistentry>
 181   <term><emphasis remap='B'>-o</emphasis> <replaceable>configoption</replaceable></term>
 182   <listitem>
 183 <para>See the "<emphasis remap='B'>CONFIGURATION OVERRIDE</emphasis>"
 184  section in <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
 185   </listitem>
 186   </varlistentry>
 187
 188 </variablelist>
 189
 190 <para>This is useful with non-gravity stackers to unload the last tape used
 191 and set up &A; for the next run.
 192 If you just use
 193 <emphasis remap='B'>eject</emphasis>,
 194 the current tape will be mounted again in the next run,
 195 where it will be rejected as being still in use,
 196 ejected and the next tape requested.
 197 Using
 198 <emphasis remap='B'>slot next</emphasis>
 199 followed by
 200 <emphasis remap='B'>eject</emphasis>
 201 does an unnecessary mount.</para>
 202
 203 <para>Note: most changers optimize the
 204 <emphasis remap='B'>slot</emphasis>
 205 commands to not eject the loaded tape if it is the one being requested.</para>
 206 </refsect1>
 207
 208 <refsect1><title>SEE ALSO</title>
 209 <para><citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 210 <ulink url="http://wiki.zmanda.com"/>
 211 </para>
 212 </refsect1>
 213 </refentry>
 214