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 '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 Amanda 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       <group choice='opt'>
  31         <arg choice='plain'>--label</arg>
  32       </group>
  33       <group choice='opt'>
  34         <arg choice='plain'>-properties <replaceable>list</replaceable></arg>
  35       </group>
  36       &configoverride.synopsis;
  37       <arg choice='plain'><replaceable>config</replaceable></arg>
  38       <group choice='opt'>
  39         <arg choice='plain'><replaceable>device-name</replaceable></arg>
  40       </group>
  41     </cmdsynopsis>
  42   </refsynopsisdiv>
  43
  44   <refsect1><title>DESCRIPTION</title>
  45     <para>
  46       <emphasis remap='B'>Amdevcheck</emphasis> provides a way to check that a
  47       particular Amanda device is accessible, whether or not it contains a volume,
  48       and whether or not that volume is labeled. Some devices can't distinguish
  49       between all of these cases; a missing volume and an unlabeled volume might
  50       generate the same error code, for example. In those cases, this tool
  51       reports all possible causes of the error. Optionally this tools lists the
  52       properties for the device.
  53     </para>
  54
  55     <para>See the
  56       <manref name="amanda" vol="8"/>
  57       man page for more details about Amanda.  See
  58       <manref name="amanda-devices" vol="7"/>
  59       for more information on devices.
  60   </para>
  61   </refsect1>
  62
  63   <refsect1><title>OPTIONS</title>
  64     <variablelist remap='TP'>
  65       <varlistentry>
  66         <term><replaceable>config</replaceable></term>
  67         <listitem>
  68           <para>
  69             Amanda configuration to use. Note that <command>amdevcheck</command>
  70             ignores any tape changer configuration.
  71           </para>
  72         </listitem>
  73       </varlistentry>
  74
  75       <varlistentry>
  76         <term><replaceable>device</replaceable></term>
  77         <listitem>
  78           <para>
  79             Amanda device to use. This option overrides any tapedev configuration
  80             specified in the configuration file.
  81           </para>
  82         </listitem>
  83       </varlistentry>
  84
  85       <varlistentry>
  86         <term><replaceable>--label</replaceable></term>
  87         <listitem>
  88           <para>
  89             Get the device's label.  If this option is given, the usual check
  90             output is omitted, and the label of the loaded volume is printed to stdout.
  91             Returns with error if the label is not found.
  92           </para>
  93         </listitem>
  94       </varlistentry>
  95
  96       <varlistentry>
  97         <term><replaceable>--properties [list]</replaceable></term>
  98         <listitem>
  99           <para>
 100             List device properties.  If this option is given, the usual check
 101             output is omitted, and property values are printed to stdout, one
 102             per line, as a property name, followed by '=', followed by the
 103             property value.
 104             Returns with error if properties are not available.
 105           </para>
 106           <para>
 107             If <replaceable>list</replaceable> is given, it is treated as a
 108             comma-separated list of properties to display.  If it is omitted,
 109             all supported properties are displayed.
 110           </para>
 111         </listitem>
 112       </varlistentry>
 113
 114       &configoverride.varlistentry;
 115
 116     </variablelist>
 117   </refsect1>
 118
 119   <refsect1><title>OUTPUT</title>
 120     <para><emphasis remap='B'>amdevcheck</emphasis> 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.</para>
 121     <para><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
 122 the messages apply.  This situation can occur when working with hardware or
 123 operating systems which cannot distinguish, for example, between a
 124 malfunctioning drive and a functional but unloaded drive.</para>
 125 <!-- .RS -->
 126       <variablelist remap='TP'>
 127         <varlistentry>
 128           <term><emphasis remap='B'>SUCCESS</emphasis></term>
 129             <listitem><para>A tape is ready.</para></listitem>
 130         </varlistentry>
 131         <varlistentry>
 132           <term><emphasis remap='B'>DEVICE_ERROR</emphasis></term>
 133             <listitem><para>A device error has occurred.</para></listitem>
 134         </varlistentry>
 135         <varlistentry>
 136           <term><emphasis remap='B'>DEVICE_BUSY</emphasis></term>
 137             <listitem><para>The device is busy.</para></listitem>
 138         </varlistentry>
 139         <varlistentry>
 140           <term><emphasis remap='B'>VOLUME_MISSING</emphasis></term>
 141             <listitem><para>No tape is loaded in the drive.</para></listitem>
 142         </varlistentry>
 143         <varlistentry>
 144           <term><emphasis remap='B'>VOLUME_UNLABELED</emphasis></term>
 145             <listitem><para>The tape in the drive is unlabeled.</para></listitem>
 146         </varlistentry>
 147         <varlistentry>
 148           <term><emphasis remap='B'>VOLUME_ERROR</emphasis></term>
 149             <listitem><para>A volume error has occurred.</para></listitem>
 150         </varlistentry>
 151         <varlistentry>
 152           <term><emphasis remap='B'>MESSAGE</emphasis> <emphasis remap='I'>text</emphasis></term>
 153             <listitem><para>Where text provides a human-readable description of the problem.</para></listitem>
 154         </varlistentry>
 155        </variablelist>
 156   </refsect1>
 157
 158 <seealso>
 159 <manref name="amanda-devices" vol="7"/>
 160 </seealso>
 161
 162 </refentry>