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"
5 <!-- entities files to use -->
6 <!ENTITY % global_entities SYSTEM 'global.entities'>
10 <!-- lifted from troff+man by doclifter -->
11 <refentry id='amtape.8'>
14 <refentrytitle>amtape</refentrytitle>
15 <manvolnum>8</manvolnum>
21 <refname>amtape</refname>
22 <refpurpose>Control Amanda changers</refpurpose>
29 <!-- body begins here -->
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>
40 <refsect1><title>DESCRIPTION</title>
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" />).
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>
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>
58 <refsect1><title>SUBCOMMANDS</title>
59 <variablelist remap='TP'>
62 <term><command>label</command> <arg choice='plain'><replaceable>label</replaceable></arg></term>
65 <para>Search for and load the Amanda tape with label <arg>label</arg>, also
66 setting the current slot.</para>
71 <term><command>slot</command> <arg choice='plain'><replaceable>slot</replaceable></arg></term>
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.
82 <term><command>current</command></term>
85 <para>Shorthand for <command>slot</command> <arg choice='plain'>current</arg>.</para>
90 <term><command>inventory</command></term>
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>
100 <term><command>show</command></term>
103 <para>Show the contents of all slots by loading each slot and reading its
104 label. This can be very slow.</para>
109 <term><command>reset</command></term>
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>
118 <term><command>eject</command> <arg choice='opt'><replaceable>drive</replaceable></arg></term>
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
128 <term><command>clean</command> <arg choice='opt'><replaceable>drive</replaceable></arg></term>
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
138 <term><command>taper</command></term>
141 <para>Run the taperscan algorithm (see <manref name="amanda-taperscan" vol="7"
142 />), displaying information about the progress of the scan.</para>
147 <term><command>update</command> <arg choice='opt'>what</arg></term>
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>
157 &configoverride.varlistentry;
163 <manref name="amanda-changers" vol="7"/>
164 <manref name="amanda-taperscan" vol="7"/>
165 <manref name="amanda-devices" vol="7"/>