Imported Upstream version 3.2.0
[debian/amanda] / man / xml-source / amvault.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 <refentry id='amvault.8'>
11 <refmeta>
12 <refentrytitle>amvault</refentrytitle>
13 <manvolnum>8</manvolnum>
14 &rmi.source;
15 &rmi.version;
16 &rmi.manual.8;
17 </refmeta>
18 <refnamediv>
19 <refname>amvault</refname>
20 <refpurpose>Copy Amanda dumps from one volume to another</refpurpose>
21 </refnamediv>
22 <refentryinfo>
23 &author.dustin;
24 </refentryinfo>
25 <!-- body begins here -->
26 <refsynopsisdiv>
27 <cmdsynopsis>
28   <command>amvault</command>
29     &configoverride.synopsis;
30     <arg choice='opt'>-q</arg> <arg choice='opt'>--quiet</arg>
31     <arg choice='opt'>-n</arg> <arg choice='opt'>--dry-run</arg>
32     <arg choice='opt'>--fulls-only </arg>
33     <arg choice='opt'>--export </arg>
34     <arg choice='opt'><option>--src-timestamp</option>
35         <replaceable>src-timestamp</replaceable></arg>
36     <sbr/>
37     <arg choice='plain'><option>--label-template</option>
38             <replaceable>label-template</replaceable></arg>
39     <arg choice='plain'><option>--dst-changer</option>
40             <replaceable>dst-changer</replaceable></arg>
41     <arg choice='opt' rep='repeat'><option>--autolabel</option>
42             <replaceable>autolabel-arg</replaceable></arg>
43     <sbr/>
44     <arg choice='plain'><replaceable>config</replaceable></arg>
45     <arg choice='opt'>
46       <arg choice='plain'><replaceable>hostname</replaceable></arg>
47       <arg choice='opt'>
48         <arg choice='plain'><replaceable>disk</replaceable></arg>
49         <arg choice='opt'>
50           <arg choice='plain'><replaceable>date</replaceable></arg>
51           <arg choice='opt'>
52             <arg choice='plain'><replaceable>level</replaceable></arg>
53             <arg choice='opt'>
54               <arg choice='plain'><replaceable>hostname</replaceable></arg>
55               <arg choice='opt'>...</arg>
56             </arg>
57           </arg>
58         </arg>
59       </arg>
60     </arg>
61 </cmdsynopsis>
62 </refsynopsisdiv>
63
64 <refsect1><title>WARNING</title>
65
66 <para>This application is not yet in its final form, and is subject to major revision
67 in subsequent versions of Amanda.  Backward compatibility is not guaranteed.</para>
68
69 <para>Note that Amanda restore/recover operations will request tertiary media
70 by label when dumpfiles are not found on secondary media, but there is no
71 provision to automatically fetch such media from a different changer</para>
72
73 <para>Feedback on and patches to this application are invited and
74 encouraged!</para>
75
76 </refsect1>
77
78 <refsect1><title>DESCRIPTION</title>
79
80 <para>Amvault is conceptually equivalent to "amfetchdump | taper".  That is, it reads
81 specified dumps from secondary media and re-writes them on tertiary media.</para>
82
83 <para><emphasis remap='B'>Amvault</emphasis> Copies data from the run with
84 timestamp <option>src-timestamp</option> onto volumes using the changer
85 <option>dst-changer</option>, and labeling new volumes with
86 <option>label-template</option>.  If <option>src-timestamp</option> is
87 "latest", then the most recent amdump or amflush run will be used.  If
88 <option>--fulls-only</option> is given, then only full (level-0) dumps are
89 copied.</para>
90
91 <para>The <option>--quiet</option> (<option>-q</option>) option will
92 eliminate non-error messages, and is useful when running amvault from
93 cron.  The <option>--dry-run</option> (<option>-n</option>) option will
94 cause amvault to print the dumps it would vault, but not actually perform
95 any vaulting operations.</para>
96
97 <refsect2><title>Secondary Media</title>
98
99 <para>The dumps to be read from secondary media can be specified by any
100 combination of dump specifications, <option>--fulls-only</option>, and
101 <option>--src-timestamp</option>.  At least one must be specified, lest
102 amvault attempt to vault all dumps in the catalog.  See <manref
103     name="amanda-match" vol="7"/> for more information on dump
104 specifications.</para>
105
106 <para>Note that the datestamp given in the dumpspec is the
107 <emphasis>dump</emphasis> datestamp - the run in which the backup was taken
108 on the Amanda client.  The <option>--src-timestamp</option>, on the other
109 hand, is the <emphasis>write</emphasis> timestamp - the run in which the
110 dump was written to secondary media.  The latter option facilitates
111 duplicating the results of an entire backup run, including any dumps that
112 might have been flushed from holding disk.</para>
113
114 </refsect2>
115
116 <refsect2><title>Tertiary Media</title>
117
118 <para>The <option>--dst-changer</option> must be specified, and names the changer
119 in which tertiary media are stored.  In general, this should be different
120 from the secondary changer, to eliminate the possibility of overwriting
121 secondary media with tertiary data.</para>
122
123 <para>The changer parameter should specify the name of a changer defined in
124 &amconf;.  For example:
125 <programlisting>
126 define changer vaulting_tape {
127     tapedev "/dev/rmt/1n"
128     tpchanger "chg-zd-mtx"
129     changerdev "/dev/sg0"
130     changerfile "vaulting-changer.conf"
131 }
132 </programlisting></para>
133
134 <para>The <option>--label-template</option> option is required, and specifies a
135 label template which is used to generate new labels for tertiary volumes.
136 The <option>--autolabel</option> option works just like the
137 <amkeyword>autolabel</amkeyword> parameter in &amconf;, and can be
138 specified multiple times if necessary.  The default is 'empty'.</para>
139
140 <para>If &amconf; contains the new <amkeyword>part-size</amkeyword>
141 splitting parameters, then amvault will use them without any additional configuration.
142 However, if the configuration still uses the old splitting parameters
143 (<amkeyword>tape_splitsize</amkeyword>,
144 <amkeyword>split_diskbuffer</amkeyword>, and
145 <amkeyword>fallback_splitsize</amkeyword>), then amvault will need some
146 additional configuration in order to properly split dumps to tertiary
147 media.  To do so, specify a new tapetype in &amconf;, say "TERTIARY",
148 and set the <amkeyword>part-size</amkeyword> and other appropriate
149 parameters there.  Then reference that tapetype in the amvault invocation:
150 <programlisting>
151     amvault -otapetype=TERTIARY ...
152 </programlisting></para>
153
154 <para>The <option>--export</option> option will cause amvault to attempt to move
155 completed tertiary volumes to import/export slots, where they can be
156 more easily removed by an operator.</para>
157
158 </refsect2>
159
160 </refsect1>
161
162 <seealso>
163 <manref name="amanda-changers" vol="7"/>
164 <manref name="amfetchdump" vol="8"/>
165 </seealso>
166
167 </refentry>
168