Imported Upstream version 3.3.0
[debian/amanda] / man / amanda-devices.7
index 6ff0a898ae4b5e511e56555fc962496f36854a15..ef52fcb66c17615f7919751d94b22223b9763f14 100644 (file)
@@ -2,12 +2,12 @@
 .\"     Title: amanda-devices
 .\"    Author: Ian Turner <ian@zmanda.com>
 .\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
-.\"      Date: 12/14/2010
+.\"      Date: 06/02/2011
 .\"    Manual: Miscellanea
-.\"    Source: Amanda 3.2.1
+.\"    Source: Amanda 3.3.0
 .\"  Language: English
 .\"
-.TH "AMANDA\-DEVICES" "7" "12/14/2010" "Amanda 3\&.2\&.1" "Miscellanea"
+.TH "AMANDA\-DEVICES" "7" "06/02/2011" "Amanda 3\&.3\&.0" "Miscellanea"
 .\" -----------------------------------------------------------------
 .\" * set default formatting
 .\" -----------------------------------------------------------------
@@ -238,6 +238,12 @@ MAX_VOLUME_USAGE
  (read\-write) On devices that support it, this property will limit the total amount of data written to a volume; attempts to write beyond this point will cause the device to simulate "out of space\&."  Zero means no limit\&.  The tapetype parameter \fIlength\fR sets this property\&.
 .RE
 .PP
+ENFORCE_MAX_VOLUME_USAGE
+.RS 4
+
+ (read\-write) If this property is false, limit set by MAX_VOLUME_USAGE property (and thus the tapetype LENGTH parameter) will not be verified while writing to device, allowing the volume to expand without limit\&. If this property is true, then MAX_VOLUME_USAGE willbe enforced, limiting the total size of the volume\&. This property is not available on all devices; see below\&.
+.RE
+.PP
 PARTIAL_DELETION
 .RS 4
 
@@ -344,7 +350,7 @@ The S3 device driver uploads data to the Amazon S3 "storage cloud"\&. Its device
 .PP
 The access and secret keys used to authenticate to Amazon S3 are provided as properties\&.
 .PP
-The S3 device driver stores each block in a distinct S3 object\&. Due to high HTTP overhead for each request, use of larger than normal block sizes (> 1 megabyte) is reccomended with the S3 device\&.
+The S3 device driver stores each block in a distinct S3 object\&. Due to high HTTP overhead for each request, use of larger than normal block sizes (> 1 megabyte) is recommended with the S3 device\&.
 .PP
 Amanda automatically creates a bucket when writing, if the bucket doesn\'t already exist\&. At that time, it specifies where Amazon should store the data based on the S3_BUCKET_LOCATION property\&. If this property is not set, Amazon\'s default value (equivalent to "*") is used\&. The bucket location has both billing and legal concerns, so you are encouraged to consult Amazon\'s documentation for details\&.
 .PP
@@ -369,6 +375,8 @@ If a location constraint is set, the bucket name must consist only of lower\-cas
 This driver supports the VERBOSE property, but use it carefully \-\- it produces a great deal of output, and may cause spurious failures by filling your debug log partition\&. Its logging is generally only useful for developers chasing down a problem in communications with Amazon\'s servers\&.
 .PP
 Since Amazon storage is unlimited, the device never encounteres EOM, so LEOM detection is trivially enabled for this device\&.
+.PP
+This driver supports the ENFORCE_MAX_VOLUME_USAGE property\&. Default value is false\&. See COMMON_PROPERTIES, above\&.
 .SS "Device-Specific Properties"
 .PP
 In addition to the common properties, the S3 device supports the properties listed in this section\&.
@@ -396,6 +404,18 @@ data to S3\&.  If the average speed exceeds this value, the device will stop
 writing long enough to bring the average below this value\&.
 .RE
 .PP
+NB_THREADS_BACKUP
+.RS 4
+
+(read\-write) The number of thread that send data to the s3 device, higher value can provide more throutput\&.
+.RE
+.PP
+NB_THREADS_RECOVERY
+.RS 4
+
+(read\-write) The number of thread that read data from the s3 device, higher value can provide more throutput\&.
+.RE
+.PP
 S3_ACCESS_KEY
 .RS 4
 
@@ -422,10 +442,22 @@ If NSS is being used, then it is the directory that the database resides in\&.
 The value is passed to curl_easy_setopt(3) as CURLOPT_CAINFO\&.
 .RE
 .PP
+S3_HOST
+.RS 4
+
+(read\-write) The host name to connect, in the form "hostname:port" or "ip:port", default is "s3\&.amazonaws\&.com"
+.RE
+.PP
 S3_SECRET_KEY
 .RS 4
 
- (read\-write) This property gives the Amazon S3 secret key used to access the service\&.
+(read\-write) This property gives the Amazon S3 secret key used to access the service\&.
+.RE
+.PP
+S3_SERVICE_PATH
+.RS 4
+
+(read\-write) A path to add at the beginning of the URL\&.
 .RE
 .PP
 S3_STORAGE_CLASS
@@ -440,20 +472,32 @@ for the most up\-to\-date list\&.
 S3_SSL
 .RS 4
 
- (read\-write) Whether or not to use SSL/TLS to secure communications with Amazon S3\&.
+(read\-write) Whether or not to use SSL/TLS to secure communications with Amazon S3\&.
+.RE
+.PP
+S3_SUBDOMAIN
+.RS 4
+
+ (read\-write) Whether or not to use subdomain hostname\&.
 .RE
 .PP
 S3_USER_TOKEN
 .RS 4
 
- (read\-write) This property specifies the user token for Amanda Enterprise Edition customers\&.
+(read\-write) This property specifies the user token for Amanda Enterprise Edition customers\&.
 .RE
 .PP
 VERBOSE
 .RS 4
 
- (read\-write) If true, verbose data about each HTTP transaction is sent to the debug log\&.
+(read\-write) If true, verbose data about each HTTP transaction is sent to the debug log\&.
 .RE
+.SS "S3 URL"
+
+     SSL &&  SUBDOMAIN:   https://bucket\&.host/service_path/file
+     SSL && !SUBDOMAIN:   https://host/service_path/bucket/file
+    !SSL &&  SUBDOMAIN:   http://bucket\&.host/service_path/file
+    !SSL && !SUBDOMAIN:   http://host/service_path/bucket/file
 .SS "Tape Device"
 .nf
 tapedev "tape:/dev/nst0"
@@ -593,6 +637,8 @@ The VFS device driver stores data on a UNIX filesystem\&. Note that although one
 The device name specifies a path to a directory which must exist and contain a "data/" subdirectory\&. Each tape file is stored as a distinct file in this directory, the name of which reflects the Amanda header in the tape file\&. Block boundaries are not maintained: the driver supports reads of arbitrary size, regardless of the blocksize used to write the data\&.
 .PP
 This device supports LEOM detection\&. LEOM will be indicated when the MAX_VOLUME_USAGE is nearly met, or when the filesystem is nearly out of space\&. The latter circumstance is detected by monitoring the available space on the filesystem, and this monitoring can be disabled with the MONITOR_FREE_SPACE property\&. Note that the device cannot detect other circumstances that may cause a write to fail, such as a filesystem quota\&. LEOM detection can be disabled by setting the LEOM property to false\&.
+.PP
+This device supports the ENFORCE_MAX_VOLUME_USAGE property\&. Default value is true\&. See COMMON PROPERTIES, above\&.
 .SS "Device-Specific Properties"
 .PP
 MONITOR_FREE_SPACE