git.gag.com Git - debian/amanda/blob - man/xml-source/amlabel.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 <!-- lifted from troff+man by doclifter -->
  11 <refentry id='amlabel.8'>
  12
  13 <refmeta>
  14 <refentrytitle>amlabel</refentrytitle>
  15 <manvolnum>8</manvolnum>
  16 &rmi.source;
  17 &rmi.version;
  18 &rmi.manual.8;
  19 </refmeta>
  20 <refnamediv>
  21 <refname>amlabel</refname>
  22 <refpurpose>label an Amanda tape</refpurpose>
  23 </refnamediv>
  24 <refentryinfo>
  25 &author.jds;
  26 &author.sgw.xml;
  27 &author.dustin;
  28 </refentryinfo>
  29 <!-- body begins here -->
  30 <refsynopsisdiv>
  31 <cmdsynopsis>
  32   <command>amlabel</command>
  33     <arg><option>-f</option></arg>
  34     &version.synopsis;
  35     &configoverride.synopsis;
  36     <arg choice='plain'><replaceable>config</replaceable></arg>
  37     <arg choice='plain'><replaceable>label</replaceable></arg>
  38     <arg choice='opt'>slot <replaceable>slot</replaceable></arg>
  39 </cmdsynopsis>
  40 </refsynopsisdiv>
  41
  42 <refsect1><title>DESCRIPTION</title>
  43
  44 <para>This command applies a label to an Amanda volume, erasing the volume in
  45 the process.</para>
  46
  47 <para>Amanda uses labels to identify volumes: <manref name="amdump" vol="8" />
  48 and <manref name="amflush" vol="8" /> verify the label before writing to make
  49 sure the proper volume is loaded, and the recovery programs use the label to
  50 ensure they are reading the data they expect.</para>
  51
  52 <para>If no <arg choice="opt"><replaceable>slot</replaceable></arg> is given,
  53 then <command>amlabel</command> labels the tape in the current slot of the
  54 default changer.  If a slot is given, it labels the volume in that slot.
  55 <emphasis remap='I'>Label</emphasis> may be any string that does not contain
  56 whitespace and that matches the <emphasis remap='B'>labelstr</emphasis> (see
  57 <manref name="amanda.conf" vol="5" />).</para>
  58
  59 <para>This command also appends the new volume to the &tapelist; file, so that
  60 they will be used in the order they are labeled (depending on the taperscan in
  61 use &mdash; see <manref name="amanda-taperscan" vol="7" />).</para>
  62
  63 <para>As a precaution, <command>amlabel</command> will not write a label if the
  64 volume already contains an active label or if the label specified is on an
  65 active tape.  The <arg choice="opt">-f</arg> (force) flag bypasses these
  66 verifications.</para>
  67 </refsect1>
  68
  69 <refsect1><title>OPTIONS</title>
  70 <variablelist remap='TP'>
  71
  72   <varlistentry>
  73   <term><option>-f</option></term>
  74   <listitem>
  75   <para>Force the label operation; see above</para>
  76   </listitem>
  77   </varlistentry>
  78
  79   &version.varlistentry;
  80   &configoverride.varlistentry;
  81
  82 </variablelist>
  83 </refsect1>
  84
  85 <refsect1><title>EXAMPLE</title>
  86 <para>Write an Amanda label with the string &quot;DMP000&quot; on
  87 the current volume:</para>
  88
  89 <programlisting>
  90 % amlabel daily DMP000
  91 </programlisting>
  92
  93 <para>Label the tape in slot 3 of the changer with the label
  94 &quot;DMP003&quot;:</para>
  95
  96 <programlisting>
  97 % amlabel daily DMP003 slot 3
  98 </programlisting>
  99 </refsect1>
 100
 101 <refsect1><title>MESSAGES</title>
 102 <variablelist remap='TP'>
 103
 104   <varlistentry>
 105
 106   <term>Label '<replaceable>label</replaceable>' doesn't match labelstr
 107   '<replaceable>labelstr</replaceable>'</term>
 108
 109   <listitem><para>The given label does not match the configured labelstr.  Even
 110   with <option>-f</option>, this is an error.</para></listitem>
 111
 112   </varlistentry>
 113   <varlistentry>
 114
 115   <term>Label '<replaceable>label</replaceable>' already on a volume</term>
 116
 117   <listitem><para>The given label is already on another volume in the tapelist, and
 118   Amanda will not write it to this volume unless forced.</para></listitem>
 119
 120   </varlistentry>
 121   <varlistentry>
 122
 123   <term>Found label '<replaceable>label</replaceable>', but it is not from
 124   configuration <replaceable>config</replaceable>.</term>
 125
 126   <listitem><para>The label <command>amlabel</command> found on the volume does
 127   not match this configuration's <emphasis remap='B'>labelstr</emphasis>, so it
 128   is probably part of a different Amanda configuration.  Amanda will not
 129   overwrite the label unless it is forced.</para> </listitem>
 130
 131   </varlistentry>
 132   <varlistentry>
 133
 134   <term>Volume with label '<emphasis remap='I'>label</emphasis>' contains
 135   data from this configuration.</term>
 136
 137   <listitem> <para>The label <command>amlabel</command> found on the volume
 138   still has valid data on it and Amanda will not overwrite it unless
 139   forced.  Note that this does not distinguish between active and inactive
 140   volumes.</para></listitem>
 141
 142   </varlistentry>
 143   <varlistentry>
 144
 145   </varlistentry>
 146
 147 </variablelist>
 148 </refsect1>
 149
 150 <seealso>
 151 <manref name="amanda.conf" vol="5"/>
 152 <manref name="tapelist" vol="5"/>
 153 <manref name="amanda-taperscan" vol="7"/>
 154 <manref name="amdump" vol="8"/>,
 155 <manref name="amflush" vol="8"/>
 156 </seealso>
 157
 158 </refentry>
 159