git.sur5r.net Git - bacula/bacula/blob - bacula/scripts/mtx-changer.in

   1 #!/bin/sh
   2 #
   3 # Bacula interface to mtx autoloader
   4 #
   5 #  $Id$
   6 #
   7 #  If you set in your Device resource
   8 #
   9 #  Changer Command = "path-to-this-script/mtx-changer %c %o %S %a %d"
  10 #    you will have the following input to this script:
  11 #
  12 #  So Bacula will always call with all the following arguments, even though
  13 #    in come cases, not all are used.
  14 #
  15 #  mtx-changer "changer-device" "command" "slot" "archive-device" "drive-index"
  16 #                  $1              $2       $3        $4               $5
  17 #
  18 #  for example:
  19 #
  20 #  mtx-changer /dev/sg0 load 1 /dev/nst0 0 (on a Linux system)
  21 #
  22 #  will request to load the first cartidge into drive 0, where
  23 #   the SCSI control channel is /dev/sg0, and the read/write device
  24 #   is /dev/nst0.
  25 #
  26 #  The commands are:
  27 #      Command            Function
  28 #      unload             unload a given slot
  29 #      load               load a given slot
  30 #      loaded             which slot is loaded?
  31 #      list               list Volume names (requires barcode reader)
  32 #      slots              how many slots total?
  33 #
  34 #  Slots are numbered from 1 ...
  35 #  Drives are numbered from 0 ...
  36 #
  37 #
  38 #  If you need to an offline, refer to the drive as $4
  39 #    e.g.   mt -f $4 offline
  40 #
  41 #  Many changers need an offline after the unload. Also many
  42 #   changers need a sleep 60 after the mtx load.
  43 #
  44 #  N.B. If you change the script, take care to return either
  45 #   the mtx exit code or a 0. If the script exits with a non-zero
  46 #   exit code, Bacula will assume the request failed.
  47 #
  48
  49 MTX=@MTX@
  50
  51 # mt status output
  52 # SunOS     No Additional Sense
  53 # FreeBSD   Current Driver State: at rest.
  54 # Linux     ONLINE
  55 #  Note Debian has a different mt than the standard Linux version.
  56 #    When no tape is in the drive it waits 2 minutes.
  57 #    When a tape is in the drive, it prints user unfriendly output.
  58 #  Note, with Ubuntu Gusty (8.04), there are two versions of mt,
  59 #    so we attempt to figure out which one.
  60 #
  61
  62 OS=`uname`
  63 case ${OS} in
  64   SunOS)
  65     ready="No Additional Sense"
  66     ;;
  67   FreeBSD)
  68     ready="Current Driver State: at rest."
  69     ;;
  70   Linux)
  71     ready="ONLINE"
  72     if test -f /etc/debian_version ; then
  73        mt --version|grep "mt-st"
  74        if test $? -eq 1 ; then
  75           ready="drive status"
  76        fi
  77     fi
  78   ;;
  79 esac
  80
  81 #
  82 # log whats done
  83 #
  84 # to turn on logging, uncomment the following line
  85 #touch @working_dir@/mtx.log
  86 #
  87 dbgfile="@working_dir@/mtx.log"
  88 debug() {
  89     if test -f $dbgfile; then
  90         echo "`date +\"%Y%m%d-%H:%M:%S\"` $*" >> $dbgfile
  91     fi
  92 }
  93
  94
  95 #
  96 # Create a temporary file
  97 #
  98 make_temp_file() {
  99   TMPFILE=`mktemp @working_dir@/mtx.XXXXXXXXXX`
 100   if test x${TMPFILE} = x; then
 101      TMPFILE="@working_dir@/mtx.$$"
 102      if test -f ${TMPFILE}; then
 103         echo "Temp file security problem on: ${TMPFILE}"
 104         exit 1
 105      fi
 106   fi
 107 }
 108
 109 #
 110 # The purpose of this function to wait a maximum
 111 #   time for the drive. It will
 112 #   return as soon as the drive is ready, or after
 113 #   waiting a maximum of 300 seconds.
 114 # Note, this is very system dependent, so if you are
 115 #   not running on Linux, you will probably need to
 116 #   re-write it, or at least change the grep target.
 117 #   We've attempted to get the appropriate OS grep targets
 118 #   in the code at the top of this script.
 119 #
 120 wait_for_drive() {
 121   i=0
 122   while [ $i -le 300 ]; do  # Wait max 300 seconds
 123     if mt -f $1 status 2>&1 | grep "${ready}" >/dev/null 2>&1; then
 124       break
 125     fi
 126     debug "Device $1 - not ready, retrying..."
 127     sleep 1
 128     i=`expr $i + 1`
 129   done
 130 }
 131
 132 # check parameter count on commandline
 133 #
 134 check_parm_count() {
 135     pCount=$1
 136     pCountNeed=$2
 137     if test $pCount -lt $pCountNeed; then
 138         echo "usage: mtx-changer ctl-device command [slot archive-device drive-index]"
 139         echo "  Insufficient number of arguments given."
 140         if test $pCount -lt 2; then
 141             echo "  Mimimum usage is first two arguments ..."
 142         else
 143             echo "  Command expected $pCountNeed arguments"
 144         fi
 145         exit 1
 146     fi
 147 }
 148
 149 # Check for special cases where only 2 arguments are needed,
 150 #  all others are a minimum of 5
 151 #
 152 case $2 in
 153     list)
 154         check_parm_count $# 2
 155         ;;
 156     slots)
 157         check_parm_count $# 2
 158         ;;
 159     *)
 160         check_parm_count $# 5
 161         ;;
 162 esac
 163
 164
 165 # Setup arguments
 166 ctl=$1
 167 cmd="$2"
 168 slot=$3
 169 device=$4
 170 drive=$5
 171
 172 debug "Parms: $ctl $cmd $slot $device $drive"
 173
 174 case $cmd in
 175    unload)
 176       debug "Doing mtx -f $ctl unload $slot $drive"
 177 #
 178 # enable the following line if you need to eject the cartridge
 179 #     mt -f $device offline
 180 #     sleep 10
 181       ${MTX} -f $ctl unload $slot $drive
 182       ;;
 183
 184    load)
 185       debug "Doing mtx -f $ctl load $slot $drive"
 186       ${MTX} -f $ctl load $slot $drive
 187       rtn=$?
 188 #
 189 # Increase the sleep time if you have a slow device
 190 # or remove the sleep and add the following:
 191 #     sleep 15
 192       wait_for_drive $device
 193       exit $rtn
 194       ;;
 195
 196    list)
 197       debug "Doing mtx -f $ctl -- to list volumes"
 198       make_temp_file
 199 # Enable the following if you are using barcodes and need an inventory
 200 #     ${MTX} -f $ctl inventory
 201       ${MTX} -f $ctl status >${TMPFILE}
 202       rtn=$?
 203       cat ${TMPFILE} | grep " Storage Element [0-9]*:.*Full" | awk "{print \$3 \$4}" | sed "s/Full *\(:VolumeTag=\)*//"
 204 #
 205 # If you have a VXA PacketLoader and the above does not work, try
 206 #  turning it off and enabling the following line.
 207 #     cat ${TMPFILE} | grep " *Storage Element [0-9]*:.*Full" | sed "s/ Storage Element //" | sed "s/Full :VolumeTag=//"
 208 #
 209       cat ${TMPFILE} | grep "^Data Transfer Element [0-9]*:Full (Storage Element [0-9]" | awk '{printf "%s:%s\n",$7,$10}'
 210       rm -f ${TMPFILE} >/dev/null 2>&1
 211       exit $rtn
 212       ;;
 213
 214    loaded)
 215       debug "Doing mtx -f $ctl $drive -- to find what is loaded"
 216       make_temp_file
 217       ${MTX} -f $ctl status >${TMPFILE}
 218       rtn=$?
 219       cat ${TMPFILE} | grep "^Data Transfer Element $drive:Full" | awk "{print \$7}"
 220       cat ${TMPFILE} | grep "^Data Transfer Element $drive:Empty" | awk "{print 0}"
 221       rm -f ${TMPFILE} >/dev/null 2>&1
 222       exit $rtn
 223       ;;
 224
 225    slots)
 226       debug "Doing mtx -f $ctl -- to get count of slots"
 227       ${MTX} -f $ctl status | grep " *Storage Changer" | awk "{print \$5}"
 228       ;;
 229 esac