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 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 "AMDEVCHECK" "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 amdevcheck \- Validate an Amanda device and volume\&.
  23 .SH "SYNOPSIS"
  24 .HP \w'\fBamdevcheck\fR\ 'u
  25 \fBamdevcheck\fR [\-\-label] [\-properties\ \fIlist\fR] [\fB\-o\fR\ \fIconfigoption\fR...] \fIconfig\fR [\fIdevice\-name\fR]
  26 .SH "DESCRIPTION"
  27 .PP
  28
  29 \fBAmdevcheck\fR
  30 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\'t 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\&.
  31 .PP
  32 See the
  33 \fBamanda\fR(8)
  34 man page for more details about Amanda\&. See
  35 \fBamanda-devices\fR(7)
  36 for more information on devices\&.
  37 .SH "OPTIONS"
  38 .PP
  39 \fIconfig\fR
  40 .RS 4
  41 Amanda configuration to use\&. Note that
  42 \fBamdevcheck\fR
  43 ignores any tape changer configuration\&.
  44 .RE
  45 .PP
  46 \fIdevice\fR
  47 .RS 4
  48 Amanda device to use\&. This option overrides any tapedev configuration specified in the configuration file\&.
  49 .RE
  50 .PP
  51 \fI\-\-label\fR
  52 .RS 4
  53 Get the device\'s 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\&.
  54 .RE
  55 .PP
  56 \fI\-\-properties [list]\fR
  57 .RS 4
  58 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 \'=\', followed by the property value\&. Returns with error if properties are not available\&.
  59 .sp
  60 If
  61 \fIlist\fR
  62 is given, it is treated as a comma\-separated list of properties to display\&. If it is omitted, all supported properties are displayed\&.
  63 .RE
  64 .PP
  65 \fB\-o \fR\fB\fIconfigoption\fR\fR
  66 .RS 4
  67 See the "CONFIGURATION OVERRIDE" section in
  68 \fBamanda\fR(8)\&.
  69 .RE
  70 .SH "OUTPUT"
  71 .PP
  72 \fBamdevcheck\fR
  73 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\&.
  74 .PP
  75 \fBAmdevcheck\fR
  76 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\&.
  77 .PP
  78 \fBSUCCESS\fR
  79 .RS 4
  80 A tape is ready\&.
  81 .RE
  82 .PP
  83 \fBDEVICE_ERROR\fR
  84 .RS 4
  85 A device error has occurred\&.
  86 .RE
  87 .PP
  88 \fBDEVICE_BUSY\fR
  89 .RS 4
  90 The device is busy\&.
  91 .RE
  92 .PP
  93 \fBVOLUME_MISSING\fR
  94 .RS 4
  95 No tape is loaded in the drive\&.
  96 .RE
  97 .PP
  98 \fBVOLUME_UNLABELED\fR
  99 .RS 4
 100 The tape in the drive is unlabeled\&.
 101 .RE
 102 .PP
 103 \fBVOLUME_ERROR\fR
 104 .RS 4
 105 A volume error has occurred\&.
 106 .RE
 107 .PP
 108 \fBMESSAGE\fR \fItext\fR
 109 .RS 4
 110 Where text provides a human\-readable description of the problem\&.
 111 .RE
 112 .SH "SEE ALSO"
 113 .PP
 114 \fBamanda\fR(8),
 115 \fBamanda-devices\fR(7)
 116 .PP
 117 The Amanda Wiki:
 118 : http://wiki.zmanda.com/
 119 .SH "AUTHOR"
 120 .PP
 121 \fBIan Turner\fR <\&ian@zmanda\&.com\&>
 122 .RS 4
 123 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
 124 .RE