Imported Upstream version 3.1.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|--quiet</arg>
31     <arg choice='plain'><replaceable>config</replaceable></arg>
32     <arg choice='plain'><replaceable>src-run-timestamp</replaceable></arg>
33     <arg choice='plain'><replaceable>dst-changer</replaceable></arg>
34     <arg choice='plain'><replaceable>label-template</replaceable></arg>
35 </cmdsynopsis>
36 </refsynopsisdiv>
37
38 <refsect1><title>WARNING</title>
39 <para>This application is not yet in its final form, and is subject to major revision
40 in subsequent versions of Amanda.  Backward compatibility is not guaranteed.</para>
41
42 <para>The significant limitations of this version of amvault are: tapetypes for
43 secondary and tertiary volumes much match (including length and
44 device_properties); tertiary volumes must be blank (manual erasure is required
45 to re-use tertiary media; restore/recover operations will request tertiary
46 media by label when dumpfiles are not found on secondary media, but there is no
47 provision to automatically fetch such media from a different changer; and all
48 dumpfiles on a secondary volume are moved to tertiary media - there is no
49 provision to filter dumps.</para>
50
51 <para>Feedback on and patches to this application are invited and
52 encouraged!</para>
53
54 </refsect1>
55
56 <refsect1><title>DESCRIPTION</title>
57
58 <para><emphasis remap='B'>Amvault</emphasis> Copies data from the run with
59 timestamp <emphasis remap='I'>src-run-timestamp</emphasis> onto volumes using
60 the changer <emphasis remap='I'>dst-changer</emphasis>, labeling new volumes
61 with <emphasis remap='I'>label-template</emphasis>.  If <emphasis
62 remap='I'>src-run-timestamp</emphasis> is "latest", then the most recent amdump
63 or amflush run will be used.</para>
64
65 <para>In a vaulting operation, the source media is referred to as "secondary
66 media", while the destination is referred to as "tertiary media".</para>
67
68 <para>Each source volume will be copied to a new destination volume; no
69 re-assembly or splitting will be performed.  Destination volumes must be at
70 least as large as the source volumes.</para>
71
72 <para>The changer parameter should specify the name of a changer defined in
73 &amconf;.  For example:
74 <programlisting>
75 define changer vaulting_tape {
76     tapedev "/dev/rmt/1n"
77     tpchanger "chg-zd-mtx"
78     changerdev "/dev/sg0"
79     changerfile "vaulting-changer.conf"
80 }
81 </programlisting></para>
82
83 <para>The <emphasis>--quiet</emphasis> option reduces the verbosity of the
84 utility; this can be useful for volumes containing many split parts.  The
85 <emphasis>--autolabel</emphasis> option defines which tertiary volumes
86 amlabel will overwrite.  It can have any of the values defined for
87 <amkeyword>autolabel</amkeyword> in <manref name="amanda.conf" vol="5" />,
88 with the addition of "this_config", meaning volumes matching the labelstr
89 for this configuration.  The option defaults to "empty".  Multiple
90 values can be separated with commas.  The label template functions
91 identically to the template for teh <amkeyword>autolabel</amkeyword>
92 parameter.</para>
93
94 </refsect1>
95
96 <seealso>
97 <manref name="amanda-changers" vol="7"/>
98 </seealso>
99
100 </refentry>
101