mention the S3 storage enablement in the changelog
[debian/amanda] / man / amvault.8
index 5b36e393d5b97e561cd479d74e6b948ea3659a5d..fe6e7c9d64f88ee262d44ebe4f3094acad33b4fb 100644 (file)
+'\" t
 .\"     Title: amvault
 .\"    Author: Dustin J. Mitchell <dustin@zmanda.com>
-.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
-.\"      Date: 01/22/2009
+.\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
+.\"      Date: 10/18/2010
 .\"    Manual: System Administration Commands
-.\"    Source: Amanda 2.6.1
+.\"    Source: Amanda 3.2.0
 .\"  Language: English
 .\"
-.TH "AMVAULT" "8" "01/22/2009" "Amanda 2\&.6\&.1" "System Administration Commands"
-.\" -----------------------------------------------------------------
-.\" * (re)Define some macros
-.\" -----------------------------------------------------------------
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" toupper - uppercase a string (locale-aware)
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.de toupper
-.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
-\\$*
-.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
-..
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" SH-xref - format a cross-reference to an SH section
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.de SH-xref
-.ie n \{\
-.\}
-.toupper \\$*
-.el \{\
-\\$*
-.\}
-..
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" SH - level-one heading that works better for non-TTY output
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.de1 SH
-.\" put an extra blank line of space above the head in non-TTY output
-.if t \{\
-.sp 1
-.\}
-.sp \\n[PD]u
-.nr an-level 1
-.set-an-margin
-.nr an-prevailing-indent \\n[IN]
-.fi
-.in \\n[an-margin]u
-.ti 0
-.HTML-TAG ".NH \\n[an-level]"
-.it 1 an-trap
-.nr an-no-space-flag 1
-.nr an-break-flag 1
-\." make the size of the head bigger
-.ps +3
-.ft B
-.ne (2v + 1u)
-.ie n \{\
-.\" if n (TTY output), use uppercase
-.toupper \\$*
-.\}
-.el \{\
-.nr an-break-flag 0
-.\" if not n (not TTY), use normal case (not uppercase)
-\\$1
-.in \\n[an-margin]u
-.ti 0
-.\" if not n (not TTY), put a border/line under subheading
-.sp -.6
-\l'\n(.lu'
-.\}
-..
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" SS - level-two heading that works better for non-TTY output
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.de1 SS
-.sp \\n[PD]u
-.nr an-level 1
-.set-an-margin
-.nr an-prevailing-indent \\n[IN]
-.fi
-.in \\n[IN]u
-.ti \\n[SN]u
-.it 1 an-trap
-.nr an-no-space-flag 1
-.nr an-break-flag 1
-.ps \\n[PS-SS]u
-\." make the size of the head bigger
-.ps +2
-.ft B
-.ne (2v + 1u)
-.if \\n[.$] \&\\$*
-..
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" BB/BE - put background/screen (filled box) around block of text
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.de BB
-.if t \{\
-.sp -.5
-.br
-.in +2n
-.ll -2n
-.gcolor red
-.di BX
-.\}
-..
-.de EB
-.if t \{\
-.if "\\$2"adjust-for-leading-newline" \{\
-.sp -1
-.\}
-.br
-.di
-.in
-.ll
-.gcolor
-.nr BW \\n(.lu-\\n(.i
-.nr BH \\n(dn+.5v
-.ne \\n(BHu+.5v
-.ie "\\$2"adjust-for-leading-newline" \{\
-\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
-.\}
-.el \{\
-\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
-.\}
-.in 0
-.sp -.5v
-.nf
-.BX
-.in
-.sp .5v
-.fi
-.\}
-..
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" BM/EM - put colored marker in margin next to block of text
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.de BM
-.if t \{\
-.br
-.ll -2n
-.gcolor red
-.di BX
-.\}
-..
-.de EM
-.if t \{\
-.br
-.di
-.ll
-.gcolor
-.nr BH \\n(dn
-.ne \\n(BHu
-\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
-.in 0
-.nf
-.BX
-.in
-.fi
-.\}
-..
+.TH "AMVAULT" "8" "10/18/2010" "Amanda 3\&.2\&.0" "System Administration Commands"
 .\" -----------------------------------------------------------------
 .\" * set default formatting
 .\" -----------------------------------------------------------------
 .\" -----------------------------------------------------------------
 .\" * MAIN CONTENT STARTS HERE *
 .\" -----------------------------------------------------------------
-.SH "Name"
-amvault \- Copy \fIAmanda\fR dumps from one volume to another
-.SH "Synopsis"
-.fam C
+.SH "NAME"
+amvault \- Copy Amanda dumps from one volume to another
+.SH "SYNOPSIS"
 .HP \w'\fBamvault\fR\ 'u
-\fBamvault\fR [\-o\ \fIconfigoption\fR]... \fIconfig\fR \fIsrc\-run\-timestamp\fR \fIdst\-changer\fR \fIlabel\-template\fR
-.fam
+\fBamvault\fR [\fB\-o\fR\ \fIconfigoption\fR...] [\-q] [\-\-quiet] [\-n] [\-\-dry\-run] [\-\-fulls\-only] [\-\-export] [\fB\-\-src\-timestamp\fR\ \fIsrc\-timestamp\fR]
+.br
+\fB\-\-label\-template\fR\ \fIlabel\-template\fR \fB\-\-dst\-changer\fR\ \fIdst\-changer\fR [\fB\-\-autolabel\fR\ \fIautolabel\-arg\fR...]
+.br
+\fIconfig\fR [\fIhostname\fR\ [\ \fIdisk\fR\ [\ \fIdate\fR\ [\ \fIlevel\fR\ [\ \fIhostname\fR\ [\&.\&.\&.]\ ]\ ]\ ]\ ]]
 .SH "WARNING"
 .PP
 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\&.
 .PP
-The significant limitations of this version of amvault are: tapetypes for secondary and tertiary volumes much match (including length and device_properties); tertiary volumes must be blank (manual erasure is required to re\-use tertiary media; 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; and all dumpfiles on a secondary volume are moved to tertiary media \- there is no provision to filter dumps\&.
+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
 .PP
 Feedback on and patches to this application are invited and encouraged!
 .SH "DESCRIPTION"
 .PP
+Amvault is conceptually equivalent to "amfetchdump | taper"\&. That is, it reads specified dumps from secondary media and re\-writes them on tertiary media\&.
+.PP
 \fBAmvault\fR
 Copies data from the run with timestamp
-\fIsrc\-run\-timestamp\fR
+\fBsrc\-timestamp\fR
 onto volumes using the changer
-\fIdst\-changer\fR, labeling new volumes with
-\fIlabel\-template\fR\&. If
-\fIsrc\-run\-timestamp\fR
-is "latest", then the most recent amdump or amflush run will be used\&.
+\fBdst\-changer\fR, and labeling new volumes with
+\fBlabel\-template\fR\&. If
+\fBsrc\-timestamp\fR
+is "latest", then the most recent amdump or amflush run will be used\&. If
+\fB\-\-fulls\-only\fR
+is given, then only full (level\-0) dumps are copied\&.
 .PP
-In a vaulting operation, the source media is referred to as "secondary media", while the destination is referred to as "tertiary media"\&.
+The
+\fB\-\-quiet\fR
+(\fB\-q\fR) option will eliminate non\-error messages, and is useful when running amvault from cron\&. The
+\fB\-\-dry\-run\fR
+(\fB\-n\fR) option will cause amvault to print the dumps it would vault, but not actually perform any vaulting operations\&.
+.SS "Secondary Media"
 .PP
-Each source volume will be copied to a new destination volume; no re\-assembly or splitting will be performed\&. Destination volumes must be at least as large as the source volumes\&.
+The dumps to be read from secondary media can be specified by any combination of dump specifications,
+\fB\-\-fulls\-only\fR, and
+\fB\-\-src\-timestamp\fR\&. At least one must be specified, lest amvault attempt to vault all dumps in the catalog\&. See
+\fBamanda-match\fR(7)
+for more information on dump specifications\&.
+.PP
+Note that the datestamp given in the dumpspec is the
+\fIdump\fR
+datestamp \- the run in which the backup was taken on the Amanda client\&. The
+\fB\-\-src\-timestamp\fR, on the other hand, is the
+\fIwrite\fR
+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\&.
+.SS "Tertiary Media"
+.PP
+The
+\fB\-\-dst\-changer\fR
+must be specified, and names 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\&.
 .PP
 The changer parameter should specify the name of a changer defined in
 \fBamanda.conf\fR(5)\&. For example:
@@ -207,16 +86,44 @@ define changer vaulting_tape {
 }
 .fi
 .PP
-The label template functions identically to the
-\fIlabel\-new\-tapes\fR
+The
+\fB\-\-label\-template\fR
+option is required, and specifies a label template which is used to generate new labels for tertiary volumes\&. The
+\fB\-\-autolabel\fR
+option works just like the
+\fBautolabel\fR
 parameter in
-\fBamanda.conf\fR(5)\&.
+\fBamanda.conf\fR(5), and can be specified multiple times if necessary\&. The default is \'empty\'\&.
+.PP
+If
+\fBamanda.conf\fR(5)
+contains the new
+\fBpart\-size\fR
+splitting parameters, then amvault will use them without any additional configuration\&. However, if the configuration still uses the old splitting parameters (\fBtape_splitsize\fR,
+\fBsplit_diskbuffer\fR, and
+\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
+\fBamanda.conf\fR(5), say "TERTIARY", and set the
+\fBpart\-size\fR
+and other appropriate parameters there\&. Then reference that tapetype in the amvault invocation:
+.sp
+.nf
+    amvault \-otapetype=TERTIARY \&.\&.\&.
+.fi
+.PP
+The
+\fB\-\-export\fR
+option will cause amvault to attempt to move completed tertiary volumes to import/export slots, where they can be more easily removed by an operator\&.
 .SH "SEE ALSO"
 .PP
-\fBamanda\fR(8)
-.SH "Author"
+\fBamanda\fR(8),
+\fBamanda-changers\fR(7),
+\fBamfetchdump\fR(8)
+.PP
+The Amanda Wiki:
+: http://wiki.zmanda.com/
+.SH "AUTHOR"
 .PP
 \fBDustin J\&. Mitchell\fR <\&dustin@zmanda\&.com\&>
 .RS 4
-Zmanda, Inc\&. (\FChttp://www\&.zmanda\&.com\F[])
+Zmanda, Inc\&. (http://www\&.zmanda\&.com)
 .RE