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