503089e049808cc5d9d6df295ad8a5e9dd238e35
[debian/amanda] / man / amanda-changers.7
1 '\" t
2 .\"     Title: amanda-changers
3 .\"    Author: Dustin J. Mitchell <dustin@zmanda.com>
4 .\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
5 .\"      Date: 06/01/2010
6 .\"    Manual: Miscellanea
7 .\"    Source: Amanda 3.1.0
8 .\"  Language: English
9 .\"
10 .TH "AMANDA\-CHANGERS" "7" "06/01/2010" "Amanda 3\&.1\&.0" "Miscellanea"
11 .\" -----------------------------------------------------------------
12 .\" * set default formatting
13 .\" -----------------------------------------------------------------
14 .\" disable hyphenation
15 .nh
16 .\" disable justification (adjust text to left margin only)
17 .ad l
18 .\" -----------------------------------------------------------------
19 .\" * MAIN CONTENT STARTS HERE *
20 .\" -----------------------------------------------------------------
21 .SH "NAME"
22 amanda-changers \- Configuring and Using Amanda Changers
23 .SH "DESCRIPTION"
24 .PP
25 Amanda uses changers to arbitrate access to devices (\fBamanda-devices\fR(7)) and data volumes\&. Changers provide an abstraction of tape robots, but are used to manage non\-tape media, too\&. Amanda communicates with changers through the Changer API\&. This manpage contains a
26 \fIuser\-level\fR
27 overview of the API, and does not address details that are only of concern to developers\&. For that purpose, consult the Amanda source code and http://wiki\&.zmanda\&.com\&.
28 .SH "TRANSITION"
29 .PP
30 The Amanda Changer API is in transition from version 1\&.0 \- driven by shell scripts invoked for each changer operation \- to version 2\&.0, composed of perl objects that can manage parallel access to multiple devices and other complexity\&. At this point, all Amanda programs use the new Changer API directly, although 1\&.0 changer scripts are still fully supported via
31 chg\-compat\&.
32 .PP
33 The Changer API strives to treat all changers identically, so that Amanda\'s behavior is independent of the changer in use\&. However, some parts of Amanda operate differently depending on whether a changer can efficiently search for a volume with a given label\&. This distinction is really only apparent with tape libraries: those with barcode readers can quickly find a desired tape, while those without may fall back to an inefficient scan of each volume\&. The capability to perform quick searches is called "fast\-search", and each changer is annotated below to indicate its support\&.
34 .SH "SPECIFYING CHANGERS"
35 .PP
36 Changer specifications are strings like
37 chg\-disk:/my/vtapes\&. The
38 chg\-
39 prefix serves to differentiate changers from devices (see
40 \fBamanda-devices\fR(7))\&. The next portion (disk, in this case) identifies the particular changer driver to use, and everything that follows the
41 :
42 is interpreted by the driver\&. Note that the
43 :
44 character is required, even when nothing follows it\&. This is an easy way to distinguish new changer specifications from old\&.
45 .PP
46 A name which does not match this pattern, but which matches an old changer script (e\&.g\&.,
47 chg\-zd\-mtx), invokes the backward\-compatibility changer driver as e\&.g\&.,
48 chg\-compat:chg\-zd\-mtx\&. If the name does not match an old changer, then it is treated as an Amanda device, and is wrapped by the single\-device changer, e\&.g\&.,
49 chg\-single:tape:/dev/rmt/0\&.
50 .PP
51 Changers which require additional parameters can also be described in
52 \fBamanda.conf\fR(5)
53 with "changer" sections\&. Such a changer defininition creates a changer "alias", in this case named
54 \fIhp\-robot\fR, which can then be named where an application expects a changer \- for example, the target of the
55 \fBamvault\fR
56 command or in a global
57 \fBtpchanger\fR
58 parameter\&.
59 .SS "CONFIGURATION"
60 .PP
61 The preferred method of specifying configuration for a changer is as a "changer" section in
62 \fBamanda.conf\fR(5)\&. The
63 \fItapedev\fR
64 parameter then indicates, by name, the changer that will be used by default by most Amanda programs\&. For example:
65 .sp
66 .nf
67 define changer hp\-robot {
68     tapedev "chg\-robot:/dev/sg1"
69     property "tape\-device" "0=tape:/dev/nst0"
70     property append "tape\-device" "1=tape:/dev/nst1"
71     device_property "BLOCK_SIZE" "512k"
72 }
73 # \&.\&.\&.
74 tapedev "hp\-robot"
75 .fi
76 .PP
77 Several changer drivers accept
78 \fIchanger properties\fR
79 which control the behavior of the changer\&. These properties must be specified in a changer definition, as in the
80 \fIhp\-robot\fR
81 example, above\&.
82 .PP
83 Devices, too, can take properties to control their behavior (see
84 \fBamanda-devices\fR(7))\&. Device properties can come from four places: implicit device properties (from tapetype parameters), global device properties (from global
85 \fIdevice_property\fR
86 parameters), properties in device definitions, and properties in changer definitions\&. Properties are applied in this order, with later properties taking priority\&.
87 .PP
88 There are only three implicit properties:
89 \fIMAX_VOLUME_USAGE\fR
90 is set based on the tapetype
91 \fIlength\fR
92 parameter,
93 \fIREAD_BLOCK_SIZE\fR
94 is set if
95 \fIreadblocksize\fR
96 is set, and
97 \fIBLOCK_SIZE\fR
98 is set based on the
99 \fIblocksize\fR
100 parameter\&.
101 .PP
102 Global device properties always apply\&. If the changer specifies a device by alias, then device properties from the definition apply\&. If the changer is specified by an alias, then properties from that definition applied\&.
103 .SH "CHANGER DRIVERS"
104 .PP
105 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\&.
106 .SS "chg\-disk:VTAPEROOT (new)"
107 .nf
108 tpchanger "chg\-disk:/u01/vtapes"
109 .fi
110 .PP
111 This changer driver replaces the old
112 \fBchg\-disk\fR, supporting parallel access to vtapes stored in directories named
113 slotN
114 in the directory specified after
115 chg\-disk:\&. It does so by creating numbered "drives" so that simultaneous processes can access distinct slots\&. This changer is fast\-search capable\&.
116 .PP
117 The current slot can be accessed using the device name
118 file:VTAPEROOT\&. This is useful for the
119 \fBamrestore\fR(8)
120 command line\&.
121 .SS "chg\-disk (old)"
122 .nf
123 tapedev "file:/u01/vtapes"
124 tpchanger "chg\-disk"
125 changerfile "chg\-disk\&.conf"     # optional file
126 .fi
127 .PP
128 This changer script supports sequential access to vtapes stored in directories named
129 slotN
130 in the directory specified by the
131 \fItapedev\fR
132 parameter\&. The configuration file parameter is:
133 .sp
134 .nf
135 LASTSLOT=number    # The number of slots, default to tapecycle setting\&.
136 .fi
137 .PP
138 This changer is not fast\-search capable\&.
139 .SS "chg\-multi:DEVICE\-LIST"
140 .nf
141 tpchanger "chg\-multi:{/dev/nst0,/dev/nst1,/dev/nst2}"
142 changerfile "chg\-multi\-state"
143 .fi
144 .PP
145 This script simply round\-robins a number of distinct device names, as specified in the
146 \fItpchanger\fR
147 setting\&. It is useful when all volumes for a configuration have different device names \-\- for example, if you have many standalone drive\&. The
148 \fIchangerfile\fR
149 must exist; it is used to save the state file\&.
150 .PP
151 This changer is not fast\-search capable\&.
152 .SS "Properties"
153 .PP
154 FIRST\-SLOT
155 .RS 4
156
157 This property gives the number of the first slot\&. The default value is "1"\&.
158 .RE
159 .SS "Special Operations"
160 .PP
161 A number of special operations are available for
162 \fBchg\-multi\fR
163 via
164 \fBamtape\fR(8)
165 subcommands\&.
166 .PP
167 The
168 \fBreset\fR
169 subcommand will change the current slot to the first available slot, but does not erase any stored state maintained by the changer\&.
170 .PP
171 The
172 \fBeject\fR
173 subcommand will eject the volume in the given drive
174 .PP
175 The
176 \fBclean\fR
177 subcommand is not yet implemented\&.
178 .PP
179 The
180 \fBupdate\fR
181 subcommand instructs the changer to update its state database\&. Given no arguments, the changer will scan all available slots, loading each tape and reading its label\&. Especially for large libraries, this can take a long time\&. If only a few slots have changed, they can be listed on the command line:
182 .sp
183 .nf
184 amtape CONFIG update 1\-3,9
185 .fi
186 In this case, the changer will only scan the stated slots\&. Finally, the changer will not scan at all if it is given the tape label for the slot:
187 .sp
188 .nf
189 amtape CONFIG update 2=DailySet\-028
190 .fi
191 In this case, the changer updates its state to indicate that
192 DailySet\-028
193 is in slot 2, without trying to load the tape\&.
194 .sp
195 .nf
196 amtape CONFIG update 1\-3,9=
197 .fi
198 In this case, the changer marks the stated slots as an unknown state\&.
199 .SS "chg\-multi (old)"
200 .nf
201 tpchanger "chg\-multi"
202 changerfile "chg\-multi\-state"
203 .fi
204 .PP
205 This script simply round\-robins a number of distinct device names, as specified in its configuration file\&. It is useful when all volumes for a configuration have different device names \-\- for example, with S3 devices\&. The
206 \fIchangerfile\fR
207 need not exist; it is used as a prefix for filenames of state files\&.
208 .PP
209 The configuration file has simple lines with a parameter and its value separated by a space\&. The # character introduces a comment\&. The configuration parameters are:
210 .PP
211 multieject
212 .RS 4
213 If this is 1, use an \'mt
214 offline\' command to change to the next tape, or multiple such commands for
215 skipping several tapes at a time\&.
216 .RE
217 .PP
218 needeject
219 .RS 4
220 This option is incompatible with
221 \'multieject\'\&. This should be 1 for changers accessed through several virtual
222 tape devices, when the changer needs the current tape to be ejected before
223 changing to another device\&.
224 .RE
225 .PP
226 gravity
227 .RS 4
228 Set this to 1 if the
229 changer/stacker is unable to loop back to the first tape after unloading the
230 last one, or if you don\'t want amanda to go through the tape stack looking for
231 the exact tape it wants instead of using the first acceptable one\&.
232 .RE
233 .PP
234 slot X
235 .RS 4
236 The configuration file should list
237 as many \'slot X\' statements as the number of slots supported by the changer or
238 the number of separate tape drives used\&.
239 .RE
240 .PP
241 This changer is not fast\-search capable\&.
242 .SS "chg\-manual"
243 .nf
244 tpchanger "chg\-manual"
245 changerfile "chg\-manual\&.conf"
246 .fi
247 .PP
248 This script simply provides distinct device names in a round\-robin fashion, as specified in its configuration file\&. It is useful when all volumes for a configuration have different device names \-\- for example, with S3 devices\&. The configuration file parameters are (as listed in the script):
249 .sp
250 .nf
251 resend_mail=900       # resend mail every __ seconds
252 timeout_mail=604800   # time out after this many seconds (default 7 days)
253 request="[type]"      # How to request a new tape (default "tty_email")
254   request="tty"       # Use the tty to ask the user to change tape\&.
255                       # Can\'t be use by cron
256   request="email"     # Send an email to ask the user to change tape\&.
257   request="tty_email" # Use the tty if it exist or send an email\&.
258 .fi
259 .PP
260 This changer is not fast\-search capable\&.
261 .SS "chg\-zd\-mtx (old)"
262 .nf
263 tpchanger "chg\-zd\-mtx"
264 changerdev "/dev/sg0"         # used with \'mtx \-f\'
265 changerfile "chg\-zd\-mtx\&.conf"
266 tapedev "tape:/dev/nst0"
267 .fi
268 .PP
269 This script interfaces with a tape drive using the Zubkoff/Dandelion version of mtx\&. That\'s the version that takes a device specifier with the
270 \fB\-f\fR
271 option and has subcommands like
272 \fBstatus\fR\&. The configuration file parameters are (as listed in the script itself):
273 .sp
274 .nf
275 firstslot=?                 #### First storage slot (element)
276 lastslot=?                  #### Last storage slot (element)
277 cleanslot=\-1                #### Slot with cleaner tape \-\- default is "\-1"
278                             #### Set negative to indicate no cleaner available
279 driveslot=0                 #### Drive slot number\&.  Defaults to 0
280                             #### Use the \'Data Transfer Element\' you want
281 autoclean=0                 #### Set to \'1\' or greater to enable
282 autocleancount=99           #### Number of access before a clean\&.
283 havereader=0                #### If you have a barcode reader, set to 1\&.
284 offline_before_unload=0     #### Does your robot require an
285                             #### \'mt offline\' before mtx unload?
286 poll_drive_ready=NN         #### Time (seconds) between tests to see if
287                             #### the tape drive has gone ready (default: 3)\&.
288 max_drive_wait=NN           #### Maximum time (seconds) to wait for the
289                             #### tape drive to become ready (default: 120)\&.
290 initial_poll_delay=NN       #### initial delay after load before polling for
291                             #### readiness
292 slotinfofile=FILENAME       #### record slot information to this file, in
293                             #### the line\-based format "SLOT LABEL\en"
294 .fi
295 .PP
296 This changer is fast\-search capable if and only if
297 \fBhavereader\fR
298 is true\&.
299 .SS "chg\-rait:{CHILD1,CHILD2,\&.\&.}"
300 .nf
301 define changer vtape {
302     tpcanger "chg\-disk:/path/to/vtape"
303 }
304 define changer robot {
305     tpchanger "chg\-robot:/dev/sg0"
306     tapedev "tape:/dev/nst0"
307 }
308 tpchanger "chg\-rait:{vtape,robot}"
309 .fi
310 .PP
311 This changer script constructs RAIT devices out of the devices provided by several "sub\-changers"\&. The sub\-changers are specified using the same shell\-like syntax as the RAIT device (see
312 \fBamanda-devices\fR(7))\&.
313 .PP
314 Chg\-rait does not require that all of the child changers have the same slot names: compound slot names are created by combining the slot names supplied by the child changers using the same shell\-like syntax\&. For example, if the child changers return slots "top", "strange", and "3", then the RAIT changer will return "{top,strange,3}"\&. This makes it possible to, for example, mirror data on tapes in slots 1\-10 to tapes in slots 11\-20 of the same robot, using two
315 \fBchg\-zd\-mtx\fR
316 child changers (and, naturally, two tape drives)\&. In this arrangement, the first slot would be named
317 {1,11}\&.
318 .PP
319 As a convenience to the user, the RAIT changer will also accept un\-braced slot names, and supply the same name to each child changer\&. Thus with a 4\-device RAIT changer, "17" is equivalent to "{17,17,17,17}"\&.
320 .PP
321 Drive names are parsed in a similar fashion, for operations that take drive names (clean and eject)\&.
322 .PP
323 This changer is fast\-search capable only if all of its child changers are fast\-search capable\&.
324 .if n \{\
325 .sp
326 .\}
327 .RS 4
328 .it 1 an-trap
329 .nr an-no-space-flag 1
330 .nr an-break-flag 1
331 .br
332 .ps +1
333 \fBNote\fR
334 .ps -1
335 .br
336 The old chg\-rait script is no longer supported nor shipped with Amanda, although the old script will continue to function via \fBchg\-compat\fR, giving users time to upgrade their configuration\&.
337 .sp .5v
338 .RE
339 .SS "chg\-null:"
340 .nf
341 tpchanger "chg\-null:"
342 .fi
343 .PP
344 This changer always provides the device "null:"\&. It is sometimes useful in conjunction with
345 \fBchg\-rait:\fR\&.
346 .SS "chg\-robot:DEVICE"
347 .nf
348 define changer robot {
349     tpchanger "chg\-robot:/dev/sg0"
350     property "tape\-device" "0=tape:/dev/rmt/0" "1=tape:/dev/rmt/1"
351     property "eject\-before\-unload" "yes"
352     property "use\-slots" "1\-5,11\-20"
353 }
354 tpchanger "robot"
355 .fi
356 .PP
357 This changer drives a robotic tape library using the operating system\'s
358 \fBmtx\fR
359 command\&. It replaces the ancient
360 \fBchg\-zd\-mtx\fR
361 script\&. The changer uses all of the information available to operate as efficiently as possible\&. Even without a barcode reader, the changer can usually load a tape immediately, without resorting to a sequential scan of many tapes\&. It is capable of sharing state across multiple Amanda configurations, avoiding conflicts and optimally tracking the contents of the library\&.
362 .PP
363 This changer does not accept a
364 \fBchangerdev\fR
365 parameter, but the
366 \fBchangerfile\fR
367 parameter can be used to specify a filename at which it should store its state\&. Ordinarily, this state is stored in a file named after the changer device under
368 \fI$localstatedir/amanda\fR, e\&.g\&.,
369 \fB/var/amanda/chg\-robot\-dev\-sg0\fR\&. There should be a single such statefile for each distinct tape library attached to the Amanda server, even if multiple Amanda configurations reference that library\&.
370 .PP
371 With a barcode reader present, it is possible for
372 \fBchg\-robot\fR
373 to track the state of the library reliably, even recognizing tapes that are removed and later re\-inserted (by remembering their barcodes)\&. Without barcodes, the changer can still remember the slot in which it last saw the tape with a particular label, although this information can become stale if the tapes are rearranged by an operator\&. In any case, the changer will never "hunt" for a tape by repeatedly loading slots and checking labels\&. If the changer\'s state is inaccurate, use the
374 \fBamtape\fR(8)
375 subcommand
376 \fBupdate\fR\&.
377 .PP
378 This changer is fast\-search capable even without a barcode reader\&. For such libraries, it is the responsibility of the operator to
379 \fBupdate\fR
380 the changer when tapes are added to or removed from the library\&.
381 .PP
382 There is a shell script in the
383 contrib/
384 directory of Amanda\'s source distribution which can help you convert a
385 \fBchg\-zd\-mtx\fR
386 configuration into a
387 \fBchg\-robot\fR
388 configuration\&. Just give it your Amanda configuration name:
389 .sp
390 .nf
391   sh contrib/convert\-zd\-mtx\-to\-robot\&.sh $config
392 .fi
393 The script can be downloaded at
394 http://github\&.com/zmanda/amanda/raw/master/contrib/convert\-zd\-mtx\-to\-robot\&.sh
395 .SS "Special Operations"
396 .PP
397 A number of special operations are available for
398 \fBchg\-robot\fR
399 via
400 \fBamtape\fR(8)
401 subcommands\&.
402 .PP
403 The
404 \fBreset\fR
405 subcommand will change the current slot to the first available slot, but does not erase any stored state maintained by the changer\&.
406 .PP
407 The
408 \fBeject\fR
409 subcommand will unload the volume in the given drive, ejecting first if the changer properties dictate\&. Note that, despite the subcommand name, the changer attempts to avoid the state where a volume has been ejected from the drive but not unloaded back to a storage slot\&.
410 .PP
411 The
412 \fBclean\fR
413 subcommand is not yet implemented\&.
414 .PP
415 The
416 \fBupdate\fR
417 subcommand instructs the changer to update its state database\&. Given no arguments, the changer will scan all available slots, loading each tape and reading its label\&. Especially for large libraries, this can take a long time\&. If only a few slots have changed, they can be listed on the command line:
418 .sp
419 .nf
420 amtape CONFIG update 1\-3,9
421 .fi
422 In this case, the changer will only scan the stated slots\&. Finally, the changer will not scan at all if it is given the tape label for the slot:
423 .sp
424 .nf
425 amtape CONFIG update 2=DailySet\-028
426 .fi
427 In this case, the changer updates its state to indicate that
428 DailySet\-028
429 is in slot 2, without trying to load the tape\&.
430 .sp
431 .nf
432 amtape CONFIG update 1\-3,9=
433 .fi
434 In this case, the changer marks the stated slots as an unknown state\&.
435 .SS "Properties"
436 .PP
437 DRIVE\-CHOICE
438 .RS 4
439
440 This property controls the algorithm used to select a drive in which to load a
441 tape\&.  If set to the default ("lru"), the changer attempts to use the least
442 recently used drive, resulting in a round\-robin behavior\&.  The "firstavail"
443 algorithm selects the first available drive, thus preferring the first drive
444 specified via the TAPE\-DEVICE property\&.
445 .RE
446 .PP
447 EJECT\-BEFORE\-UNLOAD
448 .RS 4
449
450 Set this boolean property to true if the library requires an
451 \fBoffline\fR operation be performed on the tape drive before it
452 can be unloaded\&.  If set, then \fBmt\fR will be invoked to
453 perform this operation\&.  Most libraries do not require this workaround\&.
454 .RE
455 .PP
456 EJECT\-DELAY
457 .RS 4
458
459 This is the time between ejecting a tape and unloading the volume to a storage slot, and
460 defaults to 0 seconds\&.  It is only used if EJECT\-BEFORE\-UNLOAD is true\&.  See "Timing", below\&.
461 .RE
462 .PP
463 FAST\-SEARCH
464 .RS 4
465
466 This boolean property indicates whether the changer advertises the ability to find
467 volumes without sequential scanning\&.  The traditional taperscan algorithm alters its
468 behavior based on this flag, so it is sometimes necessary to adjust it, although the
469 changer will always search for a desired tape using the most efficient means
470 available\&.  The default value is true\&.
471 .RE
472 .PP
473 IGNORE\-BARCODES
474 .RS 4
475
476 If this boolean property is true, then chg\-robot will ignore any barcode information
477 that the library provides\&.  This property is probably only useful when the library
478 returns incorrect barcodes, for example due to a malfunction in the barcode reader\&.
479 .RE
480 .PP
481 LOAD\-POLL
482 .RS 4
483 This property specifies the timing of Amanda\'s polling for the tape drive to be ready after loading a new tape\&. See "Timing", below\&.
484 .sp
485 The script "polls" by trying to open the tape device repeatedly until no error is encountered\&. The property specifies the time to wait before the first poll (D), the frequency at which to poll and retry on errors (P); and the time after which it should give up (U)\&. The format is
486 .sp
487 .nf
488 "D [poll P [until U]]"
489 .fi
490 For a simple delay with no polling, use e\&.g\&.,
491 .sp
492 .nf
493 property "load\-poll" "13s"
494 .fi
495 To delay and then poll, use e\&.g\&.,
496 .sp
497 .nf
498 property "load\-poll" "13s poll 5s"
499 .fi
500 and to add a maximum total time, use e\&.g\&.,
501 .sp
502 .nf
503 property "load\-poll" "0s poll 5s until 2m"
504 .fi
505 The default value is
506 \fB"0s poll 3s until 2m"\fR\&.
507 .RE
508 .PP
509 MTX
510 .RS 4
511
512 The path to the \'mtx\' binary\&.  The default value is defined at compile time\&.
513 .RE
514 .PP
515 STATUS\-INTERVAL
516 .RS 4
517
518 This is the minimum time between invocations of \fBmtx status\fR
519 to determine the state of the changer library\&.  The default value, 2 seconds,
520 avoids back\-to\-back status invocations but ensures that the metadata is up to
521 date\&.  For operating systems or libraries where the \fBmtx
522 status\fR takes a considerable time to complete, this value should be
523 increased\&.  See "Timing", below\&.
524 .RE
525 .PP
526 TAPE\-DEVICE
527 .RS 4
528
529 This property describes the correspondance of drive numbers in the library to
530 Amanda devices, in the format \fIDRIVE=DEVICE\fR\&.  The property
531 can be specified multiple times to describe multiple devices\&.  The device will
532 usually be a tape device name starting with \fBtape:\fR, but may
533 also refer to a device alias (see \fBamanda-devices\fR(7))\&. As
534 a shortcut, if the \fBtapedev\fR parameter is specified in the
535 changer definition, then it is assumed to be the device name for drive 0\&.
536 .RE
537 .PP
538 UNLOAD\-DELAY
539 .RS 4
540
541 This specifies the minimum time between an unload operation any any subsequent
542 operation\&.  The default value is 0 seconds\&.  See "Timing", below\&.
543 .RE
544 .PP
545 USE\-SLOTS
546 .RS 4
547
548 This property, if specifies, enumerates the slots to which this changer should
549 limit itself\&.  The slots are specified as a comma\-separated list of ranges,
550 e\&.g\&., "1\-5,11\-15,19,22"\&.  The property can be specified more than once, and
551 the resulting sets will be combined\&.  The changer will refuse to load tapes
552 not found in these slots, except for import/export purposes\&.
553 .RE
554 .SS "Timing"
555 .PP
556 Tape libraries are fickle, and in many cases will report that an operation is complete when it is still in progress\&. Chg\-robot takes several timing\-related properties to accomodate such behavior\&.
557 .PP
558 A typical sequence of operations performed during a load are: get library status, eject a tape, unload the tape back to a storage slot, load a new tape, and read the label on that tape to ensure the drive is ready\&.
559 .PP
560 On most systems, the library status check is nearly instantaneous \-\- the changer library provides its cached state to the host without initiating any robot motion\&. In order to keep its metadata up\-to\-date, chg\-robot runs this command very frequently, but this frequency can be reduced (at the cost of potentially stale metadata) by setting the STATUS\-INTERVAL property to a larger value\&.
561 .PP
562 Some tape libraries do not integrate the eject operation (performed by the embedded tape drive) with the unload operation (performed by the library robot), and can actually cause physical damage by attempting to remove the tape before the ejection is complete\&. For such changers, set the EJECT\-DELAY property to allow enough time for the eject to complete\&.
563 .PP
564 Once a tape is unloaded, if the library needs time to "quiesce" before processing another command, add that time to the UNLOAD\-DELAY parameter\&. No other operations will be performed on the library until this delay has elapsed\&.
565 .PP
566 Once a tape has been loaded, chg\-robot waits until the drive is ready before allowing Amanda to use the volume, as described for LOAD\-POLL, above\&.
567 .PP
568 Each of the times specified in these properties may be given as integers with the optional suffix
569 \fBs\fR
570 for seconds (the default) or
571 \fBm\fR
572 for minutes\&.
573 .SS "chg\-ndmp:HOST[:PORT]@SCSIDEV"
574 .nf
575     tpchanger "chg\-ndmp:filer\&.company\&.com@/dev/sg0"
576     property        "tape\-device" "0=ndmp:filer\&.company\&.com@/dev/rtape0"
577     property append "tape\-device" "1=ndmp:filer\&.company\&.com@/dev/rtape1"
578     property "use\-slots" "1\-12"
579     property "ndmp\-auth" "text"
580     property "ndmp\-username" "luke"
581     property "ndmp\-password" "leia"
582 .fi
583 .PP
584 This changer is very similar to
585 \fBchg\-robot\fR, but controls a tape changer on an NDMP server instead of a local device\&. The
586 \fBHOST\fR
587 in the
588 \fBtpchanger\fR
589 should be the hostname of the NDMP server\&. The
590 \fBPORT\fR
591 is optional\&. The
592 \fBSCSIDEV\fR
593 should specify the SCSI device on the NDMP server which controls the changer\&. The format of this parameter is implementation\-specific\&.
594 .PP
595 The appropriate authentication properties will be automatically set on any devices created by this changer\&.
596 .SS "Properties"
597 .PP
598 This changer supports all of the properties supported by
599 \fBchg\-robot\fR, although the value of
600 \fBMTX\fR
601 is ignored\&. The following properties are also recognized:
602 .PP
603 NDMP_AUTH
604 .RS 4
605
606 Authentication method to use to connect to the NDMP server\&.  One of
607 "md5" (default), "text", "none" (for an empty authentication attempt) or "void" (for
608 no authentication attempt at all)\&.
609 .RE
610 .PP
611 NDMP\-PASSWORD
612 .RS 4
613
614 The password for the NDMP server\&.
615 .RE
616 .PP
617 NDMP\-USERNAME
618 .RS 4
619
620 The username for the NDMP server\&.
621 .RE
622 .SS "Unmaintained Changers"
623 .PP
624 Amanda has many other changer scripts and programs beyond those described here (see the
625 changer\-src/
626 in the source directory), but most of these scripts are unmaintained and undocumented, and will be removed when the new changer API is fully implemented\&.
627 .SH "SEE ALSO"
628 .PP
629 \fBamanda\fR(8),
630 \fBamanda.conf\fR(5),
631 \fBamanda-devices\fR(7)
632 .PP
633 The Amanda Wiki:
634 : http://wiki.zmanda.com/
635 .SH "AUTHOR"
636 .PP
637 \fBDustin J\&. Mitchell\fR <\&dustin@zmanda\&.com\&>
638 .RS 4
639 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
640 .RE