]> git.sur5r.net Git - bacula/bacula/blobdiff - bacula/scripts/mtx-changer.in
Backport from BEE
[bacula/bacula] / bacula / scripts / mtx-changer.in
index fe23051edf93bb8b2584f5fe4194a3af72d00cde..ad9c0cacf2f9ce9b9124c9cdcc4cca78f57732d2 100644 (file)
@@ -2,6 +2,23 @@
 #
 # Bacula interface to mtx autoloader
 #
+#  Written by Kern Sibbald
+#
+#  Bacula® - The Network Backup Solution
+#
+#  Copyright (C) 2000-2014 Free Software Foundation Europe e.V.
+#
+#  The main author of Bacula is Kern Sibbald, with contributions from many
+#  others, a complete list can be found in the file AUTHORS.
+#
+#  You may use this file and others of this release according to the
+#  license defined in the LICENSE file, which includes the Affero General
+#  Public License, v3.0 ("AGPLv3") and some additional permissions and
+#  terms pursuant to its AGPLv3 Section 7.
+#
+#  Bacula® is a registered trademark of Kern Sibbald.
+#
+#
 #  If you set in your Device resource
 #
 #  Changer Command = "path-to-this-script/mtx-changer %c %o %S %a %d"
 #    in come cases, not all are used.
 #
 #  mtx-changer "changer-device" "command" "slot" "archive-device" "drive-index"
-#                 $1              $2       $3        $4               $5
+#                  $1              $2       $3        $4               $5
 #
 #  for example:
 #
 #  mtx-changer /dev/sg0 load 1 /dev/nst0 0 (on a Linux system)
-# 
+#
 #  will request to load the first cartidge into drive 0, where
 #   the SCSI control channel is /dev/sg0, and the read/write device
 #   is /dev/nst0.
 #
 #  The commands are:
-#      Command           Function
-#      unload            unload a given slot
-#      load              load a given slot
-#      loaded            which slot is loaded?
-#      list              list Volume names (requires barcode reader)
-#      slots             how many slots total?
-#      listall           list all info
+#      Command            Function
+#      unload             unload a given slot
+#      load               load a given slot
+#      loaded             which slot is loaded?
+#      list               list Volume names (requires barcode reader)
+#      slots              how many slots total?
+#      listall            list all info
 #      transfer
 #
 #  Slots are numbered from 1 ...
@@ -41,7 +58,7 @@
 #  Many changers need an offline after the unload. Also many
 #   changers need a sleep 60 after the mtx load.
 #
-#  N.B. If you change the script, take care to return either 
+#  N.B. If you change the script, take care to return either
 #   the mtx exit code or a 0. If the script exits with a non-zero
 #   exit code, Bacula will assume the request failed.
 #
@@ -63,7 +80,7 @@ fi
 dbgfile="@working_dir@/mtx.log"
 debug() {
     if test -f $dbgfile; then
-       echo "`date +\"%Y%m%d-%H:%M:%S\"` $*" >> $dbgfile
+        echo "`date +\"%Y%m%d-%H:%M:%S\"` $*" >> $dbgfile
     fi
 }
 
@@ -76,8 +93,8 @@ make_temp_file() {
   if test x${TMPFILE} = x; then
      TMPFILE="@working_dir@/mtx.$$"
      if test -f ${TMPFILE}; then
-       echo "ERROR: Temp file security problem on: ${TMPFILE}"
-       exit 1
+        echo "ERROR: Temp file security problem on: ${TMPFILE}"
+        exit 1
      fi
   fi
 }
@@ -91,22 +108,22 @@ make_temp_file() {
 #  So we separate STDOUT and STDERR in
 #  certain of the mtx commands. The contents of STDERR
 #  is then printed after the STDOUT produced by mtx
-#  thus we sometimes get better changer results. 
+#  thus we sometimes get better changer results.
 #
 make_err_file() {
   ERRFILE=`mktemp @working_dir@/mtx.err.XXXXXXXXXX`
   if test x${ERRFILE} = x; then
      ERRFILE="@working_dir@/mtx.err.$$"
      if test -f ${ERRFILE}; then
-       echo "ERROR: Temp file security problem on: ${ERRFILE}"
-       exit 1
+        echo "ERROR: Temp file security problem on: ${ERRFILE}"
+        exit 1
      fi
   fi
 }
 
 
 #
-# The purpose of this function to wait a maximum 
+# The purpose of this function to wait a maximum
 #   time for the drive. It will
 #   return as soon as the drive is ready, or after
 #   waiting a maximum of 300 seconds.
@@ -117,7 +134,7 @@ make_err_file() {
 #   in the code at the top of this script.
 #
 wait_for_drive() {
-  i=0 
+  i=0
   while [ $i -le 300 ]; do  # Wait max 300 seconds
     if mt -f $1 status 2>&1 | grep "${ready}" >/dev/null 2>&1; then
       break
@@ -134,33 +151,33 @@ check_parm_count() {
     pCount=$1
     pCountNeed=$2
     if test $pCount -lt $pCountNeed; then
-       echo "ERROR: usage: mtx-changer ctl-device command [slot archive-device drive-index]"
-       echo "  Insufficient number of arguments given."
-       if test $pCount -lt 2; then
-           echo "  Mimimum usage is first two arguments ..."
-       else
-           echo "  Command expected $pCountNeed arguments"
-       fi
-       exit 1
+        echo "ERROR: usage: mtx-changer ctl-device command [slot archive-device drive-index]"
+        echo "  Insufficient number of arguments given."
+        if test $pCount -lt 2; then
+            echo "  Mimimum usage is first two arguments ..."
+        else
+            echo "  Command expected $pCountNeed arguments"
+        fi
+        exit 1
     fi
 }
 
-# Check for special cases where only 2 arguments are needed, 
+# Check for special cases where only 2 arguments are needed,
 #  all others are a minimum of 5
 #
 case $2 in
     list|listall)
-       check_parm_count $# 2
-       ;;
+        check_parm_count $# 2
+        ;;
     slots)
-       check_parm_count $# 2
-       ;;
+        check_parm_count $# 2
+        ;;
     transfer)
-       check_parm_count $# 4
-       ;;
+        check_parm_count $# 4
+        ;;
     *)
-       check_parm_count $# 5
-       ;;
+        check_parm_count $# 5
+        ;;
 esac
 
 
@@ -173,15 +190,15 @@ drive=$5
 
 debug "Parms: $ctl $cmd $slot $device $drive"
 
-case $cmd in 
+case $cmd in
    unload)
       debug "Doing mtx -f $ctl unload $slot $drive"
 
       if test ${offline} -eq 1 ; then
-       mt -f $device offline
+        mt -f $device offline
       fi
       if test ${offline_sleep} -ne 0 ; then
-       sleep ${offline_sleep}
+        sleep ${offline_sleep}
       fi
       make_err_file
       ${MTX} -f $ctl unload $slot $drive 2>${ERRFILE}
@@ -197,7 +214,7 @@ case $cmd in
       ${MTX} -f $ctl load $slot $drive 2>${ERRFILE}
       rtn=$?
       if test ${load_sleep} -ne 0 ; then
-       sleep ${load_sleep}
+        sleep ${load_sleep}
       fi
       wait_for_drive $device
       cat ${ERRFILE}
@@ -205,18 +222,18 @@ case $cmd in
       exit $rtn
       ;;
 
-   list) 
+   list)
       debug "Doing mtx -f $ctl -- to list volumes"
       make_temp_file
       if test ${inventory} -ne 0 ; then
-       ${MTX} -f $ctl inventory
+        ${MTX} -f $ctl inventory
       fi
       ${MTX} -f $ctl status >${TMPFILE}
       rtn=$?
       if test ${vxa_packetloader} -ne 0 ; then
-       cat ${TMPFILE} | grep " *Storage Element [0-9]*:.*Full" | sed "s/ Storage Element //" | sed "s/Full :VolumeTag=//"
+        cat ${TMPFILE} | grep " *Storage Element [0-9]*:.*Full" | sed "s/ Storage Element //" | sed "s/Full :VolumeTag=//"
       else
-       cat ${TMPFILE} | grep " Storage Element [0-9]*:.*Full" | awk "{print \$3 \$4}" | sed "s/Full *\(:VolumeTag=\)*//"
+        cat ${TMPFILE} | grep " Storage Element [0-9]*:.*Full" | awk "{print \$3 \$4}" | sed "s/Full *\(:VolumeTag=\)*//"
       fi
       cat ${TMPFILE} | grep "^Data Transfer Element [0-9]*:Full (Storage Element [0-9]" | awk '{printf "%s:%s\n",$7,$10}'
       rm -f ${TMPFILE} >/dev/null 2>&1
@@ -224,25 +241,25 @@ case $cmd in
       ;;
 
    listall)
-#  Drive content:        D:Drive num:F:Slot loaded:Volume Name
+#  Drive content:         D:Drive num:F:Slot loaded:Volume Name
 #  D:0:F:2:vol2        or D:Drive num:E
-#  D:1:F:42:vol42   
+#  D:1:F:42:vol42
 #  D:3:E
-# 
+#
 #  Slot content:
-#  S:1:F:vol1            S:Slot num:F:Volume Name
-#  S:2:E              or S:Slot num:E
+#  S:1:F:vol1             S:Slot num:F:Volume Name
+#  S:2:E               or S:Slot num:E
 #  S:3:F:vol4
-# 
+#
 #  Import/Export tray slots:
-#  I:10:F:vol10          I:Slot num:F:Volume Name
-#  I:11:E             or I:Slot num:E
+#  I:10:F:vol10           I:Slot num:F:Volume Name
+#  I:11:E              or I:Slot num:E
 #  I:12:F:vol40
+
       debug "Doing mtx -f $ctl -- to list all"
       make_temp_file
       if test ${inventory} -ne 0 ; then
-       ${MTX} -f $ctl inventory
+        ${MTX} -f $ctl inventory
       fi
       ${MTX} -f $ctl status >${TMPFILE}
       rtn=$?
@@ -257,7 +274,7 @@ case $cmd in
       # If perl isn't installed, you can use by those commands
 #cat ${TMPFILE} | grep "Data Transfer Element" | awk "{print \"D:\"\$4 \$7 \$9 \$10}" | sed "s/=/:/" | sed "s/Full/F:/" | sed "s/Empty/E/"
 #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/"
-#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/" 
+#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/"
 
       rm -f ${TMPFILE} >/dev/null 2>&1
       exit $rtn