#!/bin/ksh93 # IBM_PROLOG_BEGIN_TAG # This is an automatically generated prolog. # # 61haes_r721 src/43haes/lib/ksh93/hacmp/KLIB_HACMP_list_events.sh 1.5 # # Licensed Materials - Property of IBM # # Restricted Materials of IBM # # COPYRIGHT International Business Machines Corp. 2012,2016 # 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 #============================================================================ # # Name: KLIB_HACMP_list_events # # Description: This is the main, FPATH function that is invoked by clmgr # to collect event names. It uses the "cllscustom" and clodmget # utilities to generate the list of names unless a search is # being conducted. In the case of a search, the associated # FPATH function, KLIB_HACMP_get_event_attributes is invoked # in verbose mode. The resulting data set is then passed # through the "search_properties()" function to arrive at # a set of outputs that matches the provided search parameters. # # Inputs: See the "devDoc()" function at the bottom of this file. # # Outputs: The list array is populated with one event per entry. The # only other outputs are any error messages that might be # needed. # # Returns: Zero if no errors are detected. Otherwise, an appropriate # non-zero value is returned. Refer to the "RETURN" section # of the "devDoc()" function at the bottom of this file for # the standard return code values/meanings for clmgr. # #============================================================================ function KLIB_HACMP_list_events { LINENO=2 . $HALIBROOT/log_entry "$0()" "$CL" : version=1.5, src/43haes/lib/ksh93/hacmp/KLIB_HACMP_list_events.sh, hacmp.assist, 61haes_r721, 1613A_hacmp721 : INPUTS: $* typeset -n list=$1 shift if [[ -n $1 && $1 != *=* ]]; then # Not a search. Must be a type. typeset -u evtype=$1 shift fi [[ $CLMGR_LOGGING == 'med' ]] && set +x # Only trace param values #=================================================== : Check for any specified attribute=value pairs. : If any are found, use those to query the output. #=================================================== typeset -A queries typeset -u uc_attr= uc_value= typeset value= while (( $# > 0 )); do value="$1" shift if [[ $value == *=* ]]; then uc_attr=${value%%=*} if [[ $uc_attr == "TYPE" ]]; then uc_value=${value#*=} [[ -z $evtype ]] && evtype=$uc_value case $evtype in P*) evtype="PREDEFINED" ;; C*) evtype="CUSTOM" ;; A*) evtype="ALL" ;; esac value=$evtype fi queries[$uc_attr]="${value#*=}" fi done [[ $CLMGR_LOGGING == 'med' ]] && set +x # Only trace param values #=================================== : Declare and initialize variables #=================================== typeset LINE= OUTPUT= typeset -i index=0 matches=0 rc=$RC_UNKNOWN if (( ${#queries[*]} == 0 )) || ( (( ${#queries[*]} == 1 )) && [[ -n ${queries[TYPE]} ]] ) then # List all #======================== # CUSTOM CLUSTER EVENTS #======================== if [[ $evtype == *([[:space:]]) || $evtype == @(\*|A|C)* ]]; then print "$0()[$LINENO]($SECONDS): cllscustom -t event" >>$CLMGR_TMPLOG # Always log commands OUTPUT=$(cllscustom -t event) rc=$? print "$0()[$LINENO]($SECONDS): cllscustom RC: $rc" >>$CLMGR_TMPLOG # Always log command result (( $rc != RC_SUCCESS )) && rc=$RC_ERROR print -- "$OUTPUT" |\ while read LINE; do if [[ $LINE != *([[:space:]]) ]]; then [[ $LINE == *([[:space:]])\#* ]] && continue [[ $LINE == *+([[:space:]])* ]] && continue list[$index]=$LINE (( index++ )) fi done fi #==================== # PREDEFINED EVENTS #==================== if [[ $evtype == @(\*|A|P)* ]]; then print "$0()[$LINENO]($SECONDS): clodmget -f name -n HACMPevent" >>$CLMGR_TMPLOG # Always log commands OUTPUT=$(clodmget -f name -n HACMPevent 2>>$CLMGR_TMPLOG) rc=$? print "$0()[$LINENO]($SECONDS): clodmget RC: $rc" >>$CLMGR_TMPLOG # Always log command result (( $rc != RC_SUCCESS )) && rc=$RC_ERROR print -- "$OUTPUT" |\ while IFS=: read LINE; do if [[ $LINE != *([[:space:]]) ]]; then [[ $LINE == *([[:space:]])\#* ]] && continue [[ $LINE == *+([[:space:]])* ]] && continue list[$index]=$LINE (( index++ )) fi done fi else # Searches were provided typeset -A allProperties CL=$LINENO CLMGR_VERBOSE=1 KLIB_HACMP_get_event_attributes "" allProperties TYPE=$evtype CL=$LINENO search_properties queries allProperties rc=$? if (( $rc == RC_SUCCESS )); then for key in ${!allProperties[*]}; do [[ $key != NAME@(|+([0-9])) ]] && continue list[$index]=${allProperties[$key]} (( index++ )) done fi fi log_return_msg "$rc" "$0()" "$LINENO" return $? } # End of "KLIB_HACMP_list_events()" #============================================================================ # # Name: devDoc # # Description: This is a never-to-be-called, wrapper function that all the # clmgr FPATH functions implement in order to hide embedded # syntax from trace logging. This information is implemented # in POD format, and can be viewed in a number of ways using # POD tools. Some viewing suggestions for this function's POD- # formatted information are: # # perldoc # pod2text -c # pod2text -c --code # pod2html # # However, the more important use for this information is that # it is parsed by clmgr to display the syntax for this file's # operation. The information in the "SYNOPSIS" section is used # for this purpose. This feature was originally implemented # using the man page information. However, in a code review it # was pointed out that this approach had to be changed because # customers do not have to install the man pages! Therefore, a # built-in dependency on man page information would break the # automatic help feature of clmgr. So the SYNPOSIS section must # be used instead. # # IMPORTANT: As a result of this, it is imperative that the # information in this SYNOPSIS be kept in sync # with the man page information, which is owned # by the IDD team. # # Inputs: None. # # Outputs: None. # # Returns: n/a (not intended to be invoked) # #============================================================================ function devDoc { : <<'=cut' >/dev/null 2>&1 =head1 NAME KLIB_HACMP_list_events =head1 VERSION Version Number: 1.5 Last Extracted: 3/29/16 17:47:11 Last Changed: 3/21/16 11:16:51 Path, Component, Release(, Level): src/43haes/lib/ksh93/hacmp/KLIB_HACMP_list_events.sh, hacmp.assist, 61haes_r721, 1613A_hacmp721 =head1 SYNOPSIS clmgr query event NOTE: the alias for "event" is "ev". =head1 DESCRIPTION Displays the currently configured set of customer cluster events. =head1 ARGUMENTS 1. list [REQUIRED] [hash ref] An array within which data about the queried objects can be returned to the caller. 2. evtype [OPTIONAL] [string] The type of events to list. =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. 2012,2015 All Rights Reserved =cut } # End of "devDoc()" #============================================================================== # The following, comment block attempts to enforce coding standards when this # file is edited via emacs or vim. This block _must_ appear at the very end # of the file, or the editor will not find it, and it will be ignored. #============================================================================== # Local Variables: # indent-tabs-mode: nil # tab-width: 4 # End: #============================================================================== # vim: tabstop=4 shiftwidth=4 expandtab #==============================================================================