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 '../entities/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 &A; tape</refpurpose>
  23 </refnamediv>
  24 <refentryinfo>
  25 &author.jds;
  26 &author.sgw.xml;
  27 </refentryinfo>
  28 <!-- body begins here -->
  29 <refsynopsisdiv>
  30 <cmdsynopsis>
  31   <command>amlabel</command>
  32     <arg choice='opt'>-f </arg>
  33     <arg choice='plain'><replaceable>config</replaceable></arg>
  34     <arg choice='plain'><replaceable>label</replaceable></arg>
  35     <arg choice='opt'>slot <replaceable>slot</replaceable></arg>
  36     <arg choice='plain' rep='repeat'><group><arg choice='plain'>-o </arg><replaceable>configoption</replaceable></group></arg>
  37 </cmdsynopsis>
  38 </refsynopsisdiv>
  39
  40
  41 <refsect1><title>DESCRIPTION</title>
  42 <para>All &A; tapes must be pre-labeled before they are used.
  43 &A; verifies the label in
  44 <emphasis remap='B'>amdump</emphasis>
  45 and
  46 <emphasis remap='B'>amflush</emphasis>
  47 before writing to make sure the proper tape is loaded.</para>
  48
  49 <para><emphasis remap='B'>Amlabel</emphasis>
  50 writes an &A; label on the tape in the device specified by the
  51 <emphasis remap='I'>amanda.conf</emphasis>
  52 file in /usr/local/etc/amanda/<emphasis remap='I'>config</emphasis>.
  53 <emphasis remap='I'>Label</emphasis>
  54 may be any string that does not contain whitespace and that matches the
  55 <emphasis remap='I'>amanda.conf</emphasis>
  56 <emphasis remap='B'>labelstr</emphasis>
  57 regular expression option.
  58 It is up to the system administrator to define a naming convention.</para>
  59
  60 <para><emphasis remap='B'>Amlabel</emphasis>
  61 appends the new tape to the &tapelist;
  62 file so it will be used by &A; before it reuses any other tapes.
  63 When you
  64 <command>amlabel</command>
  65 multiple tapes, they will be used in the order you
  66 <command>amlabel</command>
  67 them.</para>
  68
  69 <para><emphasis remap='B'>Amlabel</emphasis>
  70 will not write the label if the tape contains an active
  71 &A; tape or if the label specified is on an active tape.
  72 The
  73 <option>-f</option>
  74 (force) flag bypasses these verifications.</para>
  75
  76 <para>An optional
  77 <emphasis remap='I'>slot</emphasis>
  78 may be specified after the tape label.
  79 If a tape changer is in use,
  80 <command>amlabel</command>
  81 will label the tape in the specified slot instead of the currently loaded tape.</para>
  82
  83 <para>See the
  84 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  85 man page for more details about &A;.</para>
  86 </refsect1>
  87
  88 <refsect1><title>OPTIONS</title>
  89 <variablelist remap='TP'>
  90
  91   <varlistentry>
  92   <term><emphasis remap='B'>-o</emphasis> <replaceable>configoption</replaceable></term>
  93   <listitem>
  94 <para>See the "<emphasis remap='B'>CONFIGURATION OVERRIDE</emphasis>" section in <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
  95   </listitem>
  96   </varlistentry>
  97
  98
  99 </variablelist>
 100 </refsect1>
 101
 102 <refsect1><title>EXAMPLE</title>
 103 <para>Write an &A; label with the string &quot;DMP000&quot; on
 104 the tape loaded in the device named in the
 105 <emphasis remap='B'>tapedev</emphasis>
 106 option in /usr/local/etc/amanda/daily/amanda.conf:</para>
 107
 108 <programlisting>
 109 % amlabel daily DMP000
 110 </programlisting>
 111
 112 <para>Label the tape in slot 3 of the currently configured tape changer
 113 with the string &quot;DMP003&quot;:</para>
 114
 115 <programlisting>
 116 % amlabel daily DMP003 slot 3
 117 </programlisting>
 118 </refsect1>
 119
 120 <refsect1><title>MESSAGES</title>
 121 <variablelist remap='TP'>
 122   <varlistentry>
 123   <term>label <emphasis remap='I'>label</emphasis> doesn't match labelstr <emphasis remap='I'>str</emphasis></term>
 124   <listitem>
 125 <para>Label
 126 <emphasis remap='I'>label</emphasis>
 127 on the command line does not match the
 128 <emphasis remap='I'>labelstr</emphasis>
 129 regular expression
 130 <emphasis remap='I'>str</emphasis>
 131 from
 132 <emphasis remap='I'>amanda.conf</emphasis>.</para>
 133   </listitem>
 134   </varlistentry>
 135   <varlistentry>
 136   <term>label <emphasis remap='I'>label</emphasis> already on a tape</term>
 137   <listitem>
 138 <para>Label
 139 <emphasis remap='I'>label</emphasis>
 140 is already listed as an active &A; tape.</para>
 141   </listitem>
 142   </varlistentry>
 143   <varlistentry>
 144   <term>no tpchanger specified in <emphasis remap='I'>path</emphasis> , so slot command invalid</term>
 145   <listitem>
 146 <para>The command line has the
 147 <emphasis remap='B'>slot</emphasis>
 148 parameter but the
 149 <emphasis remap='I'>amanda.conf</emphasis>
 150 file in
 151 <emphasis remap='I'>path</emphasis>
 152 does not have a tape changer configured.</para>
 153   </listitem>
 154   </varlistentry>
 155   <varlistentry>
 156   <term>reading label <emphasis remap='I'>label</emphasis>, tape is in another amanda configuration</term>
 157   <listitem>
 158 <para>This tape appears to be a valid &A; tape,
 159 but label does not match
 160 <emphasis remap='B'>labelstr</emphasis>
 161 for this configuration so it is probably part of a different &A; configuration.</para>
 162   </listitem>
 163   </varlistentry>
 164   <varlistentry>
 165   <term>reading label <emphasis remap='I'>label</emphasis>, tape is active</term>
 166   <listitem>
 167 <para>Tape
 168 <emphasis remap='I'>label</emphasis>
 169 appears to already be part of this &A; configuration
 170 and active, i.e. has valid data on it.</para>
 171   </listitem>
 172   </varlistentry>
 173   <varlistentry>
 174   <term>no label found, are you sure <emphasis remap='I'>tape</emphasis> is non-rewinding?</term>
 175   <listitem>
 176 <para>While checking that the label was written correctly,
 177 <command>amlabel</command>
 178 got an error that might be caused by mis-configuring &A;
 179 with a rewinding tape device name
 180 instead of a non-rewinding device name for
 181 <emphasis remap='I'>tape.</emphasis></para>
 182   </listitem>
 183   </varlistentry>
 184 </variablelist>
 185 </refsect1>
 186
 187 <refsect1><title>SEE ALSO</title>
 188 <para><citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 189 <citerefentry><refentrytitle>amdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 190 <citerefentry><refentrytitle>amflush</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 191 <ulink url="http://wiki.zmanda.com"/>
 192 </para>
 193 </refsect1>
 194 </refentry>
 195