#!/bin/ksh93
# IBM_PROLOG_BEGIN_TAG 
# This is an automatically generated prolog. 
#  
# 61haes_r714 src/43haes/lib/ksh93/hacmp/KLIB_HACMP_is_known_physical_volume.sh 1.6 
#  
# Licensed Materials - Property of IBM 
#  
# COPYRIGHT International Business Machines Corp. 2011 
# 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 
# @(#)60	1.6  src/43haes/lib/ksh93/hacmp/KLIB_HACMP_is_known_physical_volume.sh, hacmp.assist, 61haes_r714 3/21/13 14:23:52

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

=head1 VERSION

 Version Number:  1.6
 Last Extracted:  1/31/14 04:41:19
 Last Changed:    3/21/13 14:23:52

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

=head1 SYNOPSIS

KLIB_HACMP_is_known_physical_volume

=head1 DESCRIPTION

Determines if the specified physical_volume
is configured within the cluster.

=head1 ARGUMENTS

 1. physical_volume [REQUIRED] [string]
    The name of the physical_volume to search for on this node.

 2. refnode [OPTIONAL] [string]
    A reference node where the specified physical volume is
    expected to be valid.

 3. data [OPTIONAL] [reference]
    A reference to a return vehicle for cllspvids output.

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

    typeset physical_volume=${1//\"/}
    typeset refnode=${2//\"/}

    typeset -i return_data=0
    if [[ -n $3 ]]; then
        nameref data=$3
                data=""
        return_data=1
    fi

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

    #===================================
    : Declare and initialize variables
    #===================================
    typeset -i rc=$RC_UNKNOWN
    typeset ALL_DISKS= cand_name= cand_pvid= cand_vg= cand_uuid= rest=

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

    else
        if [[ -n $refnode ]]; then
            ALL_DISKS=$(CL=$LINENO list_disks $refnode 2>/dev/null)
        else
            ALL_DISKS=$(CL=$LINENO list_disks 2>/dev/null)
            refnode=$LOCAL_NODE
        fi

        if [[ $ALL_DISKS != *([[:space:]]) ]]; then
            print -- "$ALL_DISKS" | /usr/bin/grep -w "$physical_volume" | read cand_name cand_pvid cand_vg cand_uuid rest

            if [[ $physical_volume == $cand_name || \
                  $physical_volume == $cand_pvid || \
                  $physical_volume == $cand_uuid ]]
            then
                rc=$RC_SUCCESS
                (( return_data )) && data="$refnode:$cand_name:$cand_pvid:$cand_uuid"
            else
                rc=$RC_NOT_FOUND
            fi
        else
            rc=$RC_ERROR
        fi
    fi
    [[ -n $data ]] && data=${data//[[:space:]]/}

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