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