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 '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>Control Amanda changers</refpurpose>
  23 </refnamediv>
  24 <refentryinfo>
  25 &author.dustin;
  26 &author.jds;
  27 &author.sgw.xml;
  28 </refentryinfo>
  29 <!-- body begins here -->
  30 <refsynopsisdiv>
  31 <cmdsynopsis>
  32   <command>amtape</command>
  33     &configoverride.synopsis;
  34     <arg choice='plain'><replaceable>config</replaceable></arg>
  35     <arg choice='plain'><replaceable>subcommand</replaceable></arg>
  36     <arg choice='opt' rep='repeat'><replaceable>subcommand_options</replaceable></arg>
  37 </cmdsynopsis>
  38 </refsynopsisdiv>
  39
  40 <refsect1><title>DESCRIPTION</title>
  41
  42 <para><emphasis remap='B'>Amtape</emphasis> is the command-line interface
  43 to Amanda's tape changers (<manref name="amanda-changers" vol="7" />) and to
  44 the taperscan algorithm (<manref name="amanda-taperscan" vol="7" />).
  45 </para>
  46
  47 <para>Tape changers maintain a notion of the <emphasis
  48 remap='I'>current</emphasis> slot for each configuration.  This may or may not
  49 correspond to an actual physical state of the device, but is used by some
  50 taperscan algorithms to minimize searching through the slots.</para>
  51
  52 <para>Amtape uses the default changer.  To use a different changer, use the
  53 config override option, e.g.,
  54 <command>-otpchanger=otherchanger</command>.</para>
  55
  56 </refsect1>
  57
  58 <refsect1><title>SUBCOMMANDS</title>
  59 <variablelist remap='TP'>
  60
  61 <varlistentry>
  62 <term><command>label</command> <arg choice='plain'><replaceable>label</replaceable></arg></term>
  63 <listitem>
  64
  65 <para>Search for and load the Amanda tape with label <arg>label</arg>, also
  66 setting the current slot.</para>
  67
  68 </listitem>
  69 </varlistentry>
  70 <varlistentry>
  71 <term><command>slot</command> <arg choice='plain'><replaceable>slot</replaceable></arg></term>
  72 <listitem>
  73
  74 <para>Load the volume in the given slot, also setting the current slot.  The
  75 slot names <command>current</command>, <command>next</command>,
  76 <command>first</command>, and <command>last</command> have special meaning.
  77 </para>
  78
  79 </listitem>
  80 </varlistentry>
  81 <varlistentry>
  82 <term><command>current</command></term>
  83 <listitem>
  84
  85 <para>Shorthand for <command>slot</command> <arg choice='plain'>current</arg>.</para>
  86
  87 </listitem>
  88 </varlistentry>
  89 <varlistentry>
  90 <term><command>inventory</command></term>
  91 <listitem>
  92
  93 <para>Show the contents of all slots, based on the changer's cached metadata.
  94 This is a quick operation as it does not load or unload any volumes, but is not
  95 supported by all changers.</para>
  96
  97 </listitem>
  98 </varlistentry>
  99 <varlistentry>
 100 <term><command>show</command> <arg choice='opt'>slots</arg></term>
 101 <listitem>
 102
 103 <para>Show the contents of all slots (or listed slots) by loading each slot
 104 and reading its label.  This can be very slow.  The slots arguments is of the form 1,3-5,7.</para>
 105
 106 </listitem>
 107 </varlistentry>
 108 <varlistentry>
 109 <term><command>reset</command></term>
 110 <listitem>
 111
 112 <para>Reset the changer to a known state.  This subcommand is intended to clear
 113 any unknown and potentially incorrect state the changer may have stored.</para>
 114
 115 </listitem>
 116 </varlistentry>
 117 <varlistentry>
 118 <term><command>eject</command> <arg choice='opt'><replaceable>drive</replaceable></arg></term>
 119 <listitem>
 120
 121 <para>Eject the tape currently in the drive.  This only applies to some
 122 changers.  Specify a drive (by drive number) if more than one drive is
 123 available.</para>
 124
 125 </listitem>
 126 </varlistentry>
 127 <varlistentry>
 128 <term><command>clean</command> <arg choice='opt'><replaceable>drive</replaceable></arg></term>
 129 <listitem>
 130
 131 <para>If a cleaning tape is defined for the changer, used it to clean the
 132 specified drive. The <arg>drive</arg> is optional if the changer only has one
 133 drive.</para>
 134
 135 </listitem>
 136 </varlistentry>
 137 <varlistentry>
 138 <term><command>taper</command></term>
 139 <listitem>
 140
 141 <para>Run the taperscan algorithm (see <manref name="amanda-taperscan" vol="7"
 142 />), displaying information about the progress of the scan.</para>
 143
 144 </listitem>
 145 </varlistentry>
 146 <varlistentry>
 147 <term><command>update</command> <arg choice='opt'>what</arg></term>
 148 <listitem>
 149
 150 <para>Update changer state.  Consult <manref name="amanda-changers" vol="7" />
 151 for changer-specific details on the format of <arg
 152 choice='plain'>what</arg>.</para>
 153
 154 </listitem>
 155 </varlistentry>
 156
 157   &configoverride.varlistentry;
 158
 159 </variablelist>
 160 </refsect1>
 161
 162 <seealso>
 163 <manref name="amanda-changers" vol="7"/>
 164 <manref name="amanda-taperscan" vol="7"/>
 165 <manref name="amanda-devices" vol="7"/>
 166 </seealso>
 167
 168 </refentry>
 169