#!/bin/ksh93
# IBM_PROLOG_BEGIN_TAG 
# This is an automatically generated prolog. 
#  
# 61haes_r714 src/43haes/lib/ksh93/hacmp/KLIB_HACMP_is_known_logical_volume.sh 1.3 
#  
# 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 
# @(#)84	1.3  src/43haes/lib/ksh93/hacmp/KLIB_HACMP_is_known_logical_volume.sh, hacmp.assist, 61haes_r714 7/3/12 12:09:18

# 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_is_known_logical_volume

=head1 VERSION

 Version Number:  1.3
 Last Extracted:  1/31/14 04:41:32
 Last Changed:    7/3/12 12:09:18

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

=head1 SYNOPSIS

KLIB_HACMP_is_known_logical_volume

=head1 DESCRIPTION

Determines if the specified logical volume
is configured within the cluster.

=head1 ARGUMENTS

 1. lvname [REQUIRED] [string]
    The label of the logical volume that is to be searched for
    within the cluster.

=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_is_known_logical_volume {
    LINENO=2 . $HALIBROOT/log_entry "$0()" "$CL"
    : version=1.3, src/43haes/lib/ksh93/hacmp/KLIB_HACMP_is_known_logical_volume.sh, hacmp.assist, 61haes_r714
    : INPUTS: $*

    typeset lvname=${1//\"/}

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

    #===================================
    : Declare and initialize variables
    #===================================
    typeset -i rc=$RC_UNKNOWN
    typeset LV_DATA= lv= rem=

    #=================
    : Validate input
    #=================
    if [[ -z $lvname ]]; 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 VGS=
        CL=$LINENO KLIB_HACMP_list_volume_groups VGS 2>>$CLMGR_TMPLOG
        for (( i=0; i<${#VGS[*]}; i++ )); do
            VG=${VGS[$i]}
            [[ $VG == *([[:space:]]) ]] && continue

            print -- "$0()[$LINENO]($SECONDS): $HASBIN/cl_lsvg -l $VG" >>$CLMGR_TMPLOG
            LV_DATA=$(LANG=C LC_ALL=C $HASBIN/cl_lsvg -l $VG 2>>$CLMGR_TMPLOG)
            print "cl_lsvg RC: $?" >>$CLMGR_TMPLOG

            print -- "$LV_DATA" |\
            while read lv rem; do
                [[ $lv == *: || -z $lv ]] && continue
                [[ $lv == LV && $rem == NAME* ]] && continue
                if [[ $lvname == $lv ]]; then
                    rc=$RC_SUCCESS
                    break
                fi
            done # End of the LV data loop
        done # End of the VG loop

        (( $rc != RC_SUCCESS )) && rc=$RC_ERROR
    fi

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