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"
5 <!-- entities files to use -->
6 <!ENTITY % global_entities SYSTEM '../entities/global.entities'>
10 <!-- lifted from troff+man by doclifter -->
11 <refentry id='amlabel.8'>
14 <refentrytitle>amlabel</refentrytitle>
15 <manvolnum>8</manvolnum>
18 <refname>amlabel</refname>
19 <refpurpose>label an &A; tape</refpurpose>
21 <!-- body begins here -->
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>*
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>
39 <emphasis remap='B'>amflush</emphasis>
40 before writing to make sure the proper tape is loaded.</para>
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>
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.
58 <command>amlabel</command>
59 multiple tapes, they will be used in the order you
60 <command>amlabel</command>
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.
68 (force) flag bypasses these verifications.</para>
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>
78 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
79 man page for more details about &A;.</para>
82 <refsect1><title>OPTIONS</title>
83 <variablelist remap='TP'>
86 <term><emphasis remap='B'>-o</emphasis> <replaceable>configoption</replaceable></term>
88 <para>See the "<emphasis remap='B'>CONFIGURATION OVERWRITE</emphasis>" section in <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
96 <refsect1><title>EXAMPLE</title>
97 <para>Write an &A; label with the string "DMP000" 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>
103 % amlabel daily DMP000
106 <para>Label the tape in slot 3 of the currently configured tape changer
107 with the string "DMP003":</para>
110 % amlabel daily DMP003 slot 3
114 <refsect1><title>MESSAGES</title>
115 <variablelist remap='TP'>
117 <term>label <emphasis remap='I'>label</emphasis> doesn't match labelstr <emphasis remap='I'>str</emphasis></term>
120 <emphasis remap='I'>label</emphasis>
121 on the command line does not match the
122 <emphasis remap='I'>labelstr</emphasis>
124 <emphasis remap='I'>str</emphasis>
126 <emphasis remap='I'>amanda.conf</emphasis>.</para>
130 <term>label <emphasis remap='I'>label</emphasis> already on a tape</term>
133 <emphasis remap='I'>label</emphasis>
134 is already listed as an active &A; tape.</para>
138 <term>no tpchanger specified in <emphasis remap='I'>path</emphasis> , so slot command invalid</term>
140 <para>The command line has the
141 <emphasis remap='B'>slot</emphasis>
143 <emphasis remap='I'>amanda.conf</emphasis>
145 <emphasis remap='I'>path</emphasis>
146 does not have a tape changer configured.</para>
150 <term>reading label <emphasis remap='I'>label</emphasis>, tape is in another amanda configuration</term>
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>
159 <term>reading label <emphasis remap='I'>label</emphasis>, tape is active</term>
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>
168 <term>no label found, are you sure <emphasis remap='I'>tape</emphasis> is non-rewinding?</term>
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>
181 <refsect1><title>AUTHOR</title>
182 <para>James da Silva, &email.jds;: Original text</para>
183 <para>&maintainer.sgw;: XML-conversion</para>
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>