git.gag.com Git - debian/amanda/blob - 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     <group choice='opt'><arg choice='plain'>--dry-run</arg><arg choice='plain'>-n</arg></group>
  31     <group choice='opt'><arg choice='plain'>--quiet</arg><arg choice='plain'>-q</arg></group>
  32     <arg choice='opt'>--fulls-only </arg>
  33     <arg choice='opt'>--exact-match </arg>
  34     <arg choice='opt'>--export </arg>
  35     <arg choice='opt'><option>--src-timestamp</option>
  36         <replaceable>src-timestamp</replaceable></arg>
  37     <sbr/>
  38     <arg choice='plain'><option>--label-template</option>
  39             <replaceable>label-template</replaceable></arg>
  40     <arg choice='plain'><option>--dst-changer</option>
  41             <replaceable>dst-changer</replaceable></arg>
  42     <arg choice='opt' rep='repeat'><option>--autolabel</option>
  43             <replaceable>autolabel-arg</replaceable></arg>
  44     <sbr/>
  45     <arg choice='plain'><replaceable>config</replaceable></arg>
  46     <arg choice='opt'>
  47       <arg choice='plain'><replaceable>hostname</replaceable></arg>
  48       <arg choice='opt'>
  49         <arg choice='plain'><replaceable>disk</replaceable></arg>
  50         <arg choice='opt'>
  51           <arg choice='plain'><replaceable>date</replaceable></arg>
  52           <arg choice='opt'>
  53             <arg choice='plain'><replaceable>level</replaceable></arg>
  54             <arg choice='opt'>
  55               <arg choice='plain'><replaceable>hostname</replaceable></arg>
  56               <arg choice='opt'>...</arg>
  57             </arg>
  58           </arg>
  59         </arg>
  60       </arg>
  61     </arg>
  62 </cmdsynopsis>
  63 </refsynopsisdiv>
  64
  65 <refsect1><title>WARNING</title>
  66
  67 <para>This application is not yet in its final form, and is subject to major revision
  68 in subsequent versions of Amanda.  Backward compatibility is not guaranteed.</para>
  69
  70 <para>Note that Amanda restore/recover operations will request tertiary media
  71 by label when dumpfiles are not found on secondary media, but there is no
  72 provision to automatically fetch such media from a different changer</para>
  73
  74 <para>Feedback on and patches to this application are invited and
  75 encouraged!</para>
  76
  77 </refsect1>
  78
  79 <refsect1><title>DESCRIPTION</title>
  80
  81 <para>Amvault is conceptually equivalent to "amfetchdump | taper".  That is, it reads
  82 specified dumps from secondary media and re-writes them on tertiary media.</para>
  83
  84 <para><emphasis remap='B'>Amvault</emphasis> Copies data from the run with
  85 timestamp <option>src-timestamp</option> onto volumes using the changer
  86 <option>dst-changer</option>, and labeling new volumes with
  87 <option>label-template</option>.</para>
  88
  89 <refsect2><title>Secondary Media</title>
  90
  91 <para>The dumps to be read from secondary media can be specified by any
  92 combination of dump specifications, <option>--fulls-only</option>, and
  93 <option>--src-timestamp</option>.  At least one must be specified, lest
  94 amvault attempt to vault all dumps in the catalog.  See <manref
  95     name="amanda-match" vol="7"/> for more information on dump
  96 specifications.</para>
  97
  98 <para>Note that the datestamp given in the dumpspec is the
  99 <emphasis>dump</emphasis> datestamp - the run in which the backup was taken
 100 on the Amanda client.  The <option>--src-timestamp</option>, on the other
 101 hand, is the <emphasis>write</emphasis> timestamp - the run in which the
 102 dump was written to secondary media.  The latter option facilitates
 103 duplicating the results of an entire backup run, including any dumps that
 104 might have been flushed from holding disk.</para>
 105
 106 </refsect2>
 107
 108 <refsect2><title>Tertiary Media</title>
 109
 110 <para>The <option>--dst-changer</option> must be specified, and names the
 111 changer in which tertiary media are stored.</para>
 112
 113 <para>If &amconf; contains the new <amkeyword>part-size</amkeyword>
 114 splitting parameters, then amvault will use them without any additional configuration.
 115 However, if the configuration still uses the old splitting parameters
 116 (<amkeyword>tape_splitsize</amkeyword>,
 117 <amkeyword>split_diskbuffer</amkeyword>, and
 118 <amkeyword>fallback_splitsize</amkeyword>), then amvault will need some
 119 additional configuration in order to properly split dumps to tertiary
 120 media.  To do so, specify a new tapetype in &amconf;, say "TERTIARY",
 121 and set the <amkeyword>part-size</amkeyword> and other appropriate
 122 parameters there.  Then reference that tapetype in the amvault invocation:
 123 <programlisting>
 124     amvault -otapetype=TERTIARY ...
 125 </programlisting></para>
 126
 127 </refsect2>
 128
 129 </refsect1>
 130
 131 <refsect1><title>OPTIONS</title>
 132 <variablelist remap='TP'>
 133   <varlistentry>
 134   <term><option>--autolabel</option> <arg choice='opt'>any</arg>
 135                                      <arg choice='opt'>other-config</arg>
 136                                      <arg choice='opt'>non-amanda</arg>
 137                                      <arg choice='opt'>volume-error</arg>
 138                                      <arg choice='opt'>empty</arg></term>
 139   <listitem>
 140 <para>Works just like the
 141 <amkeyword>autolabel</amkeyword> parameter in &amconf;, and can be
 142 specified multiple times if necessary.  The default is 'empty'.</para>
 143   </listitem>
 144   </varlistentry>
 145
 146   <varlistentry>
 147   <term><option>--dst-changer</option> <replaceable>dst-changer</replaceable></term>
 148   <listitem>
 149 <para>Specifies the changer
 150 in which tertiary media are stored.  In general, this should be different
 151 from the secondary changer, to eliminate the possibility of overwriting
 152 secondary media with tertiary data.</para>
 153
 154 <para>The <amkeyword>dst-changer</amkeyword> parameter should specify the name of a changer defined in
 155 &amconf;.  For example:
 156 <programlisting>
 157 define changer vaulting_tape {
 158     tapedev "/dev/rmt/1n"
 159     tpchanger "chg-zd-mtx"
 160     changerdev "/dev/sg0"
 161     changerfile "vaulting-changer.conf"
 162 }
 163 </programlisting></para>
 164   </listitem>
 165   </varlistentry>
 166
 167   <varlistentry>
 168   <term><option>--dry-run</option></term><term><option>-n</option></term>
 169   <listitem>
 170 <para>Cause amvault to print the dumps it would vault, but not actually
 171 perform any vaulting operations.</para>
 172   </listitem>
 173   </varlistentry>
 174
 175   <varlistentry>
 176   <term><option>--exact-match</option></term>
 177   <listitem>
 178 <para>The host and disk are parsed as exact values</para>
 179   </listitem>
 180   </varlistentry>
 181
 182   <varlistentry>
 183   <term><option>--export</option></term>
 184   <listitem>
 185 <para>Cause amvault to attempt to move completed tertiary volumes to
 186 import/export slots, where they can be more easily removed by an operator.
 187 </para>
 188   </listitem>
 189   </varlistentry>
 190
 191   <varlistentry>
 192   <term><option>---fulls-only</option></term>
 193   <listitem>
 194 <para>Only full (level-0) dumps are copied.</para>
 195   </listitem>
 196   </varlistentry>
 197
 198   <varlistentry>
 199   <term><option>--label-template</option> <replaceable>label-template</replaceable></term>
 200   <listitem>
 201 <para>Specifies a label template which is used to generate new labels for
 202 tertiary volumes.</para>
 203   </listitem>
 204   </varlistentry>
 205
 206   <varlistentry>
 207   <term><option>--quiet</option></term><term><option>-q</option></term>
 208   <listitem>
 209 <para>Eliminate non-error messages, and is useful when running amvault from
 210 cron.</para>
 211   </listitem>
 212   </varlistentry>
 213
 214   <varlistentry>
 215   <term><option>--src-timestamps</option> <replaceable>src-timestamps</replaceable></term>
 216   <listitem>
 217 <para>Specifies the timestamps in the format 'YYYYMMDDHHMMSS' of the run to
 218 vault, can be "latest", then the most recent amdump or amflush run will be
 219 used.</para>
 220   </listitem>
 221   </varlistentry>
 222
 223  <varlistentry>
 224   <term><option>-o</option> <replaceable>configoption</replaceable></term>
 225   <listitem>
 226 <para>See the "<emphasis remap='B'>CONFIGURATION OVERRIDE</emphasis>"
 227  section in <manref name="amanda" vol="8"/>.</para>
 228   </listitem>
 229   </varlistentry>
 230
 231 </variablelist>
 232
 233
 234 </refsect1>
 235
 236 <refsect1><title>EXAMPLES</title>
 237
 238 <para>Vault all dump written to tape in the latest amdump or amflush run:</para>
 239 <programlisting>
 240 $ amvault --src-timestamps latest --label-template "CONF-%%%" --dst-changer vault-changer CONF
 241 </programlisting>
 242
 243 <para>Vault all dump written on the run of December 7 2011 12:13:14 :</para>
 244 <programlisting>
 245 $ amvault --src-timestamps 20111207121314 --label-template "CONF-%%%" --dst-changer vault-changer CONF
 246 </programlisting>
 247
 248 <para>Vault all dump dumped on any run of December 7 2011:</para>
 249 <programlisting>
 250 $ amvault --label-template "CONF-%%%" --dst-changer vault-changer CONF \* \* 20111207
 251 </programlisting>
 252
 253 </refsect1>
 254
 255 <seealso>
 256 <manref name="amanda-changers" vol="7"/>
 257 <manref name="amfetchdump" vol="8"/>
 258 </seealso>
 259
 260 </refentry>
 261