#!/bin/ksh93
#  ALTRAN_PROLOG_BEGIN_TAG
#  This is an automatically generated prolog.
#
#  Copyright (C) Altran ACT S.A.S. 2017,2018,2019,2021.  All rights reserved.
#
#  ALTRAN_PROLOG_END_TAG
#
# IBM_PROLOG_BEGIN_TAG 
# This is an automatically generated prolog. 
#  
# 61haes_r714 src/43haes/lib/ksh93/hacmp/KLIB_HACMP_recover_cluster.sh 1.2 
#  
# Licensed Materials - Property of IBM 
#  
# COPYRIGHT International Business Machines Corp. 2009,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 
# @(#)  7d4c34b 43haes/lib/ksh93/hacmp/KLIB_HACMP_recover_cluster.sh, 726, 2147A_aha726, Feb 05 2021 09:50 PM

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

=head1 SYNOPSIS

 clmgr recover cluster
          [ CANCEL_EVENT={false|true} ]

 NOTE: the alias for "cluster" is "cl".

=head1 DESCRIPTION

Attempts to recover from an event failure on every node with the cluster.

=head1 ARGUMENTS

 1. cancel event [OPTIONAL] [string]
    A Boolean-like value indicates whether the administrator wants to 
    cancel or continue with the remaining event processing.
    Valid values include: {false|true}


=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

=cut
} # End of POD-formatted documentation.

function KLIB_HACMP_recover_cluster {
    . $HALIBROOT/log_entry "$0()" "$CL"
    : version=@(#)  7d4c34b 43haes/lib/ksh93/hacmp/KLIB_HACMP_recover_cluster.sh, 726, 2147A_aha726, Feb 05 2021 09:50 PM
    : INPUTS: $*

    typeset -l cancel=${1//\"/}

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

    #===================================
    : Declare and initialize variables
    #===================================
    typeset -i rc=$RC_UNKNOWN
    typeset -i i=0
    typeset nodelist= node=
    typeset node_data

    #================================================================
    : Check for a defined cluster. No need to continue without one.
    #================================================================
    CL=$LINENO isClusterDefined
    if (( $? != RC_SUCCESS )); then
        rc=$RC_MISSING_DEPENDENCY

    #=================
    : Validate input
    #=================
    else
        CL=$LINENO KLIB_HACMP_list_nodes node_data 
        for (( i=0; i<${#node_data[*]}; i++ )); do
            nodelist="$nodelist ${node_data[$i]}"
        done

        if [[ $nodelist == *([[:space:]]) ]]; then
            dspmsg -s $CLVT_SET $CLVT_MSGS 600 "\nERROR: no nodes are defined within this cluster!\n\n" 1>&2
            rc=$RC_NOT_FOUND
        fi
    fi

    #============================================================
    : Validate the recovery mode
    #============================================================
    if (( $rc == RC_UNKNOWN )) && [[ -n $cancel ]]; then
        if [[ $cancel != @(1|0|n|f|y|t)* ]]; then
            dspmsg -s $CLMGR_SET $CLMGR_MSGS 110 "\nERROR: invalid value specified for \"%1\$s\":  \"%2\$s\".\n" CANCEL_EVENT "$cancel" 1>&2
            dspmsg -s $CLMGR_SET $CLMGR_MSGS 3 "Valid values: %1\$s\n\n" "false, true" 1>&2
            rc=$RC_INCORRECT_INPUT
        fi
    fi

    #============================================================
    : Recover the cluster if no input errors have been detected
    #============================================================
    if (( $rc == RC_UNKNOWN )); then
        CL=$LINENO KLIB_HACMP_recover_node "$nodelist" $cancel
        rc=$?
    fi

    if (( $rc == RC_ERROR )); then
        dspmsg -s $CLVT_SET $CLVT_MSGS 601 "\nERROR: the recovery effort has failed.\n\n" 1>&2
    fi

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