Imported Upstream version 3.3.0

[debian/amanda] / man / xml-source / amanda-changers.7.xml

diff --git a/man/xml-source/amanda-changers.7.xml b/man/xml-source/amanda-changers.7.xml
index 4827e08113970ff7f3070e5834087867744135f7..1520f278b47b60a902f29d1b1d7a478ad308dc86 100644 (file)
--- a/man/xml-source/amanda-changers.7.xml
+++ b/man/xml-source/amanda-changers.7.xml
@@ -134,9 +134,42 @@ 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>
+
+</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 +182,45 @@ 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>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>