3 # Bacula(R) - The Network Backup Solution
5 # Copyright (C) 2000-2016 Kern Sibbald
7 # The original author of Bacula is Kern Sibbald, with contributions
8 # from many others, a complete list can be found in the file AUTHORS.
10 # You may use this file and others of this release according to the
11 # license defined in the LICENSE file, which includes the Affero General
12 # Public License, v3.0 ("AGPLv3") and some additional permissions and
13 # terms pursuant to its AGPLv3 Section 7.
15 # This notice must be preserved when any source code is
16 # conveyed and/or propagated.
18 # Bacula(R) is a registered trademark of Kern Sibbald.
20 # If you set in your Device resource
22 # Changer Command = "path-to-this-script/mtx-changer %c %o %S %a %d"
23 # you will have the following input to this script:
25 # So Bacula will always call with all the following arguments, even though
26 # in come cases, not all are used.
28 # mtx-changer "changer-device" "command" "slot" "archive-device" "drive-index"
33 # mtx-changer /dev/sg0 load 1 /dev/nst0 0 (on a Linux system)
35 # will request to load the first cartidge into drive 0, where
36 # the SCSI control channel is /dev/sg0, and the read/write device
41 # unload unload a given slot
42 # load load a given slot
43 # loaded which slot is loaded?
44 # list list Volume names (requires barcode reader)
45 # slots how many slots total?
46 # listall list all info
49 # Slots are numbered from 1 ...
50 # Drives are numbered from 0 ...
53 # If you need to an offline, refer to the drive as $4
54 # e.g. mt -f $4 offline
56 # Many changers need an offline after the unload. Also many
57 # changers need a sleep 60 after the mtx load.
59 # N.B. If you change the script, take care to return either
60 # the mtx exit code or a 0. If the script exits with a non-zero
61 # exit code, Bacula will assume the request failed.
64 # myversion must be the same as version in mtx-changer.conf
67 # source our conf file
68 if test ! -f @scriptdir@/mtx-changer.conf ; then
69 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
70 echo "ERROR: @scriptdir@/mtx-changer.conf file not found!!!!"
71 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
74 . @scriptdir@/mtx-changer.conf
76 if test "${version}" != "${myversion}" ; then
77 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
78 echo "ERROR: @scriptdir@/mtx-changer.conf has wrong version. Wanted ${myversion}, got ${version} !!!"
79 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
85 if test ${debug_log} -ne 0 ; then
86 touch @working_dir@/mtx.log
88 dbgfile="@working_dir@/mtx.log"
90 if test -f $dbgfile -a ${debug_level} -ge $1; then
91 echo "`date +%m%d-%H:%M:%S.%N|cut -c1-16` ${chgr_id} $2" >> $dbgfile
97 # Create a temporary file
100 TMPFILE=`mktemp @working_dir@/mtx.XXXXXXXXXX`
101 if test x${TMPFILE} = x; then
102 TMPFILE="@working_dir@/mtx.$$"
103 if test -f ${TMPFILE}; then
104 echo "ERROR: Temp file security problem on: ${TMPFILE}"
111 # Create a temporary file for stderr
113 # Note, this file is used because sometime mtx emits
114 # unexpected error messages followed by the output
115 # expected during success.
116 # So we separate STDOUT and STDERR in
117 # certain of the mtx commands. The contents of STDERR
118 # is then printed after the STDOUT produced by mtx
119 # thus we sometimes get better changer results.
122 ERRFILE=`mktemp @working_dir@/mtx.err.XXXXXXXXXX`
123 if test x${ERRFILE} = x; then
124 ERRFILE="@working_dir@/mtx.err.$$"
125 if test -f ${ERRFILE}; then
126 echo "ERROR: Temp file security problem on: ${ERRFILE}"
134 # The purpose of this function to wait a maximum
135 # time for the drive. It will
136 # return as soon as the drive is ready, or after
137 # waiting a maximum of 300 seconds.
138 # Note, this is very system dependent, so if you are
139 # not running on Linux, you will probably need to
140 # re-write it, or at least change the grep target.
141 # We've attempted to get the appropriate OS grep targets
142 # in the code at the top of this script.
146 while [ $i -le 300 ]; do # Wait max 300 seconds
147 if mt -f $1 status 2>&1 | grep "${ready}" >/dev/null 2>&1; then
150 debug $dbglvl "Device $1 - not ready, retrying..."
156 # check parameter count on commandline
161 if test $pCount -lt $pCountNeed; then
162 echo "ERROR: usage: mtx-changer ctl-device command [slot archive-device drive-index]"
163 echo " Insufficient number of arguments given."
164 if test $pCount -lt 2; then
165 echo " Mimimum usage is first two arguments ..."
167 echo " Command expected $pCountNeed arguments"
173 # Check for special cases where only 2 arguments are needed,
174 # all others are a minimum of 5
178 check_parm_count $# 2
181 check_parm_count $# 2
184 check_parm_count $# 4
187 check_parm_count $# 5
199 debug $dbglvl "Parms: $ctl $cmd $slot $device $drive"
204 if test ${offline} -eq 1 ; then
205 mt -f $device offline
207 if test ${offline_sleep} -ne 0 ; then
208 sleep ${offline_sleep}
211 for i in 1 2 3 4 5 ; do
212 debug $idbglvl "Doing mtx -f $ctl unload slot=$slot drv=$drive"
213 ${MTX} -f $ctl unload $slot $drive 2>${ERRFILE}
215 if test $rtn -eq 0 ; then
218 grep "Error Code=" ${ERRFILE} 2>/dev/null 1>/dev/null
219 if test $? -ne 0 ; then
225 rm -f ${ERRFILE} >/dev/null 2>&1
226 if test $rtn -ne 0 ; then
227 debug $idbglvl "FAIL: mtx -f $ctl unload slot=$slot drv=$drive"
234 for i in 1 2 3 4 5 ; do
235 debug $idbglvl "Doing mtx -f $ctl load slot=$slot drv=$drive"
236 ${MTX} -f $ctl load $slot $drive 2>${ERRFILE}
238 if test $rtn -eq 0 ; then
241 grep "Error Code=" ${ERRFILE} 2>/dev/null 1>/dev/null
242 if test $? -ne 0 ; then
247 if test ${load_sleep} -ne 0 ; then
250 wait_for_drive $device
252 rm -f ${ERRFILE} >/dev/null 2>&1
253 if test $rtn -ne 0 ; then
254 debug $idbglvl "FAIL: mtx -f $ctl load slot=$slot drv=$drive"
261 if test ${inventory} -ne 0 ; then
262 ${MTX} -f $ctl inventory
264 debug $dbglvl "Doing mtx -f $ctl list"
265 ${MTX} -f $ctl status >${TMPFILE}
267 if test ${vxa_packetloader} -ne 0 ; then
268 cat ${TMPFILE} | grep " *Storage Element [0-9]*:.*Full" | sed "s/ Storage Element //" | sed "s/Full :VolumeTag=//"
270 cat ${TMPFILE} | grep " Storage Element [0-9]*:.*Full" | awk "{print \$3 \$4}" | sed "s/Full *\(:VolumeTag=\)*//"
272 cat ${TMPFILE} | grep "^Data Transfer Element [0-9]*:Full (Storage Element [0-9]" | awk '{printf "%s:%s\n",$7,$10}'
273 rm -f ${TMPFILE} >/dev/null 2>&1
274 if test $rtn -ne 0 ; then
275 debug $idbglvl "FAIL: mtx -f $ctl list"
281 # Drive content: D:Drive num:F:Slot loaded:Volume Name
282 # D:0:F:2:vol2 or D:Drive num:E
287 # S:1:F:vol1 S:Slot num:F:Volume Name
288 # S:2:E or S:Slot num:E
291 # Import/Export tray slots:
292 # I:10:F:vol10 I:Slot num:F:Volume Name
293 # I:11:E or I:Slot num:E
297 if test ${inventory} -ne 0 ; then
298 ${MTX} -f $ctl inventory
300 debug $dbglvl "Doing mtx -f $ctl -- to list all"
301 ${MTX} -f $ctl status >${TMPFILE}
303 # can be converted to awk+sed+cut, see below
305 /Data Transfer Element (\d+):Empty/ && print "D:$1:E\n";
306 /Data Transfer Element (\d+):Full \(Storage Element (\d+) Loaded\)(:VolumeTag =\s*(.+))?/ && print "D:$1:F:$2:$4\n";
307 /Storage Element (\d+):Empty/ && print "S:$1:E\n";
308 /Storage Element (\d+):Full( :VolumeTag=(.+))?/ && print "S:$1:F:$3\n";
309 /Storage Element (\d+) IMPORT.EXPORT:Empty/ && print "I:$1:E\n";
310 /Storage Element (\d+) IMPORT.EXPORT:Full( :VolumeTag=(.+))?/ && print "I:$1:F:$3\n";' ${TMPFILE}
311 # If perl isn't installed, you can use by those commands
312 #cat ${TMPFILE} | grep "Data Transfer Element" | awk "{print \"D:\"\$4 \$7 \$9 \$10}" | sed "s/=/:/" | sed "s/Full/F:/" | sed "s/Empty/E/"
313 #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/"
314 #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/"
316 rm -f ${TMPFILE} >/dev/null 2>&1
322 debug $dbglvl "Doing transfer from $slot to $slotdest"
323 ${MTX} -f $ctl transfer $slot $slotdest
325 if test $rtn -ne 0 ; then
326 debug $idbglvl "FAIL: mtx -f $ctl transfer from=$slot to=$slotdest"
333 debug $idbglvl "Doing mtx -f $ctl $drive -- to find what is loaded"
334 ${MTX} -f $ctl status >${TMPFILE}
336 cat ${TMPFILE} | grep "^Data Transfer Element $drive:Full" | awk "{print \$7}"
337 cat ${TMPFILE} | grep "^Data Transfer Element $drive:Empty" | awk "{print 0}"
338 rm -f ${TMPFILE} >/dev/null 2>&1
339 if test $rtn -ne 0 ; then
340 debug $idbglvl "FAIL: mtx -f $ctl loaded drv=$drive"
346 debug $dbglvl "Doing mtx -f $ctl -- to get count of slots"
347 ${MTX} -f $ctl status | grep " *Storage Changer" | awk "{print \$5}"
349 if test $rtn -ne 0 ; then
350 debug $idbglvl "FAIL: mtx -f $ctl slots"