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

   1 '\" t
   2 .\"     Title: amdevcheck
   3 .\"    Author: Ian Turner <ian@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 "AMDEVCHECK" "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 amdevcheck \- Validate an Amanda device and volume\&.
  32 .SH "SYNOPSIS"
  33 .HP \w'\fBamdevcheck\fR\ 'u
  34 \fBamdevcheck\fR [\-\-label] [\-properties\ \fIlist\fR] [\fB\-o\fR\ \fIconfigoption\fR...] \fIconfig\fR [\fIdevice\-name\fR]
  35 .SH "DESCRIPTION"
  36 .PP
  37
  38 \fBAmdevcheck\fR
  39 provides a way to check that a particular Amanda device is accessible, whether or not it contains a volume, and whether or not that volume is labeled\&. Some devices can\*(Aqt distinguish between all of these cases; a missing volume and an unlabeled volume might generate the same error code, for example\&. In those cases, this tool reports all possible causes of the error\&. Optionally this tools lists the properties for the device\&.
  40 .PP
  41 See the
  42 \fBamanda\fR(8)
  43 man page for more details about Amanda\&. See
  44 \fBamanda-devices\fR(7)
  45 for more information on devices\&.
  46 .SH "OPTIONS"
  47 .PP
  48 \fIconfig\fR
  49 .RS 4
  50 Amanda configuration to use\&. Note that
  51 \fBamdevcheck\fR
  52 ignores any tape changer configuration\&.
  53 .RE
  54 .PP
  55 \fIdevice\fR
  56 .RS 4
  57 Amanda device to use\&. This option overrides any tapedev configuration specified in the configuration file\&.
  58 .RE
  59 .PP
  60 \fI\-\-label\fR
  61 .RS 4
  62 Get the device\*(Aqs label\&. If this option is given, the usual check output is omitted, and the label of the loaded volume is printed to stdout\&. Returns with error if the label is not found\&.
  63 .RE
  64 .PP
  65 \fI\-\-properties [list]\fR
  66 .RS 4
  67 List device properties\&. If this option is given, the usual check output is omitted, and property values are printed to stdout, one per line, as a property name, followed by \*(Aq=\*(Aq, followed by the property value\&. Returns with error if properties are not available\&.
  68 .sp
  69 If
  70 \fIlist\fR
  71 is given, it is treated as a comma\-separated list of properties to display\&. If it is omitted, all supported properties are displayed\&.
  72 .RE
  73 .PP
  74 \fB\-o \fR\fB\fIconfigoption\fR\fR
  75 .RS 4
  76 See the "CONFIGURATION OVERRIDE" section in
  77 \fBamanda\fR(8)\&.
  78 .RE
  79 .SH "OUTPUT"
  80 .PP
  81 \fBamdevcheck\fR
  82 exit with code 0 if the device is working of if it get an expected error, look at the MESSAGE line for the error\&. It exit with code 1 if it get an unexpected error\&.
  83 .PP
  84 \fBAmdevcheck\fR
  85 returns one or more of the following lines\&. If multiple lines appear, then at least one, but not necessarily all of the messages apply\&. This situation can occur when working with hardware or operating systems which cannot distinguish, for example, between a malfunctioning drive and a functional but unloaded drive\&.
  86 .PP
  87 \fBSUCCESS\fR
  88 .RS 4
  89 A tape is ready\&.
  90 .RE
  91 .PP
  92 \fBDEVICE_ERROR\fR
  93 .RS 4
  94 A device error has occurred\&.
  95 .RE
  96 .PP
  97 \fBDEVICE_BUSY\fR
  98 .RS 4
  99 The device is busy\&.
 100 .RE
 101 .PP
 102 \fBVOLUME_MISSING\fR
 103 .RS 4
 104 No tape is loaded in the drive\&.
 105 .RE
 106 .PP
 107 \fBVOLUME_UNLABELED\fR
 108 .RS 4
 109 The tape in the drive is unlabeled\&.
 110 .RE
 111 .PP
 112 \fBVOLUME_ERROR\fR
 113 .RS 4
 114 A volume error has occurred\&.
 115 .RE
 116 .PP
 117 \fBMESSAGE\fR \fItext\fR
 118 .RS 4
 119 Where text provides a human\-readable description of the problem\&.
 120 .RE
 121 .SH "SEE ALSO"
 122 .PP
 123 \fBamanda\fR(8),
 124 \fBamanda-devices\fR(7)
 125 .PP
 126 The Amanda Wiki:
 127 : http://wiki.zmanda.com/
 128 .SH "AUTHOR"
 129 .PP
 130 \fBIan Turner\fR <\&ian@zmanda\&.com\&>
 131 .RS 4
 132 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
 133 .RE