#!/bin/ksh93
# IBM_PROLOG_BEGIN_TAG 
# This is an automatically generated prolog. 
#  
# 61haes_r714 src/43haes/lib/ksh93/hacmp/KLIB_HACMP_is_known_volume_group.sh 1.4 
#  
# 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 
# @(#)15	1.4  src/43haes/lib/ksh93/hacmp/KLIB_HACMP_is_known_volume_group.sh, hacmp.assist, 61haes_r714 5/15/13 17:09:33

#================================================
# The following, commented line enforces coding
# standards when this file is edited via vim.
#================================================
# vim:tabstop=4:shiftwidth=4:expandtab:smarttab
#================================================

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

=head1 VERSION

 Version Number:  1.4
 Last Extracted:  1/31/14 04:41:35
 Last Changed:    5/15/13 17:09:33

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

=head1 SYNOPSIS

KLIB_HACMP_is_known_volume_group

=head1 DESCRIPTION

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

=head1 ARGUMENTS

 1. vgname [REQUIRED] [string]
    The label of the volume group that is to be search for
    within the cluster.

 2. rg [OPTIONAL] [string]
    A reference to use for returning the resource group for this volume group.

 3. nodelist [OPTIONAL] [string]
    A reference to use for returning the nodes for this volume group.

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

    typeset vgname=${1//\"/}
    [[ -n $2 ]] && typeset -n rg=$2
    [[ -n $3 ]] && typeset -n nodelist=$3

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

    #===================================
    : Declare and initialize variables
    #===================================
    typeset -i rc=$RC_UNKNOWN
    typeset name= rem= errfile="$TMPDIR/clmgr.KHikvg.err.$$"
    rg=
    nodelist=

    [[ -f $errfile ]] && /usr/bin/rm -f $errfile

    #=================
    : Validate input
    #=================
    if [[ -z $vgname ]]; 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
        #======================================================================
        : Added a retry loop around "cl_ls_shared_vgs" after testing revealed
        : that it could potentially fail due to intermittent clcomd glitches.
        : The loop masks the user from the unfortunate consequences of clcomd.
        #======================================================================
        typeset -i try=0 tries=5 no_data=1 cllsrc=$RESULT_UNKNOWN
        for (( try=0; try<tries; try++ )); do

            if [[ -z $cl_ls_shared_vgs_DATA ]]; then
                print -- "$0()[$LINENO]($SECONDS): $HACSPOC/cl_ls_shared_vgs -c -C" >>$CLMGR_TMPLOG  # Always log commands
                cl_ls_shared_vgs_DATA=$($HACSPOC/cl_ls_shared_vgs -c -C 2>>$errfile)
                cllsrc=$?
            else
                cllsrc=$RC_SUCCESS  # Already have the data
            fi
            print "cl_ls_shared_vgs RC: $cllsrc" >>$CLMGR_TMPLOG  # Always log command result

            if (( $cllsrc == $RC_SUCCESS )); then
                print -- "$cl_ls_shared_vgs_DATA" |\
                while read line; do
                    [[ $line == \#* ]] && continue

                    name=${line%%[[:space:]]*}
                    if [[ $name == $vgname ]]; then
                        line=${line##${name}+([[:space:]])}

                        nodelist=${line##*[[:space:]]}
                        line=${line%%+([[:space:]])${nodelist}}

                        if [[ $line != *([[:space:]]) ]]; then
                            [[ -n $rg ]] && rg="$rg "
                            rg="$rg$line"
                        fi
                        rc=$RC_SUCCESS
                        break
                    fi
                done

                no_data=0
                break

            elif (( try < (tries -1) )); then
                if [[ $cl_ls_shared_vgs_DATA == *cl_ls_shared_vgs:* ]]; then
                    print -- "$cl_ls_shared_vgs_DATA" >>$errfile
                    unset cl_ls_shared_vgs_DATA
                    break
                else
                    sleep 3
                fi
            fi
        done

        if (( no_data )); then
            /usr/bin/dspmsg -s $CLVT_SET $CLVT_MSGS 461 "\nERROR: unable to list shared volume groups.\n\n" 1>&2
            /usr/bin/cat $errfile 1>&2
            rc=$RC_ERROR
        fi

        if [[ -f $errfile ]]; then
            /usr/bin/cat $errfile 1>&2
            /usr/bin/rm -f $errfile
        fi
    fi

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