"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
[
<!-- entities files to use -->
- <!ENTITY % global_entities SYSTEM '../entities/global.entities'>
+ <!ENTITY % global_entities SYSTEM 'global.entities'>
%global_entities;
]>
</refmeta>
<refnamediv>
<refname>amdevcheck</refname>
- <refpurpose>Validate an &A; device and volume.</refpurpose>
+ <refpurpose>Validate an Amanda device and volume.</refpurpose>
</refnamediv>
<refentryinfo>
&author.ian;
<command>amdevcheck</command>
<arg choice='plain'><replaceable>config</replaceable></arg>
<group choice='opt'>
- <arg choice='plain'><replaceable>device name</replaceable></arg>
+ <arg choice='plain'><replaceable>device-name</replaceable></arg>
</group>
- <arg choice='plain' rep='repeat'><group><arg choice='plain'>-o
- </arg><replaceable>configoption</replaceable></group></arg>
+ <group choice='opt'>
+ <arg choice='plain'>--label</arg>
+ </group>
+ <group choice='opt'>
+ <arg choice='plain'>-properties <replaceable>list</replaceable></arg>
+ </group>
+ &configoverride.synopsis;
</cmdsynopsis>
</refsynopsisdiv>
<refsect1><title>DESCRIPTION</title>
<para>
<emphasis remap='B'>Amdevcheck</emphasis> provides a way to check that a
- particular &A; device is accessible, whether or not it contains a volume,
+ 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.
+ reports all possible causes of the error. Optionally this tools lists the
+ properties for the device.
</para>
-
+
<para>See the
- <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
- man page for more details about &A;. See
- <citerefentry><refentrytitle>amanda-devices</refentrytitle><manvolnum>7</manvolnum></citerefentry>
+ <manref name="amanda" vol="8"/>
+ man page for more details about Amanda. See
+ <manref name="amanda-devices" vol="7"/>
for more information on devices.
</para>
</refsect1>
<term><replaceable>config</replaceable></term>
<listitem>
<para>
- &A; configuration to use. Note that <command>amdevcheck</command>
+ Amanda configuration to use. Note that <command>amdevcheck</command>
ignores any tape changer configuration.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><replaceable> device</replaceable></term>
+ <term><replaceable>device</replaceable></term>
<listitem>
<para>
- &A; device to use. This option overrides any tapedev configuration
+ Amanda device to use. This option overrides any tapedev configuration
specified in the configuration file.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis remap='B'>-o</emphasis> <replaceable>clientconfigoption</replaceable></term>
+ <term><replaceable>--label</replaceable></term>
<listitem>
- <para>See the "<emphasis remap='B'>CONFIGURATION OVERRIDE</emphasis>"
- section in
- <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
+ <para>
+ 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.
+ </para>
</listitem>
</varlistentry>
+
+ <varlistentry>
+ <term><replaceable>--properties [list]</replaceable></term>
+ <listitem>
+ <para>
+ 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.
+ </para>
+ <para>
+ If <replaceable>list</replaceable> is given, it is treated as a
+ comma-separated list of properties to display. If it is omitted,
+ all supported properties are displayed.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ &configoverride.varlistentry;
+
</variablelist>
</refsect1>
<refsect1><title>OUTPUT</title>
- <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
+ <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>
+ <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
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.
+malfunctioning drive and a functional but unloaded drive.</para>
<!-- .RS -->
<variablelist remap='TP'>
<varlistentry>
</variablelist>
</refsect1>
- <refsect1><title>SEE ALSO</title>
- <para>
- <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>ammt</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
- <ulink url="http://wiki.zmanda.com"/>
- </para>
- </refsect1>
+<seealso>
+<manref name="amanda-devices" vol="7"/>
+</seealso>
+
</refentry>
projects / debian / amanda / blobdiff