X-Git-Url: https://git.gag.com/?p=debian%2Famanda;a=blobdiff_plain;f=man%2Fxml-source%2Famanda-devices.7.xml;h=f1792bdc6922edc849a664066412c15c91d722b9;hp=a333440cde2673a9e87604b57d6447503f5cc1f0;hb=b116e9366c7b2ea2c2eb53b0a13df4090e176235;hpb=fd48f3e498442f0cbff5f3606c7c403d0566150e diff --git a/man/xml-source/amanda-devices.7.xml b/man/xml-source/amanda-devices.7.xml index a333440..f1792bd 100644 --- a/man/xml-source/amanda-devices.7.xml +++ b/man/xml-source/amanda-devices.7.xml @@ -57,7 +57,7 @@ below. define device top_drive { tapedev "tape:/dev/nst0" - device_property "BLOCK_SIZE" "131072" + device-property "BLOCK_SIZE" "131072" } Such a device defininition creates a device "alias", in this case named @@ -112,9 +112,9 @@ tape devices, they will not share property values. Properties are specified in amanda.conf with the device-property parameter. The syntax looks like this: -device_property "FROBNICATOR_PATH" "/var/frobd/state" -device_property "BYTES_PER_FORTNIGHT" "128k" -device_property "USE_QUBITS" "no" +device-property "FROBNICATOR_PATH" "/var/frobd/state" +device-property "BYTES_PER_FORTNIGHT" "128k" +device-property "USE_QUBITS" "no" Both the property name and the property value are always quoted. @@ -134,7 +134,7 @@ property, below. The order in which device properties are set is as follows: Tapetype parameters (including length, blocksize, and readblocksize) are translated into device properties and set accordingly. -Device properties from any device_property +Device properties from any device-property configuration parameters are set, in the order they appear in the configuration file. @@ -178,14 +178,14 @@ for future expansion. Not all devices implement all of these properties. CONCURRENCY (read-only) This property indicates the level of concurrent access that this device supports. - - - FREE_SPACE - (read-only) This property gives the amount of free space available on the current volume, if known. This is often an estimate; for example, tape devices can only estimate the amount of tape left on a spool. FULL_DELETION (read-only) This property indicates whether the device supports erasing the entire volume. Aside from S3 and VFS, most devices cannot support this feature. + + + LEOM +(read-write) If this property is true, then the device can detect an EOM condition before actually running out of space, allowing Amanda to forgo caching parts while writing. For some devices, it is necessary to override the conservative default value of this property. MAX_BLOCK_SIZE @@ -209,7 +209,14 @@ for future expansion. Not all devices implement all of these properties. STREAMING - (read-only) This property gives the streaming requirement for this device. For example, tape drives often require a steady supply of data to avoid shoe-shining, while disk devices have no such requirement. +(read-only) This property gives the streaming requirement for this device. For +example, tape drives often require a steady supply of data to avoid +shoe-shining, while disk devices have no such requirement. Streaming is +accomplished by buffering device-output-buffer-size bytes of +data. The allowed values are "none" (no streaming buffer necessary), +"required" (fill the buffer before starting to write), or "desired" (fill the +buffer before starting to write, and if the buffer becomes empty, stop writing +until it is completely full again). VERBOSE @@ -251,6 +258,19 @@ size. +LEOM DETECTION + +Some Amanda devices can detect end-of-medium (running out of space on the +device) before it occurs. This early warning is referred to as logical EOM, +and where it is supported Amanda can operate more efficiently, since the +possibility for data loss is reduced. + +The boolean LEOM property indicates whether or not a particular device +supports LEOM detection. The sections below also describe the degree of +support. + + + @@ -280,7 +300,14 @@ alternatives are enclosed in braces and separated by commas. Braces and commas can be escaped with a backslash. Note that the backslash itself must be escaped in most contexts. For example: -tapedev "rait:{commandev:foo\\,bar,bracedev:foo\\}bar}" +tapedev "rait:{file:/var/amanda/vtapes,tape:/dev/nst0}" +tapedev "rait:{comma-dev:foo\\,bar,brace-dev:foo\\}bar}" # quoting + +If the braces contain a numeric range separated with two dots, that range will +be filled in sequentially. If the first number has a leading zero, then the results +will be zero-padded to the maximum length. For example: + +tapedev "rait:file:/var/amanda/vtapes/drive{01..04}" @@ -307,6 +334,8 @@ degraded mode). And in any case, labels on all volumes must initially match (labeled or otherwise). If you have lost one volume from a set, explicitly start the device in degraded mode as described above. +This device can detect LEOM if and only if all of the child devices can detect LEOM. + Child Device Block Sizes The RAIT device driver requires that all of its child devices use the @@ -326,8 +355,8 @@ of each child device accordingly. S3 Device tapedev "s3:foocorp-backups/DailySet1-" -device_property "S3_ACCESS_KEY" "MYACCESSKEY" -device_property "S3_SECRET_KEY" "MYSECRETKEY" +device-property "S3_ACCESS_KEY" "MYACCESSKEY" +device-property "S3_SECRET_KEY" "MYSECRETKEY" The S3 device driver uploads data to the Amazon S3 "storage cloud". Its @@ -347,9 +376,8 @@ high HTTP overhead for each request, use of larger than normal block 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. Currently, there are two valid settings: -"*" (any location, probably US) and "EU" (Europe). If this property is not set, -Amazon's default value of "*" is used. The bucket location has both billing and +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. @@ -370,6 +398,9 @@ 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. +Since Amazon storage is unlimited, the device never encounteres EOM, so +LEOM detection is trivially enabled for this device. + Device-Specific Properties In addition to the common properties, the S3 device supports the @@ -380,8 +411,8 @@ device. A typical S3 configuration will have an access key and secret key specified: -device_property "S3_ACCESS_KEY" "27D3B8C6C4E7AA423C2B37C72A0D22C8" -device_property "S3_SECRET_KEY" "agphc2Q7Zmxragphc2RmO2xragpzZGY7a2xqCgr" +device-property "S3_ACCESS_KEY" "27D3B8C6C4E7AA423C2B37C72A0D22C8" +device-property "S3_SECRET_KEY" "agphc2Q7Zmxragphc2RmO2xragpzZGY7a2xqCgr" @@ -405,9 +436,11 @@ writing long enough to bring the average below this value. S3_BUCKET_LOCATION (read-write) Location constraint for buckets on Amazon S3. -Currently, it can be set to "", for no constraint (i.e. store data in the US), -or "EU" (i.e. store data in the EU). -See Amazon's documentation for details and latest information +As of this writing, it can be set to "*" (US Standard, i.e. lowest-latency +choice of US East or West), "us-west-1" (US West, Northern California), "EU" +(European Union), or "ap-southeast-1" (Asia Pacific). See for the most up-to-date list. SSL_CA_INFO @@ -421,6 +454,13 @@ The value is passed to curl_easy_setopt(3) as CURLOPT_CAINFO. S3_SECRET_KEY (read-write) This property gives the Amazon S3 secret key used to access the service. + + + S3_STORAGE_CLASS +(read-write) Storage class for new objects, currently one of "STANDARD" (the default) +or "REDUCED_REDUNDANCY" (cheaper, but less redundant). See + +for the most up-to-date list. S3_SSL @@ -453,6 +493,14 @@ available via the command-line utilities dd(1) and mt(1). The tape device name should specify a path to the operating system's device file. +There is no simple way to determine whether a particular system +(operating system and tape hardware) supports LEOM, so as a safe default +the tape device has LEOM detection disabled. However, on modern hardware +and common operating systems (Linux, *BSD, and Solaris, at least), LEOM +support is functional. On these systems, enable LEOM by setting the LEOM +property to "true" at the appropriate place in the Amanda +configuration. + Device-Specific Properties Most of these properties are automatically detected, but can be @@ -522,8 +570,8 @@ operations can be emulated with the MTREW and read data operations. NDMP Device tapedev "ndmp:my.filer.com:10000@st1" -device_property "NDMP_USERNAME" "jimmy" -device_property "NDMP_PASSWORD" "thelock" +device-property "NDMP_USERNAME" "jimmy" +device-property "NDMP_PASSWORD" "thelock" This device enables Amanda to communicate with a tape service on an NDMP @@ -531,6 +579,8 @@ server. The device name specifies the hostname and optionally the TCP port of the NDMP server, followed by the name of the tape device on the server (st1 in the example above). +This device supports LEOM detection. + Device-Specific Properties The properties NDMP_USERNAME and @@ -554,6 +604,10 @@ no authentication attempt at all). (read-write) Username for md5 or text authentications. +READ_BLOCK_SIZE +(read-write) This property specifies the block size that will be used for reads; this should be large enough to contain any block that may be read from the device and must be larger than BLOCK_SIZE. See BLOCK_SIZES, above. + + @@ -576,14 +630,37 @@ 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. +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. + +Device-Specific Properties + + + MONITOR_FREE_SPACE + (read-write) This property controls whether the device will monitor + the filesystem's free space to detect a full filesystem before an + error occurs, and defaults to true. The monitoring operation works on + most filesystems, but if it causes problems, use this property to + disable it. + + + + + DVD-RW Device tapedev "dvdrw:/var/cache/amanda/dvd-cache:/dev/scd0" -device_property "DVDRW_MOUNT_POINT" "/media/dvd" -device_property "DVDRW_KEEP_CACHE" "false" -device_property "DVDRW_UNLABELLED_WHEN_UNMOUNTABLE" "true" +device-property "DVDRW_MOUNT_POINT" "/media/dvd" +device-property "DVDRW_KEEP_CACHE" "false" +device-property "DVDRW_UNLABELLED_WHEN_UNMOUNTABLE" "true" The DVD-RW device driver reads and writes optical media such as DVDs and @@ -614,6 +691,8 @@ be mounted should be treated as an empty, unlabelled volume when attempting to read the volume label. It is necessary to set this property to "true" when labelling such media. +This device does not support LEOM detection. + Device-Specific Properties The properties DVDRW_GROWISOFS_COMMAND, DVDRW_MOUNT_COMMAND and @@ -621,7 +700,9 @@ DVDRW_UMOUNT_COMMAND specify alternative commands for writing, mounting and unmounting optical media. The default is to find the programs using the PATH environment variable. -The DVDRW_MOUNT_POINT property is required. Other properties are optional. +The CDRW device supports all of the properties of the VFS device, as well + as the properties given below. The DVDRW_MOUNT_POINT property is required. + Other properties are optional. DVDRW_KEEP_CACHE