Imported Upstream version 3.3.2
[debian/amanda] / man / amvault.8
1 '\" t
2 .\"     Title: amvault
3 .\"    Author: Dustin J. Mitchell <dustin@zmanda.com>
4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
5 .\"      Date: 07/25/2012
6 .\"    Manual: System Administration Commands
7 .\"    Source: Amanda 3.3.2
8 .\"  Language: English
9 .\"
10 .TH "AMVAULT" "8" "07/25/2012" "Amanda 3\&.3\&.2" "System Administration Commands"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el       .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 amvault \- Copy Amanda dumps from one volume to another
32 .SH "SYNOPSIS"
33 .HP \w'\fBamvault\fR\ 'u
34 \fBamvault\fR [\fB\-o\fR\ \fIconfigoption\fR...] [\-\-dry\-run | \-n] [\-\-quiet | \-q] [\-\-fulls\-only] [\-\-export] [\fB\-\-src\-timestamp\fR\ \fIsrc\-timestamp\fR]
35 .br
36 \fB\-\-label\-template\fR\ \fIlabel\-template\fR \fB\-\-dst\-changer\fR\ \fIdst\-changer\fR [\fB\-\-autolabel\fR\ \fIautolabel\-arg\fR...]
37 .br
38 \fIconfig\fR [\fIhostname\fR\ [\ \fIdisk\fR\ [\ \fIdate\fR\ [\ \fIlevel\fR\ [\ \fIhostname\fR\ [\&.\&.\&.]\ ]\ ]\ ]\ ]]
39 .SH "WARNING"
40 .PP
41 This application is not yet in its final form, and is subject to major revision in subsequent versions of Amanda\&. Backward compatibility is not guaranteed\&.
42 .PP
43 Note that Amanda restore/recover operations will request tertiary media by label when dumpfiles are not found on secondary media, but there is no provision to automatically fetch such media from a different changer
44 .PP
45 Feedback on and patches to this application are invited and encouraged!
46 .SH "DESCRIPTION"
47 .PP
48 Amvault is conceptually equivalent to "amfetchdump | taper"\&. That is, it reads specified dumps from secondary media and re\-writes them on tertiary media\&.
49 .PP
50 \fBAmvault\fR
51 Copies data from the run with timestamp
52 \fBsrc\-timestamp\fR
53 onto volumes using the changer
54 \fBdst\-changer\fR, and labeling new volumes with
55 \fBlabel\-template\fR\&.
56 .SS "Secondary Media"
57 .PP
58 The dumps to be read from secondary media can be specified by any combination of dump specifications,
59 \fB\-\-fulls\-only\fR, and
60 \fB\-\-src\-timestamp\fR\&. At least one must be specified, lest amvault attempt to vault all dumps in the catalog\&. See
61 \fBamanda-match\fR(7)
62 for more information on dump specifications\&.
63 .PP
64 Note that the datestamp given in the dumpspec is the
65 \fIdump\fR
66 datestamp \- the run in which the backup was taken on the Amanda client\&. The
67 \fB\-\-src\-timestamp\fR, on the other hand, is the
68 \fIwrite\fR
69 timestamp \- the run in which the dump was written to secondary media\&. The latter option facilitates duplicating the results of an entire backup run, including any dumps that might have been flushed from holding disk\&.
70 .SS "Tertiary Media"
71 .PP
72 The
73 \fB\-\-dst\-changer\fR
74 must be specified, and names the changer in which tertiary media are stored\&.
75 .PP
76 If
77 \fBamanda.conf\fR(5)
78 contains the new
79 \fBpart\-size\fR
80 splitting parameters, then amvault will use them without any additional configuration\&. However, if the configuration still uses the old splitting parameters (\fBtape_splitsize\fR,
81 \fBsplit_diskbuffer\fR, and
82 \fBfallback_splitsize\fR), then amvault will need some additional configuration in order to properly split dumps to tertiary media\&. To do so, specify a new tapetype in
83 \fBamanda.conf\fR(5), say "TERTIARY", and set the
84 \fBpart\-size\fR
85 and other appropriate parameters there\&. Then reference that tapetype in the amvault invocation:
86 .sp
87 .nf
88     amvault \-otapetype=TERTIARY \&.\&.\&.
89 .fi
90 .SH "OPTIONS"
91 .PP
92 \fB\-\-autolabel\fR [any] [other\-config] [non\-amanda] [volume\-error] [empty]
93 .RS 4
94 Works just like the
95 \fBautolabel\fR
96 parameter in
97 \fBamanda.conf\fR(5), and can be specified multiple times if necessary\&. The default is \*(Aqempty\*(Aq\&.
98 .RE
99 .PP
100 \fB\-\-dst\-changer\fR \fIdst\-changer\fR
101 .RS 4
102 Specifies the changer in which tertiary media are stored\&. In general, this should be different from the secondary changer, to eliminate the possibility of overwriting secondary media with tertiary data\&.
103 .sp
104 The
105 \fBdst\-changer\fR
106 parameter should specify the name of a changer defined in
107 \fBamanda.conf\fR(5)\&. For example:
108 .sp
109 .nf
110 define changer vaulting_tape {
111     tapedev "/dev/rmt/1n"
112     tpchanger "chg\-zd\-mtx"
113     changerdev "/dev/sg0"
114     changerfile "vaulting\-changer\&.conf"
115 }
116 .fi
117 .RE
118 .PP
119 \fB\-\-dry\-run\fR, \fB\-n\fR
120 .RS 4
121 Cause amvault to print the dumps it would vault, but not actually perform any vaulting operations\&.
122 .RE
123 .PP
124 \fB\-\-export\fR
125 .RS 4
126 Cause amvault to attempt to move completed tertiary volumes to import/export slots, where they can be more easily removed by an operator\&.
127 .RE
128 .PP
129 \fB\-\-\-fulls\-only\fR
130 .RS 4
131 Only full (level\-0) dumps are copied\&.
132 .RE
133 .PP
134 \fB\-\-label\-template\fR \fIlabel\-template\fR
135 .RS 4
136 Specifies a label template which is used to generate new labels for tertiary volumes\&.
137 .RE
138 .PP
139 \fB\-\-quiet\fR, \fB\-q\fR
140 .RS 4
141 Eliminate non\-error messages, and is useful when running amvault from cron\&.
142 .RE
143 .PP
144 \fB\-\-src\-timestamps\fR \fIsrc\-timestamps\fR
145 .RS 4
146 Specifies the timestamps in the format \*(AqYYYYMMDDHHMMSS\*(Aq of the run to vault, can be "latest", then the most recent amdump or amflush run will be used\&.
147 .RE
148 .PP
149 \fB\-o\fR \fIconfigoption\fR
150 .RS 4
151 See the "\fBCONFIGURATION OVERRIDE\fR" section in
152 \fBamanda\fR(8)\&.
153 .RE
154 .SH "EXAMPLES"
155 .PP
156 Vault all dump written to tape in the latest amdump or amflush run:
157 .nf
158 $ amvault \-\-src\-timestamps latest \-\-label\-template "CONF\-%%%" \-\-dst\-changer vault\-changer CONF
159 .fi
160 .PP
161 Vault all dump written on the run of December 7 2011 12:13:14 :
162 .nf
163 $ amvault \-\-src\-timestamps 20111207121314 \-\-label\-template "CONF\-%%%" \-\-dst\-changer vault\-changer CONF
164 .fi
165 .PP
166 Vault all dump dumped on any run of December 7 2011:
167 .nf
168 $ amvault \-\-label\-template "CONF\-%%%" \-\-dst\-changer vault\-changer CONF \e* \e* 20111207
169 .fi
170 .SH "SEE ALSO"
171 .PP
172 \fBamanda\fR(8),
173 \fBamanda-changers\fR(7),
174 \fBamfetchdump\fR(8)
175 .PP
176 The Amanda Wiki:
177 : http://wiki.zmanda.com/
178 .SH "AUTHOR"
179 .PP
180 \fBDustin J\&. Mitchell\fR <\&dustin@zmanda\&.com\&>
181 .RS 4
182 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
183 .RE