NAME

recycler.sh - Oracle Hierarchical Storage Manager (Oracle HSM) recycler post-processing script

SYNOPSIS

∕etc∕opt∕SUNWsamfs∕scripts∕recycler.sh gen_media vsn slot eq specific_media fs_name [ vsn_modifier ]

AVAILABILITY

SUNWsamfs

DESCRIPTION

The sam-recycler (1m) process executes the ∕etc∕opt∕SUNWsamfs∕scripts∕recycler.sh script after it has finished draining a cartridge of all known active archive images and recycling is complete.

As released, ∕etc∕opt∕SUNWsamfs∕scripts∕recycler.sh sends email to root with the relevant information.

OPTIONS

This script accepts the following arguments:

gen_media: Generic media type. Specify od for magneto-optical media. Specify tp for tape media. This argument is used to construct the name of the appropriate media labeling command, either odlabel (1m) or tplabel (1m).
vsn: The volume serial name (VSN) of the cartridge being processed.
slot: The slot location of the media in the library.
eq: The Equipment Number of the library in which the media cartridge is located.
specific_media: The specific media type. For information on specific media types, see the mcf man page. This information is supplied to the chmed (1m) command if needed.
fs_name: Either hy, which represents the historian, or the family set name of the library.
vsn_modifier: The VSN modifier. Used only for magneto-optical.

EXAMPLE

The following is an example ∕etc∕opt∕SUNWsamfs∕scripts∕recycler.sh file:

#!∕bin∕csh -f
#
#   ∕etc∕opt∕SUNWsamfs∕scripts∕recycler.sh - post-process a VSN after recycler h
as
#   drained it of all known active archive copies.
#
#   Arguments are:
#      $1 - generic media type "od" or "tp" - used to construct the name
#           of the appropriate label command: odlabel or tplabel
#
#      $2 - VSN of cartridge being post-processed
#
#      $3 - Slot in the library where the VSN is located
#
#      $4 - equipment number of the library where the VSN is located
#  
#      $5 - actual media type ("mo", "lt", etc.) - used to chmed
#           the media if required
#
#      $6 - family set name of the physical library, or the string
#           "hy" for the historian library.    This can be used to
#           handle recycling of off-site media, as shown below.
#
#          $7 - VSN modifier, used for optical and D2 media
#
#
#
#   It is a good idea to log the calls to this script
#echo `date` $* >>  ∕var∕opt∕SUNWsamfs∕recycler.sh.log
#   As an example, if uncommented, the following lines will relabel the VSN,
#   if it exists in a physical library.  If the VSN is in the historian
#   catalog (e.g., it's been exported from a physical library and moved
#   to off-site storage), then email is sent to "root" informing that the
#   medium is ready to be returned to the site and reused.
#
#set stat=0
#if ( $6 != hy ) then
#    ∕opt∕SUNWsamfs∕sbin∕chmed -R $5.$2
#    ∕opt∕SUNWsamfs∕sbin∕chmed -W $5.$2
#    if ( $5 != "d2" ) then
#        if ( $1 != "od" ) then
#            ∕opt∕SUNWsamfs∕sbin∕${1}label -w -vsn $2 -old $2 $4\:$3
#                       if ( $status != 0 ) then
#                           set stat = 1
#                       endif
#        else
#            ∕opt∕SUNWsamfs∕sbin∕${1}label -w -vsn $2 -old $2 $4\:$3\:$7
#                       if ( $status != 0 ) then
#                           set stat = 1
#                       endif
#               endif
#    else
#        ∕opt∕SUNWsamfs∕sbin∕${1}label -w -vsn $2 -old $2 $4\:$3\:$7
#               if ( $status != 0 ) then
#                       set stat = 1
#               endif
#    endif
#else
#    mail root ∕eof
#VSN $2 of type $5 is devoid of active archive
#images.  It is currently in the historian catalog, which indicates that
#it has been exported from the on-line libraries.
#
#You should import it to the appropriate library, and relabel it using
#${1}label.
#
#This message will continue to be sent to you each time the recycler
#runs, until you relabel the VSN, or you use
#the QFS samu or
#Oracle HSM Manager programs to export this medium from the historian catalog to
#suppress this message.
#∕eof
#endif
#echo `date` $* done >>  ∕var∕opt∕SUNWsamfs∕recycler.sh.log
#if ( $stat != 0 ) then
#       exit 1
#else
#       exit 0
#endif
#
#
#   These lines would inform "root" that the VSN should be removed from the
#   robotic library:
#
#mail root ∕eof 
#VSN $2 in library $4 is ready to be shelved off-site.
#∕eof
#echo `date` $* done >>  ∕var∕opt∕SUNWsamfs∕recycler.sh.log
#exit 0
#  The default action is to mail a message reminding you to set up this 
#  file.  You should comment out these lines (through and including the ∕eof
#  below) after you've set up this file.
#
mailx -s "Robot $6 at hostname `hostname` recycle." root ∕eof
The ∕etc∕opt∕SUNWsamfs∕scripts∕recycler.sh script was called by 
the Oracle HSM recycler
with the following arguments:
Media type: $5($1)  VSN: $2  Slot: $3  Eq: $4 
      Library: $6

∕etc∕opt∕SUNWsamfs∕scripts∕recycler.sh is a script which is called when the recy
cler
determines that a VSN has been drained of all known active archive
copies.  You should determine your site requirements for disposition of
recycled media - some sites wish to relabel and reuse the media, some
sites wish to take the media out of the library for possible later use
to access historical files.  Consult the recycler (1m) man page for more
information.
∕eof
#echo `date` $* done >>  ∕var∕opt∕SUNWsamfs∕recycler.sh.log
exit 0

The example first checks to see if the VSN is in a physical library. If it is, the example script first clears the read-only and write-protect catalog bits. It then issues a tplabel (1m) or odlabel (1m) command to relabel the cartridge with its existing label. Relabeling has the effect of clearing all the expired archive images from the cartridges, thus enabling the archiver to re-use the cartridge. Labeling also clears the recycle bit in the VSN's catalog entry.

If the VSN is in the historian catalog, the script sends an email message to root. Note that a cartridge in a manually mounted drive is shown in the historian catalog as well, so you may want to see if the VSN is currently in a drive and relabel it if necessary.