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

   1 '\" t
   2 .\"     Title: amtape
   3 .\"    Author: James da Silva <jds@amanda.org>
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
   5 .\"      Date: 11/05/2009
   6 .\"    Manual: System Administration Commands
   7 .\"    Source: Amanda 2.6.1p2
   8 .\"  Language: English
   9 .\"
  10 .TH "AMTAPE" "8" "11/05/2009" "Amanda 2\&.6\&.1p2" "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 amtape \- user interface to \fIAmanda\fR tape changer controls
  23 .SH "SYNOPSIS"
  24 .HP \w'\fBamtape\fR\ 'u
  25 \fBamtape\fR \fIconfig\fR \fIcommand\fR [\fIcommand_options\fR...] [\fB\-o\ \fR\fIconfigoption\fR]...
  26 .SH "DESCRIPTION"
  27 .PP
  28 \fBAmtape\fR
  29 performs tape changer control operations\&. It uses the underlying tape changer script defined by the
  30 \fBtpchanger\fR
  31 option for a particular
  32 \fIAmanda\fR
  33 configuration as specified by the
  34 \fIconfig\fR
  35 argument\&.
  36 .PP
  37 Tape changers maintain a notion of the
  38 \fIcurrent\fR
  39 and
  40 \fInext\fR
  41 slot for each configuration\&. These may or may not correspond to an actual physical state of the device, but do tend to minimize searching through the tape storage slots\&. If the desired tape is in the current slot, it is likely the next tape needed is in the next slot rather than at some random position in the storage slots\&.
  42 .PP
  43 See the
  44 \fBamanda\fR(8)
  45 man page for more details about
  46 \fIAmanda\fR\&.
  47 .SH "COMMANDS"
  48 .PP
  49 \fBreset\fR
  50 .RS 4
  51 Reset the tape changer to a known state\&. The
  52 \fIcurrent\fR
  53 slot is set to the
  54 \fIfirst\fR
  55 slot\&. Other device\-specific side effects may occur\&. Some gravity stackers need to be reset to the top position by hand\&. This command notifies
  56 \fIAmanda\fR
  57 the stacker is back in that position\&.
  58 .RE
  59 .PP
  60 \fBeject\fR
  61 .RS 4
  62 If a tape is loaded in the drive, it is ejected and returned to the slot from which it was loaded\&.
  63 .RE
  64 .PP
  65 \fBclean\fR
  66 .RS 4
  67 If a cleaning tape is defined for the changer, it is used to clean the drive\&.
  68 .RE
  69 .PP
  70 \fBshow\fR
  71 .RS 4
  72 Show the contents of all slots\&. This can be slow\&.
  73 .RE
  74 .PP
  75 \fBlabel\fR \fIlabel\fR
  76 .RS 4
  77 Search for and load the
  78 \fIAmanda\fR
  79 tape with label
  80 \fIlabel\fR\&.
  81 .RE
  82 .PP
  83 \fBtaper\fR
  84 .RS 4
  85 Perform the
  86 \fBtaper\fR
  87 scan algorithm\&. Load the next tape in the configuration\'s tape sequence, or a fresh tape with a suitable label\&.
  88 .RE
  89 .PP
  90 \fBdevice\fR
  91 .RS 4
  92 Display the name of the current tape device on
  93 \fIstdout\fR\&.
  94 .RE
  95 .PP
  96 \fBcurrent\fR
  97 .RS 4
  98 Display the current slot\&.
  99 .RE
 100 .PP
 101 \fBupdate\fR
 102 .RS 4
 103 Update the changer label database, if it has one, to match the tapes now available\&.
 104 .RE
 105 .PP
 106 \fBslot\fR \fIslot\fR
 107 .RS 4
 108 Eject any tape in the drive and put it away, then load the tape from slot
 109 \fIslot\fR
 110 and reset
 111 \fIcurrent\fR\&.
 112 .RE
 113 .PP
 114 \fBslot current\fR
 115 .RS 4
 116 Eject any tape in the drive and put it away, then load the tape from the current slot\&.
 117 .RE
 118 .PP
 119 \fBslot next\fR
 120 .RS 4
 121 Eject any tape in the drive and put it away, then load the tape from the next slot and reset
 122 \fIcurrent\fR\&.
 123 .RE
 124 .PP
 125 \fBslot first\fR
 126 .RS 4
 127 Eject any tape in the drive and put it away, then load the tape from the first slot and reset
 128 \fIcurrent\fR\&.
 129 .RE
 130 .PP
 131 \fBslot advance\fR
 132 .RS 4
 133 Synonym for
 134 \fBslot next\fR\&.
 135 .RE
 136 .PP
 137 \fB\-o\fR \fIconfigoption\fR
 138 .RS 4
 139 See the "\fBCONFIGURATION OVERRIDE\fR" section in
 140 \fBamanda\fR(8)\&.
 141 .RE
 142 .PP
 143 This is useful with non\-gravity stackers to unload the last tape used and set up
 144 \fIAmanda\fR
 145 for the next run\&. If you just use
 146 \fBeject\fR, the current tape will be mounted again in the next run, where it will be rejected as being still in use, ejected and the next tape requested\&. Using
 147 \fBslot next\fR
 148 followed by
 149 \fBeject\fR
 150 does an unnecessary mount\&.
 151 .PP
 152 Note: most changers optimize the
 153 \fBslot\fR
 154 commands to not eject the loaded tape if it is the one being requested\&.
 155 .SH "SEE ALSO"
 156 .PP
 157 \fBamanda\fR(8),
 158 : http://wiki.zmanda.com
 159 .SH "AUTHORS"
 160 .PP
 161 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
 162 .PP
 163 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>