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