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