Merge branch 'nmu'
[debian/amanda] / man / amanda-changers.7
index 503089e049808cc5d9d6df295ad8a5e9dd238e35..0e4da92e5b8d22d7ce59f758b04ad3bd18af6c48 100644 (file)
@@ -2,12 +2,12 @@
 .\"     Title: amanda-changers
 .\"    Author: Dustin J. Mitchell <dustin@zmanda.com>
 .\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
-.\"      Date: 06/01/2010
+.\"      Date: 06/02/2011
 .\"    Manual: Miscellanea
-.\"    Source: Amanda 3.1.0
+.\"    Source: Amanda 3.3.0
 .\"  Language: English
 .\"
-.TH "AMANDA\-CHANGERS" "7" "06/01/2010" "Amanda 3\&.1\&.0" "Miscellanea"
+.TH "AMANDA\-CHANGERS" "7" "06/02/2011" "Amanda 3\&.3\&.0" "Miscellanea"
 .\" -----------------------------------------------------------------
 .\" * set default formatting
 .\" -----------------------------------------------------------------
@@ -68,7 +68,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"
@@ -82,7 +82,7 @@ example, above\&.
 .PP
 Devices, too, can take properties to control their behavior (see
 \fBamanda-devices\fR(7))\&. Device properties can come from four places: implicit device properties (from tapetype parameters), global device properties (from global
-\fIdevice_property\fR
+\fIdevice\-property\fR
 parameters), properties in device definitions, and properties in changer definitions\&. Properties are applied in this order, with later properties taking priority\&.
 .PP
 There are only three implicit properties:
@@ -103,9 +103,38 @@ Global device properties always apply\&. If the changer specifies a device by al
 .SH "CHANGER DRIVERS"
 .PP
 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\&.
+.SS "chg\-aggregate:changer (new)"
+.nf
+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"
+.fi
+.PP
+This changer driver allow to use two or more changers or standalone drive in sequence\&.
 .SS "chg\-disk:VTAPEROOT (new)"
 .nf
-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"
 .fi
 .PP
 This changer driver replaces the old
@@ -118,6 +147,53 @@ The current slot can be accessed using the device name
 file:VTAPEROOT\&. This is useful for the
 \fBamrestore\fR(8)
 command line\&.
+.SS "Properties"
+.PP
+AUTO\-CREATE\-SLOT
+.RS 4
+
+If a slotN directory in the range 1 to NUM\-SLOT does not already exist, and this property is true, then the changer will create the directory\&.
+.RE
+.PP
+MOUNT
+.RS 4
+
+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\&.
+.RE
+.PP
+NUM\-SLOT
+.RS 4
+
+The minimum number of slots in the changer, where the first slot is slot1\&.  If additional slot directories exist, they will also be used\&.
+.RE
+.PP
+REMOVABLE
+.RS 4
+
+If this property is true, then the changer will verify that the changer
+directory (e\&.g\&., /var/mnt/vtapes) is on a different
+filesystem from its parent directory (e\&.g\&., /var/mnt)\&.
+This is useful for removable disks, as it will prevent Amanda from creating
+slot directories when the removable disk is not mounted\&.
+.RE
+.PP
+UMOUNT
+.RS 4
+
+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\&.
+.RE
+.PP
+UMOUNT\-LOCKFILE
+.RS 4
+
+If UMOUNT is set, it require a lockfile outside of the mount point to prevent race\&.
+.RE
+.PP
+UMOUNT\-IDLE
+.RS 4
+
+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 >= 1 is required to prevent useless mount/umount\&.
+.RE
 .SS "chg\-disk (old)"
 .nf
 tapedev "file:/u01/vtapes"
@@ -148,6 +224,13 @@ setting\&. It is useful when all volumes for a configuration have different devi
 \fIchangerfile\fR
 must exist; it is used to save the state file\&.
 .PP
+The child devices are specified using the same syntax as for the RAIT device (see
+\fBamanda-changers\fR(7))\&. The range specification can be especially useful here:
+.sp
+.nf
+tpchanger "chg\-multi:s3:mycompany\-backups/tape\-{001\&.\&.100}"
+.fi
+.PP
 This changer is not fast\-search capable\&.
 .SS "Properties"
 .PP
@@ -619,6 +702,12 @@ NDMP\-USERNAME
 
 The username for the NDMP server\&.
 .RE
+.PP
+VERBOSE
+.RS 4
+
+If true, enables the NDMJOB library\'s verbose (packet\-level) debugging\&.
+.RE
 .SS "Unmaintained Changers"
 .PP
 Amanda has many other changer scripts and programs beyond those described here (see the