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