Imported Upstream version 3.3.3
[debian/amanda] / man / xml-source / amanda-changers.7.xml
index 9846a12066e2e942acc5ae0fcfbb6523f3202b37..cfdd629abc28bb098705717164b1de80e361a28d 100644 (file)
@@ -97,7 +97,7 @@ define changer hp-robot {
     tapedev "chg-robot:/dev/sg1"
     property "tape-device" "0=tape:/dev/nst0"
     property append "tape-device" "1=tape:/dev/nst1"
-    device_property "BLOCK_SIZE" "512k"
+    device-property "BLOCK_SIZE" "512k"
 }
 # ...
 tapedev "hp-robot"
@@ -111,7 +111,7 @@ changer definition, as in the <emphasis>hp-robot</emphasis> example, above.</par
 <para>Devices, too, can take properties to control their behavior (see <manref
 name="amanda-devices" vol="7" />).  Device properties can come from four
 places: implicit device properties (from tapetype parameters), global device
-properties (from global <emphasis>device_property</emphasis> parameters),
+properties (from global <emphasis>device-property</emphasis> parameters),
 properties in device definitions, and properties in changer definitions.
 Properties are applied in this order, with later properties taking
 priority.</para>
@@ -134,9 +134,56 @@ specified by an alias, then properties from that definition applied.</para>
 
 <para>This section lists the changer drivers included with Amanda, and basic instructions for using them.  For complete How-To information, consult the Amanda wiki at http://wiki.zmanda.com.</para>
 
+<refsect2><title>chg-aggregate:changer (new)</title>
+<programlisting>
+define changer robot0 {
+  tpchanger "chg-robot:/dev/sg0"
+  property "tape-device" "0=tape:/dev/rmt/0" "1=tape:/dev/rmt/1"
+}
+define changer robot1 {
+  tpchanger "chg-robot:/dev/sg1"
+  property "tape-device" "0=tape:/dev/rmt/2" "1=tape:/dev/rmt/3"
+}
+define changer single {
+  tpchanger "chg-single:/dev/rmt/4"
+}
+define changer aggregate {
+  tpchanger "chg-aggregate:{robot0,robot1,single}"
+  property "state-filename" "/etc/amanda/CONF/aggregate.state"
+
+}
+tpchanger "aggregate"
+</programlisting>
+
+<para>This changer driver allow to use two or more changers or standalone
+drive in sequence.</para>
+
+<refsect3><title>Properties</title>
+<!-- PLEASE KEEP THIS LIST IN ALPHABETICAL ORDER -->
+
+<variablelist>
+<!-- ==== -->
+<varlistentry><term>LOCK-TIMEOUT</term><listitem>
+The time in seconds amanda wait to lock the statefile (default:1000)
+</listitem></varlistentry>
+<!-- ==== -->
+<varlistentry><term>STATE_FILENAME</term><listitem>
+The name of the state file (default: "$CONFIG_DIR/$changer_name.state".
+</listitem></varlistentry>
+</variablelist>
+</refsect3>
+</refsect2>
+
 <refsect2><title>chg-disk:VTAPEROOT (new)</title>
 <programlisting>
-tpchanger "chg-disk:/u01/vtapes"
+tpchanger "chg-disk:/var/mnt/vtapes"
+property "num-slot" "10"
+property "auto-create-slot" "yes"
+property "removable" "yes"
+property "mount" "yes"
+property "umount" "yes"
+property "umount-lockfile" "/etc/amanda/conf/vtapes-lock"
+property "umount-idle" "1"
 </programlisting>
 
 <para>This changer driver replaces the old <command>chg-disk</command>,
@@ -149,6 +196,49 @@ supporting parallel access to vtapes stored in directories named
 <computeroutput>file:VTAPEROOT</computeroutput>. This is useful for the <manref
 name="amrestore" vol="8" /> command line.</para>
 
+<refsect3><title>Properties</title>
+<!-- PLEASE KEEP THIS LIST IN ALPHABETICAL ORDER -->
+
+<variablelist>
+<!-- ==== -->
+<varlistentry><term>AUTO-CREATE-SLOT</term><listitem>
+If a <computeroutput>slotN</computeroutput> directory in the range 1 to NUM-SLOT does not already exist, and this property is true, then the changer will create the directory.
+</listitem></varlistentry>
+<!-- ==== -->
+<varlistentry><term>LOCK-TIMEOUT</term><listitem>
+The time in seconds amanda wait to lock the statefile (default:1000)
+</listitem></varlistentry>
+<!-- ==== -->
+<varlistentry><term>MOUNT</term><listitem>
+If this property is true, the changer try to mount the removable disk if nothing is mounted. The system must be configured to allow the amanda user to mount it.
+</listitem></varlistentry>
+<!-- ==== -->
+<varlistentry><term>NUM-SLOT</term><listitem>
+The minimum number of slots in the changer, where the first slot is <computeroutput>slot1</computeroutput>.  If additional slot directories exist, they will also be used.
+</listitem></varlistentry>
+<!-- ==== -->
+<varlistentry><term>REMOVABLE</term><listitem>
+If this property is true, then the changer will verify that the changer
+directory (e.g., <filename>/var/mnt/vtapes</filename>) is on a different
+filesystem from its parent directory (e.g., <filename>/var/mnt</filename>).
+This is useful for removable disks, as it will prevent Amanda from creating
+slot directories when the removable disk is not mounted.
+</listitem></varlistentry>
+<!-- ==== -->
+<varlistentry><term>UMOUNT</term><listitem>
+If this property is true, the changer try to umount the removable disk when it exit. The system must be configured to allow the amanda user to umount it.
+</listitem></varlistentry>
+<!-- ==== -->
+<varlistentry><term>UMOUNT-LOCKFILE</term><listitem>
+If UMOUNT is set, it require a lockfile outside of the mount point to prevent race.
+</listitem></varlistentry>
+<!-- ==== -->
+<varlistentry><term>UMOUNT-IDLE</term><listitem>
+If set, the changer try to umount the removable disk when it is not in use. The umount-idle value is a delay in second to wait before doing the umount. A value &gt;= 1 is required to prevent useless mount/umount.
+</listitem></varlistentry>
+
+</variablelist>
+</refsect3>
 </refsect2>
 
 <refsect2><title>chg-disk (old)</title>
@@ -183,6 +273,14 @@ all volumes for a configuration have different device names -- for example,
 if you have many standalone drive.  The <emphasis>changerfile</emphasis> must exist; it is used to save the state file.
 </para>
 
+<para>The child devices are specified using the same syntax as for the RAIT
+device (see <manref name="amanda-changers" vol="7"/>).  The range
+specification can be especially useful here:
+<programlisting>
+tpchanger "chg-multi:s3:mycompany-backups/tape-{001..100}"
+</programlisting>
+</para>
+
 <para>This changer is not fast-search capable.</para>
 
 <refsect3><title>Properties</title>
@@ -194,6 +292,10 @@ if you have many standalone drive.  The <emphasis>changerfile</emphasis> must ex
 This property gives the number of the first slot. The default value is "1".
 </listitem></varlistentry>
 <!-- ==== -->
+<varlistentry><term>LOCK-TIMEOUT</term><listitem>
+The time in seconds amanda wait to lock the statefile (default:1000)
+</listitem></varlistentry>
+<!-- ==== -->
 </variablelist>
 
 </refsect3>
@@ -350,7 +452,7 @@ slotinfofile=FILENAME       #### record slot information to this file, in
 <refsect2><title>chg-rait:{CHILD1,CHILD2,..}</title>
 <programlisting>
 define changer vtape {
-    tpcanger "chg-disk:/path/to/vtape"
+    tpchanger "chg-disk:/path/to/vtape"
 }
 define changer robot {
     tpchanger "chg-robot:/dev/sg0"
@@ -359,8 +461,10 @@ define changer robot {
 tpchanger "chg-rait:{vtape,robot}"
 </programlisting>
 
-<para>This changer script constructs RAIT devices out of the devices provided by several "sub-changers".  The sub-changers are specified using the same shell-like syntax as the RAIT device (see
-<manref name="amanda-devices" vol="7"/>).</para>
+<para>This changer script constructs RAIT devices out of the devices provided
+by several "sub-changers".  The sub-changers are specified using the same
+shell-like syntax as the RAIT device (see <manref name="amanda-devices"
+    vol="7"/>).</para>
 
 <para>Chg-rait does not require that all of the child changers have the same slot names: compound slot names are created by combining the slot names supplied by the child changers using the same shell-like syntax.  For example, if the child changers return slots "<computeroutput>top</computeroutput>", "<computeroutput>strange</computeroutput>", and "<computeroutput>3</computeroutput>", then the RAIT changer will return "<computeroutput>{top,strange,3}</computeroutput>".  This makes it possible to, for example, mirror data on tapes in slots 1-10 to tapes in slots 11-20 of the same robot, using two <command>chg-zd-mtx</command> child changers (and, naturally, two tape drives).  In this arrangement, the first slot would be named <computeroutput>{1,11}</computeroutput>.</para>
 
@@ -545,6 +649,10 @@ The default value is <command>"0s poll 3s until 2m"</command>.
 </para>
 </listitem></varlistentry>
 <!-- ==== -->
+<varlistentry><term>LOCK-TIMEOUT</term><listitem>
+The time in seconds amanda wait to lock the statefile (default:1000)
+</listitem></varlistentry>
+<!-- ==== -->
 <varlistentry><term>MTX</term><listitem>
 The path to the 'mtx' binary.  The default value is defined at compile time.
 </listitem></varlistentry>
@@ -667,12 +775,27 @@ The password for the NDMP server.
 The username for the NDMP server.
 </listitem></varlistentry>
 <!-- ==== -->
+<varlistentry><term>VERBOSE</term><listitem>
+If true, enables the NDMJOB library's verbose (packet-level) debugging.
+</listitem></varlistentry>
+<!-- ==== -->
 </variablelist>
 
 </refsect3>
 
 </refsect2>
 
+<refsect2><title>chg-single:DEVICE</title>
+<programlisting>
+tpchanger "chg-single:tape:/dev/nst0"
+</programlisting>
+
+<para>This changer is for use with standalone drive, it can work with any
+device. The device (<command>tape:/dev/nst0</command>) must be set in the tpchanger definition.</para>
+<para>The <command>chg-single</command> changer has no property.</para>
+
+</refsect2>
+
 <refsect2><title>Unmaintained Changers</title>
 
 <para>Amanda has many other changer scripts and programs beyond those described