#!/bin/ksh93
# IBM_PROLOG_BEGIN_TAG 
# This is an automatically generated prolog. 
#  
# 61haes_r714 src/43haes/lib/ksh93/hacmp/KLIB_HACMP_is_known_service_ip.sh 1.4 
#  
# Licensed Materials - Property of IBM 
#  
# COPYRIGHT International Business Machines Corp. 1990,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 
# @(#)78	1.4  src/43haes/lib/ksh93/hacmp/KLIB_HACMP_is_known_service_ip.sh, hacmp.assist, 61haes_r714, 1439A_hacmp714 8/26/14 13:54: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_service_ip

=head1 VERSION

 Version Number:  1.4
 Last Extracted:  9/25/14 17:45:42
 Last Changed:    8/26/14 13:54:18

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

=head1 SYNOPSIS

KLIB_HACMP_is_known_service_ip

=head1 DESCRIPTION

Determines if the specified service IP
is configured within the cluster.

=head1 ARGUMENTS

 1: service_ip [REQUIRED] [string]
    The service IP to search for within the cluster.

 2: LABEL [OPTIONAL] [string reference]
    A return vehicle for returning the network name
    for the service IP that was passed in. If the
    network name was already passed in, then LABEL
    should be identical to it.

=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.


#============================================================================
#
# Name:        KLIB_HACMP_is_known_service_ip
#
# Description: This is the main, FPATH function that is invoked by clmgr
#              to confirm that the provided input represents a service
#              IP/label within the cluster configuration.
#
# Inputs:      See the "devDoc()" function, above.
#
# Outputs:     If the optional LABEL input is passed in, it will be
#              populated with the network name of the service IP, if
#              that name differs from what was passed in.
#
# Returns:     Zero if no errors are detected. Otherwise, an appropriate
#              non-zero value is returned. Refer to the "RETURN" section
#              of the "devDoc()" function, above, for the standard return
#              code values/meanings for clmgr.
#
#============================================================================
function KLIB_HACMP_is_known_service_ip {
    LINENO=2 . $HALIBROOT/log_entry "$0()" "$CL"
    : version=1.4, src/43haes/lib/ksh93/hacmp/KLIB_HACMP_is_known_service_ip.sh, hacmp.assist, 61haes_r714, 1439A_hacmp714
    : INPUTS: $*

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

    integer RETURN_LABEL=0
    if [[ -n ${2//\"/} ]]; then
        nameref LABEL=${2//\"/}
        LABEL=""
        RETURN_LABEL=1
    fi

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

    #===================================
    : Declare and initialize variables
    #===================================
    typeset -i rc=$RC_UNKNOWN
    typeset value= service_ip_names= service_ip_addr= LINE=
    typeset name= type= nw= nettype= attr= node= ipaddr= haddr= if=
    typeset gname= netmask= hb_addr= site= prefix= family= remainder=

    #======================================================
    : Convert the provided service label into its network
    : names and aliases, as well as its IP address.
    #======================================================
    value=$(LANG=C LC_ALL=C /usr/bin/host $service_ip)
    service_ip_addr=${value%%,*}
    service_ip_addr=${service_ip_addr##*+([[:space:]])}
    service_ip_names=${value##*:}
    service_ip_names=${service_ip_names//,/}

    #=================
    : Validate input
    #=================
    if [[ -z $service_ip ]]; 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
        print -- "$0()[$LINENO]($SECONDS): $HAUTILS/cllsif -cS" >>$CLMGR_TMPLOG  # Always log commands
        $HAUTILS/cllsif -cS |\
        while read LINE; do

            : Handle possible IPv6 address
            typeset IPv6=
            if [[ $LINE == *\[* ]]; then
                IPv6=${LINE##*\[}
                IPv6=${IPv6%%\]*}
                LINE=${LINE/\[$IPv6\]/[${IPv6//:/_}]}
            fi

            print -- "$LINE" | IFS=: read name type nw nettype attr node ipaddr haddr if gname netmask hb_addr site prefix family remainder

            : Handle possible IPv6 address
            ipaddr=${ipaddr//_/:}
            ipaddr=${ipaddr/\[/}
            ipaddr=${ipaddr/\]/}

            [[ $type != "service" ]] && continue

            for value in $service_ip $service_ip_addr $service_ip_names; do
                if [[ $value == @($name|$ipaddr) ]]; then
                    rc=$RC_SUCCESS
                    (( RETURN_LABEL )) && LABEL=$name
                    break
                fi
            done
            (( rc == $RC_SUCCESS )) && break
        done

        (( $rc != RC_SUCCESS )) && rc=$RC_ERROR
        print "cllsif RC: $rc" >>$CLMGR_TMPLOG  # Always log command result
    fi

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