1AMANDA-DEVICES(7) Miscellanea AMANDA-DEVICES(7)
2
6 amanda-devices - Configuring and Using Amanda Devices
7
9 The Device API specifies a generic interface between Amanda and storage
10 devices such as tapes or disks. This manual page describes the device
11 drivers included with Amanda.
12 This is a user-level description of the API, and does not address
14 details that are only of concern to developers. For that purpose,
15 consult the Amanda source code and http://wiki.zmanda.com.
16 The term "device driver" describes the software that can communicate
18 with some kind of backend storage, e.g., a tape driver. A "device" is
19 the storage element itself, usually a piece of hardware. When
20 discussing a device and its driver as a unit, the term "device" is
21 sometimes also used to refer to the combination of device and driver.
22
24 Device names take the form TYPE:NODE, where TYPE selects a device
25 driver, and NODE provides further information to that driver. The
26 syntax for each device driver is given in the corresponding section
27 below.
28 Devices can be described in amanda.conf(5) with "device" sections,
30 e.g.,
31 define device top_drive {
33 tapedev "tape:/dev/nst0"
34 device-property "BLOCK_SIZE" "131072"
35 }
36 Such a device defininition creates a device "alias", in this case named
37 top_drive, which can then be named in the global tapedev or tpchanger
38 parameter:
39 tapedev "top_drive"
41 The global tapedev parameter can also specify a literal device name.
43 For example,
44 tapedev "file:/amdisks"
46 is equivalent to
47 tapedev "default"
49 define device default {
50 tapedev "file:/amdisks"
51 }
52 Note that, in both cases, the specified devices are actually accessed
53 through the chg-single changer driver; see amanda-changers(7) for more
54 information.
55 Device properties specified outside of any device definition apply to
57 all devices. This syntax is provided mainly for backward compatibility,
58 and for simple Amanda configurations. Note that there is no way to
59 provide properties specific to a device without defining a device
60 alias.
61 See amanda-changers(7) for details on how devices are configured, and
63 in particular on how device properties are specified. See
64 amanda.conf(5) for more information on Amanda configuration in general.
65 Note
67 There is no way to reset a device property to its default value.
68
70 Device drivers use properties as a generic means to interact with other
71 parts of Amanda. Some properties are set by the device driver and used
72 by Amanda to determine how its devices should be used. Other properties
73 can be set by Amanda or by the user to influence the driver's behavior.
74 Properties are set for a particular device, so that if you have two
75 tape devices, they will not share property values.
76 Properties are specified in amanda.conf with the device-property
78 parameter. The syntax looks like this:
79 device-property "FROBNICATOR_PATH" "/var/frobd/state"
81 device-property "BYTES_PER_FORTNIGHT" "128k"
82 device-property "USE_QUBITS" "no"
83 Both the property name and the property value are always quoted.
85 Property names, like Amanda configuration parameters, are not
86 case-sensitive, and - (dash) and _ (underscore) may be used
87 interchangeably. String values are given as simple strings, like
88 FROBNICATOR_PATH in the example above. Integer values can be specified
89 with any of the suffixes given in the "VALUE SUFFIXES" section of
90 amanda.conf(5), like BYTES_PER_FORTNIGHT, above. Boolean values can be
91 specified using the same names as in amanda.conf(5), like USE_QUBITS,
92 above. Some properties have special formats, as described below.
93 Some properties are set based on other configuration values, such as
95 tapetype parameters. These special cases are detailed under the
96 appropriate property, below.
97 The order in which device properties are set is as follows:
99 1. Tapetype parameters (including length, blocksize, and
101 readblocksize) are translated into device properties and set
102 accordingly.
103 2. Device properties from any device-property configuration parameters
105 are set, in the order they appear in the configuration file.
106 Properties described as read-only are not accessible to users. They are
108 listed here for completeness.
109 COMMON PROPERTIES
111 Note that some of these properties are currently unused, and present
112 only for future expansion. Not all devices implement all of these
113 properties.
114 APPENDABLE
116 (read-only) This boolean property indicates whether this device
118 supports appending data to volumes.
119 BLOCK_SIZE
121 (read-write) This property gives the block size, in bytes, that
123 will be used to write to the device. The usual suffixes ("kbytes",
124 etc.) are allowed. The tapetype parameter blocksize sets this
125 property.
126 CANONICAL_NAME
128 (read-only) This property contains the full canonical name for
130 this device. This name may not be the same as the user-supplied
131 name, but is a valid name by which to access this device.
132 COMMENT
134 (read-write) This string property is entirely for the user's
136 convenience. It is supported by all devices, but no device
137 interprets its value in any way.
138 COMPRESSION
140 (read-write) This boolean property represents the compression
142 status of the device, and can be used to enable and disable such
143 compression. This applies mostly to tape devices, although many
144 tape devices do not support setting compression from software.
145 COMPRESSION_RATE
147 (read-only) This property gives the compression rate, as a decimal
149 ratio. It may be a measured value over some unspecified period or
150 a simple estimate.
151 CONCURRENCY
153 (read-only) This property indicates the level of concurrent access
155 that this device supports.
156 FULL_DELETION
158 (read-only) This property indicates whether the device supports
160 erasing the entire volume. Aside from S3 and VFS, most devices
161 cannot support this feature.
162 LEOM
164 (read-write) If this property is true, then the device can detect
166 an EOM condition before actually running out of space, allowing
167 Amanda to forgo caching parts while writing. For some devices, it
168 is necessary to override the conservative default value of this
169 property.
170 MAX_BLOCK_SIZE
172 (read-only) This property gives the maximum block size this device
174 can support. See BLOCK SIZES, below.
175 MEDIUM_ACCESS_TYPE
177 (read-only) This property gives the type of the media in the
179 device: read only, WORM (Write Once, Read Many), read/write, or
180 write only. Write-only devices do not support recovery, but the
181 data are not necessarily thrown out.
182 MIN_BLOCK_SIZE
184 (read-write) This property gives the minimum block size this
186 device can support. See BLOCK SIZES, below.
187 MAX_VOLUME_USAGE
189 (read-write) On devices that support it, this property will limit
191 the total amount of data written to a volume; attempts to write
192 beyond this point will cause the device to simulate "out of space."
193 Zero means no limit. The tapetype parameter length sets this
194 property.
195 ENFORCE_MAX_VOLUME_USAGE
197 (read-write) If this property is false, limit set by
199 MAX_VOLUME_USAGE property (and thus the tapetype LENGTH parameter)
200 will not be verified while writing to device, allowing the volume
201 to expand without limit. If this property is true, then
202 MAX_VOLUME_USAGE willbe enforced, limiting the total size of the
203 volume. This property is not available on all devices; see below.
204 PARTIAL_DELETION
206 (read-only) This property indicates whether the device supports
208 deletion of specific files. Aside from linear tapes and S3, most
209 devices can support this feature. It is currently unused by
210 Amanda.
211 STREAMING
213 (read-only) This property gives the streaming requirement for this
215 device. For example, tape drives often require a steady supply of
216 data to avoid shoe-shining, while disk devices have no such
217 requirement. Streaming is accomplished by buffering
218 device-output-buffer-size bytes of data. The allowed values are
219 "none" (no streaming buffer necessary), "required" (fill the buffer
220 before starting to write), or "desired" (fill the buffer before
221 starting to write, and if the buffer becomes empty, stop writing
222 until it is completely full again).
223 VERBOSE
225 (read-write) If this boolean property is set, then the device will
227 produce verbose debugging output. This property is not recognized
228 by most devices.
229 BLOCK SIZES
231 Amanda writes device data in blocks. On most devices the block
232 boundaries are embedded in the media along with the data itself, so
233 subsequent reads must use the same block sizes. On tape devices, the
234 block size is dictated by the capabilities of the hardware -- buffer
235 sizes, physical format, and so on.
236 Amanda has historically supported a single, fixed block size -- usually
238 32k. The Device API adds the ability to specify a block size at
239 runtime, using the BLOCK_SIZE property. Devices provide MIN_BLOCK_SIZE
240 and MAX_BLOCK_SIZE as a guide to the range of acceptable block sizes.
241 Note that this does not imply that all sizes in the range
242 MIN_BLOCK_SIZE - MAX_BLOCK_SIZE are available -- the device may require
243 that block sizes are even multiples of some power of two, for example.
244 Consult the documentation for your hardware and operating system for
245 more information.
246 Most devices are flexible enough to read a volume using a different
248 block size than that with which it was written. This can be useful when
249 handling old volumes written with a smaller blocksize, or volumes of
250 unknown blocksize. Unfortunately, some tape devices do not detect
251 oversized blocks correctly, and may lose data if the configured block
252 size is smaller than the volume's block size. The tape device driver
253 has a READ_BLOCK_SIZE property which specifies the minimum buffer size
254 that will be allocated for reads from tape. If the hardware supports
255 it, setting this property allows Amanda to correctly read from tapes
256 written with any blocksize less than or equal to READ_BLOCK_SIZE.
257 Note
259 The RAIT device does not support flexible block sizes, as its
260 parity algorithm requires that all child devices have the same,
261 fixed block size.
262 LEOM DETECTION
264 Some Amanda devices can detect end-of-medium (running out of space on
265 the device) before it occurs. This early warning is referred to as
266 logical EOM, and where it is supported Amanda can operate more
267 efficiently, since the possibility for data loss is reduced.
268 The boolean LEOM property indicates whether or not a particular device
270 supports LEOM detection. The sections below also describe the degree of
271 support.
272
274 This section lists the device drivers included with Amanda, and basic
275 instructions for using them. For complete How-To information, consult
276 the Amanda wiki at http://wiki.zmanda.com.
277 Null Device
279 tapedev "null:"
280 The null device driver only supports writing, and discards all data. It
282 is generally only useful for testing purposes.
283 RAIT Device
285 tapedev "rait:tape:/dev/rmt/tps0d{4,5,6}n"
286 The RAIT device driver mirrors or stripes data over multiple "child"
288 devices. The child devices are specified using a shell-like syntax,
289 where alternatives are enclosed in braces and separated by commas.
290 Braces and commas can be escaped with a backslash. Note that the
291 backslash itself must be escaped in most contexts. For example:
292 tapedev "rait:{file:/var/amanda/vtapes,tape:/dev/nst0}"
294 tapedev "rait:{comma-dev:foo\\,bar,brace-dev:foo\\}bar}" # quoting
295 If the braces contain a numeric range separated with two dots, that
296 range will be filled in sequentially. If the first number has a leading
297 zero, then the results will be zero-padded to the maximum length. For
298 example:
299 tapedev "rait:file:/var/amanda/vtapes/drive{01..04}"
301 With two child devices, the RAIT device driver mirrors data such that
303 the two devices contain identical data and can be used singly for
304 recovery. With more than two devices, the RAIT device "stripes" data
305 across all but one device and writes a parity block to the final
306 device, usable for data recovery in the event of a device or volume
307 failure. The RAIT device scales its blocksize as necessary to match the
308 number of children that will be used to store data.
309 When a child device is known to have failed, the RAIT device should be
311 reconfigured to replace that device with the text "ERROR", e.g.,
312 tapedev "rait:{tape:/dev/st0,ERROR,tape:/dev/st2}"
314 This will cause the RAIT device to start up in degraded mode,
315 reconstructing the data from the missing device.
316 Like ordinary RAID drivers, the RAIT device driver can automatically
318 enter degraded mode when one of its child devices fails. However, the
319 RAIT device cannot automatically recover from any write error nor write
320 any data in degraded mode. When reading, certain errors may be fatal
321 (rather than causing degraded mode). And in any case, labels on all
322 volumes must initially match (labeled or otherwise). If you have lost
323 one volume from a set, explicitly start the device in degraded mode as
324 described above.
325 This device can detect LEOM if and only if all of the child devices can
327 detect LEOM.
328 Child Device Block Sizes
330 The RAIT device driver requires that all of its child devices use the
331 same block size. If no block sizes are specified, the driver selects
332 the block size closest to 32k that is within the MIN_BLOCK_SIZE -
333 MAX_BLOCK_SIZE range of all child devices, and calculates its own
334 blocksize according to the formula rait_blocksize = child_blocksize *
335 (num_children - 1). If a block size is specified for the RAIT device,
336 then it calculates its child block sizes according to the formula
337 child_blocksize = rait_blocksize / (num_children - 1). Either way, it
338 sets the BLOCK_SIZE property of each child device accordingly.
339 S3 Device
341 tapedev "s3:foocorp-backups/DailySet1-"
342 device-property "S3_ACCESS_KEY" "MYACCESSKEY"
343 device-property "S3_SECRET_KEY" "MYSECRETKEY"
344 The S3 device driver uploads data to the Amazon S3 "storage cloud". Its
346 device name is a slash-sparated combination of bucket name and prefix:
347 "s3:BUCKET/PREFIX". Since buckets must be unique across all Amazon S3
348 users, and since the number of buckets allowed to each user is limited,
349 the driver can store multiple Amanda volumes in a single S3 bucket,
350 distinguished by prefix. The prefix and slash can be omitted if they
351 are not needed: "s3:BUCKET".
352 The access and secret keys used to authenticate to Amazon S3 are
354 provided as properties.
355 The S3 device driver stores each block in a distinct S3 object. Due to
357 high HTTP overhead for each request, use of larger than normal block
358 sizes (> 1 megabyte) is recommended with the S3 device.
359 Amanda automatically creates a bucket when writing, if the bucket
361 doesn't already exist. At that time, it specifies where Amazon should
362 store the data based on the S3_BUCKET_LOCATION property. If this
363 property is not set, Amazon's default value (equivalent to "*") is
364 used. The bucket location has both billing and legal concerns, so you
365 are encouraged to consult Amazon's documentation for details.
366 Amazon does not permit changes to bucket locations, so this is a
368 permanent specification. If the bucket already exists and the property
369 is set, then Amanda checks the property against the location of the
370 bucket, and produces an error if they do not match.
371 Note
373 If a location constraint is set, the bucket name must consist only
374 of lower-case letters, numbers, dashes, and dots.
375 This driver supports the VERBOSE property, but use it carefully -- it
377 produces a great deal of output, and may cause spurious failures by
378 filling your debug log partition. Its logging is generally only useful
379 for developers chasing down a problem in communications with Amazon's
380 servers.
381 Since Amazon storage is unlimited, the device never encounteres EOM, so
383 LEOM detection is trivially enabled for this device.
384 This driver supports the ENFORCE_MAX_VOLUME_USAGE property. Default
386 value is false. See COMMON_PROPERTIES, above.
387 Device-Specific Properties
389 In addition to the common properties, the S3 device supports the
390 properties listed in this section.
391 Most Amanda devices work just fine without any properties, but not the
393 S3 device. A typical S3 configuration will have an access key and
394 secret key specified:
395 device-property "S3_ACCESS_KEY" "27D3B8C6C4E7AA423C2B37C72A0D22C8"
397 device-property "S3_SECRET_KEY" "agphc2Q7Zmxragphc2RmO2xragpzZGY7a2xqCgr"
398 CHUNKED
401 (read-write) Default: No. Set to yes if the server support chunked
403 transfer-encoding. Amazon do not support it, google support it.
404 CLIENT_ID
406 (read-write) The client_id for oauth2.
408 CLIENT_SECRET
410 (read-write) The client_secret for oauth2.
412 CREATE-BUCKET
414 (read-write) Default: yes. If amanda create/delete the bucket.
416 REFRESH_TOKEN
418 (read-write) The refresh-token for oauth2.
420 MAX_RECV_SPEED
422 (read-write) Maximum speed, in bytes per second, that this device
424 will receive data from S3. If the average speed exceeds this
425 value, the device will stop reading long enough to bring the
426 average below this value. Minimum value is 5120.
427 MAX_SEND_SPEED
429 (read-write) Maximum speed, in bytes per second, that this device
431 will send data to S3. If the average speed exceeds this value, the
432 device will stop writing long enough to bring the average below
433 this value. Minimum value is 5120.
434 NB_THREADS_BACKUP
436 (read-write) The number of thread that send data to the s3 device,
438 higher value can provide more throutput.
439 NB_THREADS_RECOVERY
441 (read-write) The number of thread that read data from the s3
443 device, higher value can provide more throutput.
444 OPENSTACK_SWIFT_API
446 (read-write) Deprecated, set "STORAGE_API to "SWIFT-1.0".
448 PROXY
450 (read-write) The proxy hostname or IP in the format "host[:port]".
452 PASSWORD
454 (read-write) The password (for swift v2 and v3).
456 PROJECT-ID
458 (read-write) The projectid (for google).
460 READ-FROM-GLACIER
462 (read-write) Default: NO. Set it to "YES" if some files are
464 transitioned to glacier.
465 REUSE-CONNECTION
467 (read-write) Default: YES. Set it to "NO" if reusing a connection
469 cause some bug, this is sometime the case with big block size.
470 S3_ACCESS_KEY
472 (read-write) This property gives the Amazon S3 access key used to
474 access the service.
475 S3_SESSION_TOKEN
477 (read-write) This property gives the Amazon S3 session token used
479 to access the service.
480 S3_BUCKET_LOCATION
482 (read-write) Location constraint for buckets on Amazon S3. As of
484 this writing, it can be set to "*" (US Standard, i.e.
485 lowest-latency choice of US East or West), "us-west-1" (US West,
486 Northern California), "EU" (European Union), or "ap-southeast-1"
487 (Asia Pacific). See :
488 http://docs.amazonwebservices.com/general/latest/gr/index.html?rande.html
489 for the most up-to-date list.
490 S3_MULTI_DELETE
492 (read-write) If the server support the multi delete protocol (only
494 Amazon S3), default is "YES" for "S3" and "AWS4" STORAGE_API,
495 default in "NO" for all others STORAGE_API.
496 S3_MULTI_PART_UPLOAD
498 (read-write) If the server support the multi part upload api (only
500 Amazon S3), default is "NO". Use less s3 objects.
501 SSL_CA_INFO
503 (read-write) Path to CA certificate to use to verify the identity
505 of the S3 server. Only applicable when SSL/TLS is in use. The
506 certificate should be in PEM format if OpenSSL or GnuTLS is being
507 used with libcurl. Multiple certificates can be bundled together
508 simply by concatenating them. If NSS is being used, then it is the
509 directory that the database resides in. The value is passed to
510 curl_easy_setopt(3) as CURLOPT_CAINFO.
511 S3_HOST
513 (read-write) The host name to connect, in the form "hostname:port"
515 or "ip:port", default is "s3.amazonaws.com"
516 S3_SECRET_KEY
518 (read-write) This property gives the Amazon S3 secret key used to
520 access the service.
521 S3_SERVER_SIDE_ENCRYPTION
523 (read-write) Set to the server side encryption algorithm to use.
525 There is actually only one algorithm, it is "AES256". The
526 encryption is done by Amazon on their server. See :
527 http://docs.amazonwebservices.com/AmazonS3/latest/API/index.html?RESTObjectPUT.html
528 for the most up-to-date list.
529 S3_SERVICE_PATH
531 (read-write) A path to add at the beginning of the URL.
533 S3_STORAGE_CLASS
535 (read-write) Storage class for new objects.
537 S3 compatible
539 STANDARD
540 STANDARD_IA
541 REDUCED_REDUNDANCY
542 Google storage
544 STANDARD
545 DURABLE_REDUCED_AVAILABILITY
546 NEARLINE
547 S3_SSL
549 (read-write) Whether or not to use SSL/TLS to secure communications
551 with Amazon S3.
552 S3_SUBDOMAIN
554 (read-write) Whether or not to use subdomain hostname.
556 S3_USER_TOKEN
558 (read-write) This property specifies the user token for Amanda
560 Enterprise Edition customers.
561 STORAGE_API
563 (read-write) Which API to use for the cloud:
565 S3 Amazon S3 AWS Signature Version 2
566 AWS4 Amazon S3 AWS Signature Version 4
567 SWIFT-1.0 Openstack swift v1.0
568 SWIFT-2.0 Openstack swift v2.0
569 SWIFT-3 Openstack swift keystone v3
570 OAUTH2 Google
571 CASTOR Caringo CAStor
572 The default is AWS4 if S3-HOST end with '.amazonaws.com', otherwise
574 it is S3.
575 TENANT_ID
577 (read-write) The tenant id (for swift v2).
579 TENANT_NAME
581 (read-write) The tenant name (for swift v2).
583 PROJECT_NAME
585 (read-write) Default: $USERNAME. The project name (for swift v3).
587 DOMAIN_NAME
589 (read-write) Default: "Default". The domain name (for swift v3).
591 TIMEOUT
593 (read-write) Add a timeout to all transfer to the cloud, default
595 is 0, which is no timeout.
596 TRANSITION-TO-GLACIER
598 (read-write) Default: -1. Set to a value greater or equal to zero
600 to transition a volume to glacier that number of days after it is
601 set to no-reuse.
602 USERNAME
604 (read-write) The username (for swift v2 and v3).
606 VERBOSE
608 (read-write) If true, verbose data about each HTTP transaction is
610 sent to the debug log.
611 S3 URL
613 SSL && SUBDOMAIN: https://bucket.host/service_path/file
614 SSL && !SUBDOMAIN: https://host/service_path/bucket/file
615 !SSL && SUBDOMAIN: http://bucket.host/service_path/file
616 !SSL && !SUBDOMAIN: http://host/service_path/bucket/file
617 Tape Device
619 tapedev "tape:/dev/nst0"
620 The tape device driver interacts with a tape drive. The device uses the
622 operating system's built-in tape support, which is generally similar to
623 that available via the command-line utilities dd(1) and mt(1).
624 The tape device name should specify a path to the operating system's
626 device file.
627 There is no simple way to determine whether a particular system
629 (operating system and tape hardware) supports LEOM, so as a safe
630 default the tape device has LEOM detection disabled. However, on modern
631 hardware and common operating systems (Linux, *BSD, and Solaris, at
632 least), LEOM support is functional. On these systems, enable LEOM by
633 setting the LEOM property to "true" at the appropriate place in the
634 Amanda configuration.
635 Device-Specific Properties
637 Most of these properties are automatically detected, but can be
638 overridden in the configuration file if the autodetection fails. Note
639 that tape drives are required to at least support the MTREW (rewind)
640 operation; all other operations can be emulated with the MTREW and read
641 data operations.
642 BROKEN_GMT_ONLINE
644 (read-write) Set this boolean property if the system's GMT_ONLINE
646 macro gives incorrect results. This is currently true for the
647 Linux IDE-TAPE driver.
648 BSF
650 (read-write) This boolean property specifies whether the device
652 driver may execute the MTBSF operation (backward seek file).
653 BSF_AFTER_EOM
655 (read-write) This boolean property specifies whether the device
657 driver should execute an MTBSF (backward seek file) operation
658 after
659 MTEOM (seek to end of recorded data) in order to append.
660 BSR
662 (read-write) This boolean property specifies whether the device
664 driver may use the MTBSR operation (backward seek record).
665 EOM
667 (read-write) This boolean property specifies whether the device
669 driver may use the MTEOM command (seek to end of recorded data).
670 FINAL_FILEMARKS
672 (read-write) This integer property gives the number of filemarks
674 that should be written at EOD. It is usually 1 or 2.
675 FSF
677 (read-write) This boolean property specifies whether the device
679 driver may use the MTFSF operation (forward seek file).
680 FSF_AFTER_FILEMARK
682 (read-write) This boolean property specifies whether the device
684 driver needs a FSF to go the next file after the filemark is read.
685 Default to "TRUE" on Solaris and "FALSE" on all others machines.
686 FSR
688 (read-write) This boolean property specifies whether the device
690 driver may use the MTFSR operation (forward seek record).
691 NONBLOCKING_OPEN
693 (read-write) Set this boolean property to "true" if O_NONBLOCK
695 must be used on the open call. Default to "true" on Linux and
696 "false" on all others machines. Without it, Linux wait for a few
697 seconds if no tape are loaded. Solaris have strange error it is set
698 to "yes".
699 READ_BLOCK_SIZE
701 (read-write) This property (previously known as READ_BUFFER_SIZE)
703 specifies the block size that will be used for reads; this should
704 be large enough to contain any block that may be read from the
705 device (for example, from a tape containing variable-sized blocks),
706 and must be larger than BLOCK_SIZE. This property is most often
707 used when overwriting tapes using a new, smaller block size.
708 The tapetype parameter READBLOCKSIZE sets this property. See
709 BLOCK SIZES, above.
710 NDMP Device
712 tapedev "ndmp:my.filer.com:10000@st1"
713 device-property "NDMP_USERNAME" "jimmy"
714 device-property "NDMP_PASSWORD" "thelock"
715 This device enables Amanda to communicate with a tape service on an
717 NDMP server. The device name specifies the hostname and optionally the
718 TCP port of the NDMP server, followed by the name of the tape device on
719 the server (st1 in the example above).
720 This device supports LEOM detection.
722 Device-Specific Properties
724 The properties NDMP_USERNAME and NDMP_PASSWORD set the username and
725 password with which to access the NDMP server. The default for both is
726 "ndmp".
727 INDIRECT
729 (read-write) The default is "yes". You can set it to "no" if the
731 ndmp server can be set to a window length of 0.
732 NDMP_AUTH
734 (read-write) Authentication method to use to connect to the NDMP
736 server. One of "md5" (default), "text", "none" (for an empty
737 authentication attempt) or "void" (for no authentication attempt at
738 all).
739 NDMP_PASSWORD
741 (read-write) Password for md5 or text authentications.
743 NDMP_USERNAME
745 (read-write) Username for md5 or text authentications.
747 READ_BLOCK_SIZE
749 (read-write) This property specifies the block size that will be
751 used for reads; this should be large enough to contain any block
752 that may be read from the device and must be larger than
753 BLOCK_SIZE. See BLOCK_SIZES, above.
754 VFS Device
756 tapedev "file:/path/to/vtape"
757 The VFS device driver stores data on a UNIX filesystem. Note that
759 although one typically uses the VFS device driver to store data on hard
760 disks, the driver does not interface with any hardware on a block
761 level.
762 The device name specifies a path to a directory which must exist and
764 contain a "data/" subdirectory. Each tape file is stored as a distinct
765 file in this directory, the name of which reflects the Amanda header in
766 the tape file. Block boundaries are not maintained: the driver supports
767 reads of arbitrary size, regardless of the blocksize used to write the
768 data.
769 This device supports LEOM detection. LEOM will be indicated when the
771 MAX_VOLUME_USAGE is nearly met, or when the filesystem is nearly out of
772 space. The latter circumstance is detected by monitoring the available
773 space on the filesystem, and this monitoring can be disabled with the
774 MONITOR_FREE_SPACE property. Note that the device cannot detect other
775 circumstances that may cause a write to fail, such as a filesystem
776 quota. LEOM detection can be disabled by setting the LEOM property to
777 false.
778 This device supports the ENFORCE_MAX_VOLUME_USAGE property. Default
780 value is true. See COMMON PROPERTIES, above.
781 Device-Specific Properties
783 MONITOR_FREE_SPACE
784 (read-write) This property controls whether the device will monitor
786 the filesystem's free space to detect a full filesystem before an
787 error occurs, and defaults to true. The monitoring operation works
788 on most filesystems, but if it causes problems, use this property
789 to disable it.
790 USE_DATA
792 (read-write) (Default: "EXIST") This property controls whether the
794 device use the 'data' subdirectory, A value of "NO" never use it. A
795 value of "YES" always use it. A value of "EXIST" use it only if it
796 exist.
797 DISKFLAT Device
799 tapedev "diskflat:/path/to/diskflat/label-001"
800 Each slot is a single file named with the slot label.
802 The MAX-DLE-BY-VOLUME setting must be set to 1.
804 Must be used with the diskflat changer.
806 tpchanger "chg-diskflat:diskflat:/path/to/diskflat/label-{001..010}"
807 autolabel "label-$5s" empty volume-error
808 labelstr MATCH-AUTOLABEL
809 max-dle-by-volume 1
810 Device-Specific Properties
812 Have the same property as the VFS device with the following difference:
813 USE_DATA
815 Unused
816 DVD-RW Device
818 tapedev "dvdrw:/var/cache/amanda/dvd-cache:/dev/scd0"
819 device-property "DVDRW_MOUNT_POINT" "/media/dvd"
820 device-property "DVDRW_KEEP_CACHE" "false"
821 device-property "DVDRW_UNLABELLED_WHEN_UNMOUNTABLE" "true"
822 The DVD-RW device driver reads and writes optical media such as DVDs
824 and CDs. The device name must specify a cache directory for data to be
825 temporarily stored, followed by the operating system name for the
826 optical drive. The cache directory must contain a "data/" subdirectory.
827 The DVDRW_MOUNT_POINT property is required, and specifies a directory
829 where the optical media can be mounted. This directory must be
830 configured to enable non-root users to mount the optical media. On
831 Linux, that means a line similar to the following in /etc/fstab:
832 /dev/scd0 /media/dvd auto ro,user,noauto 0 0
833 Note the "user" option.
835 When writing data, the device acts as a VFS device using the given
837 cache directory. On completion of writing the tape, the cache directory
838 is written to optical media. The DVDRW_KEEP_CACHE property controls
839 whether the cache contents are immediately deleted. When reading, the
840 optical media is first mounted and read as a VFS device.
841 Attempting to mount unformatted media or media that is formatted but
843 contains no filesystem will usually result in an error. The boolean
844 DVDRW_UNLABELLED_WHEN_UNMOUNTABLE property specifies whether media that
845 cannot be mounted should be treated as an empty, unlabelled volume when
846 attempting to read the volume label. It is necessary to set this
847 property to "true" when labelling such media.
848 This device does not support LEOM detection.
850 Device-Specific Properties
852 The properties DVDRW_GROWISOFS_COMMAND, DVDRW_MOUNT_COMMAND and
853 DVDRW_UMOUNT_COMMAND specify alternative commands for writing, mounting
854 and unmounting optical media. The default is to find the programs using
855 the PATH environment variable.
856 The CDRW device supports all of the properties of the VFS device, as
858 well as the properties given below. The DVDRW_MOUNT_POINT property is
859 required. Other properties are optional.
860 DVDRW_KEEP_CACHE
862 (read-write) Set this boolean property to "true" if the disk cache
864 directory should be kept after successfully writing tape data to
865 optical media. The default is false, which causes the cache
866 contents to be deleted immediately after a successful write
867 operation.
868 DVDRW_MOUNT_POINT
870 (read-write) This property specifies the filesystem mount point
872 for the optical media. Non-root users must be able to mount optical
873 media by invoking "mount" and specifying this mount point.
874 DVDRW_UNLABELLED_WHEN_UNMOUNTABLE
876 (read-write) Treat unmountable media as empty, unlabelled media.
878 This is necessary when attempting to label freshly formatted media.
879 DVDRW_GROWISOFS_COMMAND
881 (read-write) The command to invoke to burn the DVD.
883 DVDRW_MOUNT_COMMAND
885 (read-write) The command to invoke to mount the DVD.
887 DVDRW_UMOUNT_COMMAND
889 (read-write) The command to invoke to unmount the DVD.
891
893 amanda(8), amanda.conf(5), amanda-changers(7)
894 The Amanda Wiki: : http://wiki.zmanda.com/
896
898 Ian Turner <ian@zmanda.com>
899 Zmanda, Inc. (http://www.zmanda.com)
900 Dustin J. Mitchell <dustin@zmanda.com>
902 Zmanda, Inc. (http://www.zmanda.com)
903Amanda 3.5.4 07/27/2023 AMANDA-DEVICES(7)