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

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
   4 [
   5   <!-- entities files to use -->
   6   <!ENTITY % global_entities SYSTEM '../entities/global.entities'>
   7   %global_entities;
   8 ]>
   9
  10 <refentry id='amdevcheck.8'>
  11
  12   <refmeta>
  13     <refentrytitle>amdevcheck</refentrytitle>
  14     <manvolnum>8</manvolnum>
  15     &rmi.source;
  16     &rmi.version;
  17     &rmi.manual.8;
  18   </refmeta>
  19   <refnamediv>
  20     <refname>amdevcheck</refname>
  21     <refpurpose>Validate an &A; device and volume.</refpurpose>
  22   </refnamediv>
  23   <refentryinfo>
  24     &author.ian;
  25   </refentryinfo>
  26   <!-- body begins here -->
  27   <refsynopsisdiv>
  28     <cmdsynopsis>
  29       <command>amdevcheck</command>
  30       <arg choice='plain'><replaceable>config</replaceable></arg>
  31       <group choice='opt'>
  32         <arg choice='plain'><replaceable>device name</replaceable></arg>
  33       </group>
  34       <arg choice='plain' rep='repeat'><group><arg choice='plain'>-o
  35       </arg><replaceable>configoption</replaceable></group></arg>
  36     </cmdsynopsis>
  37   </refsynopsisdiv>
  38
  39   <refsect1><title>DESCRIPTION</title>
  40     <para>
  41       <emphasis remap='B'>Amdevcheck</emphasis> provides a way to check that a
  42       particular &A; device is accessible, whether or not it contains a volume,
  43       and whether or not that volume is labeled. Some devices can't distinguish
  44       between all of these cases; a missing volume and an unlabeled volume might
  45       generate the same error code, for example. In those cases, this tool
  46       reports all possible causes of the error.
  47     </para>
  48
  49     <para>See the
  50       <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  51       man page for more details about &A;.  See
  52       <citerefentry><refentrytitle>amanda-devices</refentrytitle><manvolnum>7</manvolnum></citerefentry>
  53       for more information on devices.
  54   </para>
  55   </refsect1>
  56
  57   <refsect1><title>OPTIONS</title>
  58     <variablelist remap='TP'>
  59       <varlistentry>
  60         <term><replaceable>config</replaceable></term>
  61         <listitem>
  62           <para>
  63             &A; configuration to use. Note that <command>amdevcheck</command>
  64             ignores any tape changer configuration.
  65           </para>
  66         </listitem>
  67       </varlistentry>
  68
  69       <varlistentry>
  70         <term><replaceable> device</replaceable></term>
  71         <listitem>
  72           <para>
  73             &A; device to use. This option overrides any tapedev configuration
  74             specified in the configuration file.
  75           </para>
  76         </listitem>
  77       </varlistentry>
  78
  79       <varlistentry>
  80         <term><emphasis remap='B'>-o</emphasis> <replaceable>clientconfigoption</replaceable></term>
  81         <listitem>
  82           <para>See the "<emphasis remap='B'>CONFIGURATION OVERRIDE</emphasis>"
  83             section in
  84             <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
  85         </listitem>
  86       </varlistentry>
  87     </variablelist>
  88   </refsect1>
  89
  90   <refsect1><title>OUTPUT</title>
  91     <emphasis remap='B'>Amdevcheck</emphasis> returns one or more of the following lines. If multiple lines appear, then at least one, but not necessarily all of
  92 the messages apply.  This situation can occur when working with hardware or
  93 operating systems which cannot distinguish, for example, between a
  94 malfunctioning drive and a functional but unloaded drive.
  95 <!-- .RS -->
  96       <variablelist remap='TP'>
  97         <varlistentry>
  98           <term><emphasis remap='B'>SUCCESS</emphasis></term>
  99             <listitem><para>A tape is ready.</para></listitem>
 100         </varlistentry>
 101         <varlistentry>
 102           <term><emphasis remap='B'>DEVICE_ERROR</emphasis></term>
 103             <listitem><para>A device error has occurred.</para></listitem>
 104         </varlistentry>
 105         <varlistentry>
 106           <term><emphasis remap='B'>DEVICE_BUSY</emphasis></term>
 107             <listitem><para>The device is busy.</para></listitem>
 108         </varlistentry>
 109         <varlistentry>
 110           <term><emphasis remap='B'>VOLUME_MISSING</emphasis></term>
 111             <listitem><para>No tape is loaded in the drive.</para></listitem>
 112         </varlistentry>
 113         <varlistentry>
 114           <term><emphasis remap='B'>VOLUME_UNLABELED</emphasis></term>
 115             <listitem><para>The tape in the drive is unlabeled.</para></listitem>
 116         </varlistentry>
 117         <varlistentry>
 118           <term><emphasis remap='B'>VOLUME_ERROR</emphasis></term>
 119             <listitem><para>A volume error has occurred.</para></listitem>
 120         </varlistentry>
 121         <varlistentry>
 122           <term><emphasis remap='B'>MESSAGE</emphasis> <emphasis remap='I'>text</emphasis></term>
 123             <listitem><para>Where text provides a human-readable description of the problem.</para></listitem>
 124         </varlistentry>
 125        </variablelist>
 126   </refsect1>
 127
 128   <refsect1><title>SEE ALSO</title>
 129     <para>
 130       <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 131       <citerefentry><refentrytitle>ammt</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 132       <ulink url="http://wiki.zmanda.com"/>
 133     </para>
 134   </refsect1>
 135 </refentry>