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

   1 '\" t
   2 .\"     Title: amtape
   3 .\"    Author: Dustin J. Mitchell <dustin@zmanda.com>
   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 "AMTAPE" "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 amtape \- Control Amanda changers
  32 .SH "SYNOPSIS"
  33 .HP \w'\fBamtape\fR\ 'u
  34 \fBamtape\fR [\fB\-o\fR\ \fIconfigoption\fR...] \fIconfig\fR \fIsubcommand\fR [\fIsubcommand_options\fR...]
  35 .SH "DESCRIPTION"
  36 .PP
  37 \fBAmtape\fR
  38 is the command\-line interface to Amanda\*(Aqs tape changers (\fBamanda-changers\fR(7)) and to the taperscan algorithm (\fBamanda-taperscan\fR(7))\&.
  39 .PP
  40 Tape changers maintain a notion of the
  41 \fIcurrent\fR
  42 slot for each configuration\&. This may or may not correspond to an actual physical state of the device, but is used by some taperscan algorithms to minimize searching through the slots\&.
  43 .PP
  44 Amtape uses the default changer\&. To use a different changer, use the config override option, e\&.g\&.,
  45 \fB\-otpchanger=otherchanger\fR\&.
  46 .SH "SUBCOMMANDS"
  47 .PP
  48 \fBlabel\fR \fIlabel\fR
  49 .RS 4
  50 Search for and load the Amanda tape with label
  51 [label], also setting the current slot\&.
  52 .RE
  53 .PP
  54 \fBslot\fR \fIslot\fR
  55 .RS 4
  56 Load the volume in the given slot, also setting the current slot\&. The slot names
  57 \fBcurrent\fR,
  58 \fBnext\fR,
  59 \fBfirst\fR, and
  60 \fBlast\fR
  61 have special meaning\&.
  62 .RE
  63 .PP
  64 \fBcurrent\fR
  65 .RS 4
  66 Shorthand for
  67 \fBslot\fR
  68 current\&.
  69 .RE
  70 .PP
  71 \fBinventory\fR
  72 .RS 4
  73 Show the contents of all slots, based on the changer\*(Aqs cached metadata\&. This is a quick operation as it does not load or unload any volumes, but is not supported by all changers\&.
  74 .RE
  75 .PP
  76 \fBshow\fR [slots]
  77 .RS 4
  78 Show the contents of all slots (or listed slots) by loading each slot and reading its label\&. This can be very slow\&. The slots arguments is of the form 1,3\-5,7\&.
  79 .RE
  80 .PP
  81 \fBreset\fR
  82 .RS 4
  83 Reset the changer to a known state\&. This subcommand is intended to clear any unknown and potentially incorrect state the changer may have stored\&.
  84 .RE
  85 .PP
  86 \fBeject\fR [\fIdrive\fR]
  87 .RS 4
  88 Eject the tape currently in the drive\&. This only applies to some changers\&. Specify a drive (by drive number) if more than one drive is available\&.
  89 .RE
  90 .PP
  91 \fBclean\fR [\fIdrive\fR]
  92 .RS 4
  93 If a cleaning tape is defined for the changer, used it to clean the specified drive\&. The
  94 [drive]
  95 is optional if the changer only has one drive\&.
  96 .RE
  97 .PP
  98 \fBtaper\fR
  99 .RS 4
 100 Run the taperscan algorithm (see
 101 \fBamanda-taperscan\fR(7)), displaying information about the progress of the scan\&.
 102 .RE
 103 .PP
 104 \fBupdate\fR [what]
 105 .RS 4
 106 Update changer state\&. Consult
 107 \fBamanda-changers\fR(7)
 108 for changer\-specific details on the format of
 109 what\&.
 110 .RE
 111 .PP
 112 \fB\-o \fR\fB\fIconfigoption\fR\fR
 113 .RS 4
 114 See the "CONFIGURATION OVERRIDE" section in
 115 \fBamanda\fR(8)\&.
 116 .RE
 117 .SH "SEE ALSO"
 118 .PP
 119 \fBamanda\fR(8),
 120 \fBamanda-changers\fR(7),
 121 \fBamanda-taperscan\fR(7),
 122 \fBamanda-devices\fR(7)
 123 .PP
 124 The Amanda Wiki:
 125 : http://wiki.zmanda.com/
 126 .SH "AUTHORS"
 127 .PP
 128 \fBDustin J\&. Mitchell\fR <\&dustin@zmanda\&.com\&>
 129 .RS 4
 130 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
 131 .RE
 132 .PP
 133 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
 134 .PP
 135 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>