Imported Upstream version 3.1.0
[debian/amanda] / man / xml-source / amrmtape.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='amrmtape.8'>
12
13 <refmeta>
14 <refentrytitle>amrmtape</refentrytitle>
15 <manvolnum>8</manvolnum>
16 &rmi.source;
17 &rmi.version;
18 &rmi.manual.8;
19 </refmeta>
20 <refnamediv>
21 <refname>amrmtape</refname>
22 <refpurpose>remove a tape from the Amanda database</refpurpose>
23 </refnamediv>
24 <refentryinfo>
25 &author.atf3r;
26 &author.sgw.xml;
27 </refentryinfo>
28 <!-- body begins here -->
29 <refsynopsisdiv>
30 <cmdsynopsis>
31   <command>amrmtape</command>
32     <arg choice='opt'>--changer <replaceable>changer-name</replaceable> </arg>
33     <arg choice='opt'>--cleanup </arg>
34     <arg choice='opt'>--dryrun </arg>
35     <arg choice='opt'>-n </arg>
36     <arg choice='opt'>--erase </arg>
37     <arg choice='opt'>--keep-label </arg>
38     <arg choice='opt'>--quiet </arg>
39     <arg choice='opt'>-q </arg>
40     <arg choice='opt'>--verbose </arg>
41     <arg choice='opt'>-v </arg>
42     <arg choice='plain'><replaceable>config</replaceable></arg>
43     <arg choice='plain'><replaceable>label</replaceable></arg>
44 </cmdsynopsis>
45 </refsynopsisdiv>
46
47
48 <refsect1><title>DESCRIPTION</title>
49 <para><emphasis remap='B'>Amrmtape</emphasis>
50 invalidates the contents of an existing backup tape
51 in the configuration database.
52 This is meant as a recovery mechanism when a
53 good backup is damaged either by faulty hardware or user error,
54 e.g. the tape is eaten by the drive or is overwritten.</para>
55
56 <para>See the
57 <manref name="amanda" vol="8"/>
58 man page for more details about Amanda.</para>
59 </refsect1>
60
61 <refsect1><title>OPTIONS</title>
62 <variablelist remap='TP'>
63   <varlistentry>
64   <term><option>--changer <replaceable>changer-name</replaceable> </option></term>
65   <listitem>
66 <para>Specify which changer to use when erasing
67 <emphasis remap='I'>label</emphasis>
68 </para>
69   </listitem>
70   </varlistentry>
71   <varlistentry>
72   <term><option>--cleanup</option></term>
73   <listitem>
74 <para>Remove logs and indexes associated with
75 <emphasis remap='I'>label</emphasis>.
76 Otherwise, they'll remain until the next run of amdump.
77 </para>
78   </listitem>
79   </varlistentry>
80   <varlistentry>
81   <term><option>--dryrun</option></term>
82   <term><option>-n</option></term>
83   <listitem>
84 <para>Generate new &tapelist; and database files with
85 <emphasis remap='I'>label</emphasis>
86 removed, but leave them in
87 <filename>/tmp</filename>
88 and do not update the original copies.</para>
89   </listitem>
90   </varlistentry>
91   <varlistentry>
92   <term><option>--erase</option></term>
93   <listitem>
94 <para>Attempt to erase the data contained on the volume with the given label.
95 This requires that Amanda be able to find that volume using the tape changer.
96 Erasure is not supported by all Amanda devices, and the erasure is not "secure"
97 in the sense that the data can most likely be recovered by someone with the
98 right tools.  </para>
99   </listitem>
100   </varlistentry>
101   <varlistentry>
102   <term><option>--keep-label</option></term>
103   <listitem>
104 <para>Do not remove
105 <emphasis remap='I'>label</emphasis>
106 from the tapelist.
107 </para>
108   </listitem>
109   </varlistentry>
110   <varlistentry>
111   <term><option>--verbose</option></term>
112   <term><option>-v</option></term>
113   <listitem>
114 <para>List backups of hosts and disks that are being discarded.  Enabled by default.</para>
115   </listitem>
116   </varlistentry>
117   <varlistentry>
118   <term><option>--quiet</option></term>
119   <term><option>-q</option></term>
120   <listitem>
121 <para>Opposite of
122 <option>-v</option>.</para>
123   </listitem>
124   </varlistentry>
125 </variablelist>
126 </refsect1>
127
128 <refsect1><title>EXAMPLE</title>
129 <para>Remove tape labeled
130 <emphasis remap='I'>DAILY034</emphasis>
131 from the
132 <emphasis remap='I'>DailySet1</emphasis>
133 configuration.</para>
134
135 <programlisting>
136 # amrmtape DailySet1 DAILY034
137 </programlisting>
138 </refsect1>
139
140 <seealso>
141 <manref name="amadmin" vol="8"/>
142 </seealso>
143
144 </refentry>