3 # Bacula(R) - The Network Backup Solution
5 # Copyright (C) 2000-2015 Kern Sibbald
6 # Copyright (C) 2000-2014 Free Software Foundation Europe e.V.
8 # The original author of Bacula is Kern Sibbald, with contributions
9 # from many others, a complete list can be found in the file AUTHORS.
11 # You may use this file and others of this release according to the
12 # license defined in the LICENSE file, which includes the Affero General
13 # Public License, v3.0 ("AGPLv3") and some additional permissions and
14 # terms pursuant to its AGPLv3 Section 7.
16 # This notice must be preserved when any source code is
17 # conveyed and/or propagated.
19 # Bacula(R) is a registered trademark of Kern Sibbald.
21 # If you set in your Device resource
23 # Changer Command = "path-to-this-script/mtx-changer %c %o %S %a %d"
24 # you will have the following input to this script:
26 # So Bacula will always call with all the following arguments, even though
27 # in come cases, not all are used.
29 # mtx-changer "changer-device" "command" "slot" "archive-device" "drive-index"
34 # mtx-changer /dev/sg0 load 1 /dev/nst0 0 (on a Linux system)
36 # will request to load the first cartidge into drive 0, where
37 # the SCSI control channel is /dev/sg0, and the read/write device
42 # unload unload a given slot
43 # load load a given slot
44 # loaded which slot is loaded?
45 # list list Volume names (requires barcode reader)
46 # slots how many slots total?
47 # listall list all info
50 # Slots are numbered from 1 ...
51 # Drives are numbered from 0 ...
54 # If you need to an offline, refer to the drive as $4
55 # e.g. mt -f $4 offline
57 # Many changers need an offline after the unload. Also many
58 # changers need a sleep 60 after the mtx load.
60 # N.B. If you change the script, take care to return either
61 # the mtx exit code or a 0. If the script exits with a non-zero
62 # exit code, Bacula will assume the request failed.
65 # myversion must be the same as version in mtx-changer.conf
68 # source our conf file
69 if test ! -f @scriptdir@/mtx-changer.conf ; then
70 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
71 echo "ERROR: @scriptdir@/mtx-changer.conf file not found!!!!"
72 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
75 . @scriptdir@/mtx-changer.conf
77 if test "${version}" != "${myversion}" ; then
78 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
79 echo "ERROR: @scriptdir@/mtx-changer.conf has wrong version. Wanted ${myversion}, got ${version} !!!"
80 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
86 if test ${debug_log} -ne 0 ; then
87 touch @working_dir@/mtx.log
89 dbgfile="@working_dir@/mtx.log"
91 if test -f $dbgfile -a ${debug_level} -ge $1; then
92 echo "`date +%m%d-%H:%M:%S.%N|cut -c1-16` ${chgr_id} $2" >> $dbgfile
98 # Create a temporary file
101 TMPFILE=`mktemp @working_dir@/mtx.XXXXXXXXXX`
102 if test x${TMPFILE} = x; then
103 TMPFILE="@working_dir@/mtx.$$"
104 if test -f ${TMPFILE}; then
105 echo "ERROR: Temp file security problem on: ${TMPFILE}"
112 # Create a temporary file for stderr
114 # Note, this file is used because sometime mtx emits
115 # unexpected error messages followed by the output
116 # expected during success.
117 # So we separate STDOUT and STDERR in
118 # certain of the mtx commands. The contents of STDERR
119 # is then printed after the STDOUT produced by mtx
120 # thus we sometimes get better changer results.
123 ERRFILE=`mktemp @working_dir@/mtx.err.XXXXXXXXXX`
124 if test x${ERRFILE} = x; then
125 ERRFILE="@working_dir@/mtx.err.$$"
126 if test -f ${ERRFILE}; then
127 echo "ERROR: Temp file security problem on: ${ERRFILE}"
135 # The purpose of this function to wait a maximum
136 # time for the drive. It will
137 # return as soon as the drive is ready, or after
138 # waiting a maximum of 300 seconds.
139 # Note, this is very system dependent, so if you are
140 # not running on Linux, you will probably need to
141 # re-write it, or at least change the grep target.
142 # We've attempted to get the appropriate OS grep targets
143 # in the code at the top of this script.
147 while [ $i -le 300 ]; do # Wait max 300 seconds
148 if mt -f $1 status 2>&1 | grep "${ready}" >/dev/null 2>&1; then
151 debug $dbglvl "Device $1 - not ready, retrying..."
157 # check parameter count on commandline
162 if test $pCount -lt $pCountNeed; then
163 echo "ERROR: usage: mtx-changer ctl-device command [slot archive-device drive-index]"
164 echo " Insufficient number of arguments given."
165 if test $pCount -lt 2; then
166 echo " Mimimum usage is first two arguments ..."
168 echo " Command expected $pCountNeed arguments"
174 # Check for special cases where only 2 arguments are needed,
175 # all others are a minimum of 5
179 check_parm_count $# 2
182 check_parm_count $# 2
185 check_parm_count $# 4
188 check_parm_count $# 5
200 debug $dbglvl "Parms: $ctl $cmd $slot $device $drive"
205 if test ${offline} -eq 1 ; then
206 mt -f $device offline
208 if test ${offline_sleep} -ne 0 ; then
209 sleep ${offline_sleep}
212 for i in 1 2 3 4 5 ; do
213 debug $idbglvl "Doing mtx -f $ctl unload slot=$slot drv=$drive"
214 ${MTX} -f $ctl unload $slot $drive 2>${ERRFILE}
216 if test $rtn -eq 0 ; then
219 grep "Error Code=" ${ERRFILE} 2>/dev/null 1>/dev/null
220 if test $? -ne 0 ; then
226 rm -f ${ERRFILE} >/dev/null 2>&1
227 if test $rtn -ne 0 ; then
228 debug $idbglvl "FAIL: mtx -f $ctl unload slot=$slot drv=$drive"
235 for i in 1 2 3 4 5 ; do
236 debug $idbglvl "Doing mtx -f $ctl load slot=$slot drv=$drive"
237 ${MTX} -f $ctl load $slot $drive 2>${ERRFILE}
239 if test $rtn -eq 0 ; then
242 grep "Error Code=" ${ERRFILE} 2>/dev/null 1>/dev/null
243 if test $? -ne 0 ; then
248 if test ${load_sleep} -ne 0 ; then
251 wait_for_drive $device
253 rm -f ${ERRFILE} >/dev/null 2>&1
254 if test $rtn -ne 0 ; then
255 debug $idbglvl "FAIL: mtx -f $ctl load slot=$slot drv=$drive"
262 if test ${inventory} -ne 0 ; then
263 ${MTX} -f $ctl inventory
265 debug $dbglvl "Doing mtx -f $ctl list"
266 ${MTX} -f $ctl status >${TMPFILE}
268 if test ${vxa_packetloader} -ne 0 ; then
269 cat ${TMPFILE} | grep " *Storage Element [0-9]*:.*Full" | sed "s/ Storage Element //" | sed "s/Full :VolumeTag=//"
271 cat ${TMPFILE} | grep " Storage Element [0-9]*:.*Full" | awk "{print \$3 \$4}" | sed "s/Full *\(:VolumeTag=\)*//"
273 cat ${TMPFILE} | grep "^Data Transfer Element [0-9]*:Full (Storage Element [0-9]" | awk '{printf "%s:%s\n",$7,$10}'
274 rm -f ${TMPFILE} >/dev/null 2>&1
275 if test $rtn -ne 0 ; then
276 debug $idbglvl "FAIL: mtx -f $ctl list"
282 # Drive content: D:Drive num:F:Slot loaded:Volume Name
283 # D:0:F:2:vol2 or D:Drive num:E
288 # S:1:F:vol1 S:Slot num:F:Volume Name
289 # S:2:E or S:Slot num:E
292 # Import/Export tray slots:
293 # I:10:F:vol10 I:Slot num:F:Volume Name
294 # I:11:E or I:Slot num:E
298 if test ${inventory} -ne 0 ; then
299 ${MTX} -f $ctl inventory
301 debug $dbglvl "Doing mtx -f $ctl -- to list all"
302 ${MTX} -f $ctl status >${TMPFILE}
304 # can be converted to awk+sed+cut, see below
306 /Data Transfer Element (\d+):Empty/ && print "D:$1:E\n";
307 /Data Transfer Element (\d+):Full \(Storage Element (\d+) Loaded\)(:VolumeTag =\s*(.+))?/ && print "D:$1:F:$2:$4\n";
308 /Storage Element (\d+):Empty/ && print "S:$1:E\n";
309 /Storage Element (\d+):Full( :VolumeTag=(.+))?/ && print "S:$1:F:$3\n";
310 /Storage Element (\d+) IMPORT.EXPORT:Empty/ && print "I:$1:E\n";
311 /Storage Element (\d+) IMPORT.EXPORT:Full( :VolumeTag=(.+))?/ && print "I:$1:F:$3\n";' ${TMPFILE}
312 # If perl isn't installed, you can use by those commands
313 #cat ${TMPFILE} | grep "Data Transfer Element" | awk "{print \"D:\"\$4 \$7 \$9 \$10}" | sed "s/=/:/" | sed "s/Full/F:/" | sed "s/Empty/E/"
314 #cat ${TMPFILE} | grep -v "Data Transfer Element" | grep "Storage Element" | grep -v "IMPORT/EXPORT" | awk "{print \"S:\"\$3 \$4 \$5}" | sed "s/IMPORT\/EXPORT//" | sed "s/Full *:VolumeTag=/F:/" | sed "s/Empty/E/"
315 #cat ${TMPFILE} | grep -v "Data Transfer Element" | grep "Storage Element" | grep "IMPORT/EXPORT" | awk "{print \"I:\"\$3 \$4 \$5}" | sed "s/IMPORT\/EXPORT//" | sed "s/Full *:VolumeTag=/F:/" | sed "s/Empty/E/"
317 rm -f ${TMPFILE} >/dev/null 2>&1
323 debug $dbglvl "Doing transfer from $slot to $slotdest"
324 ${MTX} -f $ctl transfer $slot $slotdest
326 if test $rtn -ne 0 ; then
327 debug $idbglvl "FAIL: mtx -f $ctl transfer from=$slot to=$slotdest"
334 debug $idbglvl "Doing mtx -f $ctl $drive -- to find what is loaded"
335 ${MTX} -f $ctl status >${TMPFILE}
337 cat ${TMPFILE} | grep "^Data Transfer Element $drive:Full" | awk "{print \$7}"
338 cat ${TMPFILE} | grep "^Data Transfer Element $drive:Empty" | awk "{print 0}"
339 rm -f ${TMPFILE} >/dev/null 2>&1
340 if test $rtn -ne 0 ; then
341 debug $idbglvl "FAIL: mtx -f $ctl loaded drv=$drive"
347 debug $dbglvl "Doing mtx -f $ctl -- to get count of slots"
348 ${MTX} -f $ctl status | grep " *Storage Changer" | awk "{print \$5}"
350 if test $rtn -ne 0 ; then
351 debug $idbglvl "FAIL: mtx -f $ctl slots"