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