git.gag.com Git - debian/amanda/blob - man/amlabel.8

   1 '\" t
   2 .\"     Title: amlabel
   3 .\"    Author: James da Silva <jds@amanda.org>
   4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
   5 .\"      Date: 02/21/2012
   6 .\"    Manual: System Administration Commands
   7 .\"    Source: Amanda 3.3.1
   8 .\"  Language: English
   9 .\"
  10 .TH "AMLABEL" "8" "02/21/2012" "Amanda 3\&.3\&.1" "System Administration Commands"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 amlabel \- label an Amanda tape
  32 .SH "SYNOPSIS"
  33 .HP \w'\fBamlabel\fR\ 'u
  34 \fBamlabel\fR [\fB\-\-barcode\ \fR\fB\fIbarcode\fR\fR] [\fB\-\-meta\ \fR\fB\fImeta\-label\fR\fR] [\fB\-\-assign\fR] [\fB\-f\fR] [\fB\-\-version\fR] [\fB\-o\fR\ \fIconfigoption\fR...] \fIconfig\fR [\fIlabel\fR] [slot\ \fIslot\fR]
  35 .SH "DESCRIPTION"
  36 .PP
  37 This command applies a label to an Amanda volume, erasing the volume in the process\&.
  38 .PP
  39 Amanda uses labels to identify volumes:
  40 \fBamdump\fR(8)
  41 and
  42 \fBamflush\fR(8)
  43 verify the label before writing to make sure the proper volume is loaded, and the recovery programs use the label to ensure they are reading the data they expect\&.
  44 .PP
  45 If no
  46 [\fIslot\fR]
  47 and no
  48 [\fIbarcode\fR]
  49 is given, then
  50 \fBamlabel\fR
  51 labels the tape in the current slot of the default changer\&. If a slot is given, it labels the volume in that slot\&. If a barcode is given, it labels the volume with that barcode\&.
  52 \fILabel\fR
  53 may be any string that does not contain whitespace and that matches the
  54 \fBlabelstr\fR
  55 (see
  56 \fBamanda.conf\fR(5))\&.
  57 .PP
  58 If
  59 [\fIlabel\fR]
  60 is not given, an autolabel is generated, see
  61 \fBautolabel\fR
  62 in
  63 \fBamanda.conf\fR(5)\&.
  64 .PP
  65 If
  66 [\fB\-\-assign\fR]
  67 is given, the barcode and meta\-label are assigned to the label without labeling the volume\&. The label must already be in the tapelist file\&.
  68 .PP
  69 This command also appends the new volume to the
  70 \fBtapelist\fR(5)
  71 file, so that they will be used in the order they are labeled (depending on the taperscan in use \(em see
  72 \fBamanda-taperscan\fR(7))\&.
  73 .PP
  74 As a precaution,
  75 \fBamlabel\fR
  76 will not write a label if the volume already contains an active label or if the label specified is on an active tape\&. The
  77 [\-f]
  78 (force) flag bypasses these verifications\&.
  79 .SH "OPTIONS"
  80 .PP
  81 \fB\-\-barcode \fR\fB\fIbarcode\fR\fR
  82 .RS 4
  83 With
  84 [\-\-assign], assign the barcode to the label\&. Without
  85 [\-\-assign], label the volume with that barcode\&.
  86 .RE
  87 .PP
  88 \fB\-\-meta \fR\fB\fImeta\-label\fR\fR
  89 .RS 4
  90 Assign the meta label to the label after labeling the volume\&.
  91 .RE
  92 .PP
  93 \fB\-\-assign\fR
  94 .RS 4
  95 Assign the barcode or meta\-label to the label without labeling the volume\&. The label must already be in the tapelist file\&.
  96 .RE
  97 .PP
  98 \fB\-f\fR
  99 .RS 4
 100 Force the label operation; see above
 101 .RE
 102 .PP
 103 \fB\-\-version\fR
 104 .RS 4
 105 Output version information
 106 .RE
 107 .PP
 108 \fB\-o \fR\fB\fIconfigoption\fR\fR
 109 .RS 4
 110 See the "CONFIGURATION OVERRIDE" section in
 111 \fBamanda\fR(8)\&.
 112 .RE
 113 .SH "EXAMPLE"
 114 .PP
 115 Write an Amanda label with the string "DMP000" on the current volume:
 116 .nf
 117 % amlabel daily DMP000
 118 .fi
 119 .PP
 120 Label the tape in slot 3 of the changer with the label "DMP003":
 121 .nf
 122 % amlabel daily DMP003 slot 3
 123 .fi
 124 .SH "MESSAGES"
 125 .PP
 126 Label \*(Aq\fIlabel\fR\*(Aq doesn\*(Aqt match labelstr \*(Aq\fIlabelstr\fR\*(Aq
 127 .RS 4
 128 The given label does not match the configured labelstr\&. Even with
 129 \fB\-f\fR, this is an error\&.
 130 .RE
 131 .PP
 132 Label \*(Aq\fIlabel\fR\*(Aq already on a volume
 133 .RS 4
 134 The given label is already on another volume in the tapelist, and Amanda will not write it to this volume unless forced\&.
 135 .RE
 136 .PP
 137 Found label \*(Aq\fIlabel\fR\*(Aq, but it is not from configuration \fIconfig\fR\&.
 138 .RS 4
 139 The label
 140 \fBamlabel\fR
 141 found on the volume does not match this configuration\*(Aqs
 142 \fBlabelstr\fR, so it is probably part of a different Amanda configuration\&. Amanda will not overwrite the label unless it is forced\&.
 143 .RE
 144 .PP
 145 Volume with label \*(Aq\fIlabel\fR\*(Aq contains data from this configuration\&.
 146 .RS 4
 147 The label
 148 \fBamlabel\fR
 149 found on the volume still has valid data on it and Amanda will not overwrite it unless forced\&. Note that this does not distinguish between active and inactive volumes\&.
 150 .RE
 151 .PP
 152 .RS 4
 153 .RE
 154 .SH "SEE ALSO"
 155 .PP
 156 \fBamanda\fR(8),
 157 \fBamanda.conf\fR(5),
 158 \fBtapelist\fR(5),
 159 \fBamanda-taperscan\fR(7),
 160 \fBamdump\fR(8),
 161 \fBamflush\fR(8)
 162 .PP
 163 The Amanda Wiki:
 164 : http://wiki.zmanda.com/
 165 .SH "AUTHORS"
 166 .PP
 167 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
 168 .PP
 169 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>
 170 .PP
 171 \fBDustin J\&. Mitchell\fR <\&dustin@zmanda\&.com\&>
 172 .RS 4
 173 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
 174 .RE