#!/bin/ksh93
# IBM_PROLOG_BEGIN_TAG 
# This is an automatically generated prolog. 
#  
# 61haes_r714 src/43haes/lib/ksh93/hacmp/KLIB_HACMP_delete_tape.sh 1.2 
#  
# Licensed Materials - Property of IBM 
#  
# COPYRIGHT International Business Machines Corp. 2010 
# All Rights Reserved 
#  
# US Government Users Restricted Rights - Use, duplication or 
# disclosure restricted by GSA ADP Schedule Contract with IBM Corp. 
#  
# IBM_PROLOG_END_TAG 
# @(#)94	1.2  src/43haes/lib/ksh93/hacmp/KLIB_HACMP_delete_tape.sh, hacmp.assist, 61haes_r714 6/10/12 15:11:43

# Start of POD-formatted documentation. Viewing suggestions:
#      perldoc <FILENAME>
#      pod2text -c <FILENAME>
#      pod2text -c --code <FILENAME>
#      pod2html <FILENAME>
function devDoc {
    : <<'=cut' >/dev/null 2>&1

=head1 NAME

KLIB_HACMP_delete_tape

=head1 VERSION

 Version Number:  1.2
 Last Extracted:  1/31/14 04:41:21
 Last Changed:    6/10/12 15:11:43

 Path, Component, Release(, Level):
 src/43haes/lib/ksh93/hacmp/KLIB_HACMP_delete_tape.sh, hacmp.assist, 61haes_r714

=head1 SYNOPSIS

clmgr delete tape {<tape>[,<tape#2>,<tape#n>,...] | ALL}

=head1 DESCRIPTION

Deletes one or more tape devices from the local system.

=head1 ARGUMENTS

 1. tapes [REQUIRED] [string]
    One or more (comma or space separated) tape devices to attempt to delete.

=head1 RETURN

 0: no errors were detected; the operation appears to have been successful
 1: a general error has occurred
 2: a specified resource does not exist, or could not be found
 3: some required input was missing
 4: some detected input was incorrect in some way
 5: a required dependency does not exist
 6: a specified search failed to match any data

=head1 COPYRIGHT

COPYRIGHT International Business Machines Corp. 2005,2010
All Rights Reserved

=cut
} # End of POD-formatted documentation.


function KLIB_HACMP_delete_tape {
    LINENO=2 . $HALIBROOT/log_entry "$0()" "$CL"
    : version=1.2, src/43haes/lib/ksh93/hacmp/KLIB_HACMP_delete_tape.sh, hacmp.assist, 61haes_r714
    : INPUTS: $*

    typeset tapes=${1//\"/}
            tapes=${tapes//,/ }

    [[ $CLMGR_LOGGING == 'med' ]] && set +x  # Only trace param values

    #===================================
    : Declare and initialize variables
    #===================================
    typeset -i rc=$RC_UNKNOWN
    typeset -i i=0
    typeset tape=

    #=================
    : Validate input
    #=================
    if [[ -z $tapes ]]; then
        /usr/bin/dspmsg -s $CLVT_SET $CLVT_MSGS 100 "\nERROR: a name/label must be provided.\n\n" 1>&2
        rc=$RC_MISSING_INPUT

    else
        typeset -u uctext=$tapes
        if [[ $uctext == "ALL" ]]; then
            tapes=
            typeset available
            CL=$LINENO KLIB_HACMP_list_tapes available
            for (( i=0; i<${#available[*]}; i++ )); do
                tapes="$tapes ${available[$i]}"
            done

            if [[ $tapes == *([[:space:]]) ]]; then
                /usr/bin/dspmsg -s $CLVT_SET $CLVT_MSGS 334 "Warning: there are no tapes to delete.\n"
                rc=$RC_SUCCESS
            fi
        fi
    fi

    #========================================================
    : Delete the tape if no input errors have been detected
    #========================================================
    if (( $rc == RC_UNKNOWN )); then
        for tape in $tapes; do

            CL=$LINENO KLIB_HACMP_is_known_tape "$tape"
            if (( $? != RC_SUCCESS )); then
                /usr/bin/dspmsg -s $CLVT_SET $CLVT_MSGS 102 "\nERROR: \"%1\$s\" does not appear to exist!\n\n" "$tape" 1>&2
                /usr/bin/dspmsg -s $CLVT_SET $CLVT_MSGS 159 "Available Tapes:\n\n" 1>&2

                typeset available
                CL=$LINENO KLIB_HACMP_list_tapes available
                for (( i=0; i<${#available[*]}; i++ )); do
                    if [[ ${available[$i]} != *([[:space:]]) ]]; then
                        print -u2 "\t${available[$i]}"
                    fi
                done
                rc=$RC_NOT_FOUND

            else
                print -- "$0()[$LINENO]($SECONDS): $HAUTILS/clrmtape \"$tape\"" >>$CLMGR_TMPLOG  # Always log commands
                $HAUTILS/clrmtape "$tape"
                rc=$?
                if (( $rc != RC_SUCCESS )); then
                    rc=$RC_ERROR
                    /usr/bin/dspmsg -s $CLVT_SET $CLVT_MSGS 300 "\nERROR: failed to delete \"%1\$s\".\n\n" "$tape" 1>&2
                    break
                fi
            fi
        done

        (( $rc != RC_SUCCESS )) && print -u2
    fi

    #=======================================================================
    : If a user input error was detected, provide some helpful suggestions
    #=======================================================================
    if (( $rc == RC_MISSING_INPUT || $rc == RC_INCORRECT_INPUT )) && \
       [[ $CLVT_GUI == *([[:space:]]) ]]
    then
        CL=$LINENO cl_dspmsg -s $CLVT_SET $CLVT_MSGS 104 "For more information about available options and syntax, try\n\"$HAUTILS/clmgr %1\$s\". As an\nalternative, if the PowerHA SystemMirror man pages have been installed, invoke\n\"$HAUTILS/clmgr -hv\" (or \"/usr/bin/man clmgr\"),\nsearching for \"%2\$s\" in the displayed text.\n\n" \
        "delete tape -h" "TAPE:" "$CLVT_PROGNAME" 1>&2
    fi

    log_return_msg "$rc" "$0()" "$LINENO"
    return $?
} # End of "KLIB_HACMP_delete_tape()"