#!/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_r720 src/43haes/lib/ksh93/hacmp/KLIB_HACMP_get_method_attributes.sh 1.5 # # Licensed Materials - Property of IBM # # COPYRIGHT International Business Machines Corp. 2010,2015 # 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_get_method_attributes.sh, 726, 2147A_aha726, Feb 05 2021 09:50 PM #============================================================================ # # Name: KLIB_HACMP_get_method_attributes # # Description: This is the main, FPATH function that is invoked by clmgr # to collect information about method definitions. The cllspgr # and cllscustom utilities are invoked to extract the necessary # data. # # Inputs: See the "devDoc()" function at the bottom of this file. # # Outputs: The properties hash is populated. 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_get_method_attributes { . $HALIBROOT/log_entry "$0()" "$CL" : version=@(#) 7d4c34b 43haes/lib/ksh93/hacmp/KLIB_HACMP_get_method_attributes.sh, 726, 2147A_aha726, Feb 05 2021 09:50 PM : INPUTS: $* typeset method=${1//\"/} # Get the "properties" associative array reference, and initialize it if [[ -z $2 ]] || [[ -n $CLMGR_LOGGING && $2 == "|" ]]; then method= typeset -n properties=$1 else typeset -n properties=$2 fi [[ $CLMGR_LOGGING == 'med' ]] && set +x # Only trace param values #=================================== : Declare and initialize variables #=================================== for k in ${!properties[*]}; do unset properties[$k]; done typeset METHODS= typeset -i INDEX=0 rc=$RC_SUCCESS typeset key= typeset -i matches=0 typeset -u attr= uc_key= typeset -A queries typeset -i i=0 #=================================================== : Check for any specified attribute=value pairs. : If any are found, use those to query the output. #=================================================== while (( $# > 0 )); do value="$1" if [[ $value == *=* ]]; then attr=${value%%=*} # "attr" makes this uppercase queries[$attr]="${value#*=}" fi shift done #======================================= : Make sure we have something to query #======================================= if [[ -n $method ]]; then [[ $method != *,* ]] && unset INDEX for method in ${method//,/ }; do CL=$LINENO KLIB_HACMP_is_known_method "$method" 2>/dev/null if (( $? != RC_SUCCESS )); then dspmsg -s $CLMGR_SET $CLMGR_MSGS 102 '\nERROR: "%1$s" does not appear to exist!\n\n' "$method" 1>&2 dspmsg -s $CLMGR_SET $CLMGR_MSGS 149 "Available Methods:\n\n" 1>&2 typeset available CL=$LINENO KLIB_HACMP_list_methods available for (( i=0; i<${#available[*]}; i++ )); do if [[ ${available[$i]} != *([[:space:]]) ]]; then print -u2 "\t${available[$i]}" fi done print -u2 "" rc=$RC_NOT_FOUND else [[ " $METHODS " != *\ $method\ * ]] && METHODS="$METHODS $method" fi done elif (( CLMGR_VERBOSE || ${#queries[*]} > 0 )); then typeset available CL=$LINENO KLIB_HACMP_list_methods available for (( i=0; i<${#available[*]}; i++ )); do [[ " $METHODS " != *\ ${available[$i]}\ * ]] && METHODS="$METHODS ${available[$i]}" done else dspmsg -s $CLMGR_SET $CLMGR_MSGS 100 "\nERROR: a name/label must be provided.\n\n" 1>&2 rc=$RC_MISSING_INPUT fi (( $rc != RC_SUCCESS )) && unset METHOD #================================================================== : Populate the return hash with the retrieved attributes/values # NOTE: keep in mind that there is no restriction in the product # that method names must be unique across method types! # So we have to jump through a few hoops to ensure accuracy # in the case where a method name has multiple types. #================================================================== for method in $METHODS; do typeset -l type= CL=$LINENO KLIB_HACMP_is_known_method "$method" type typeset types=${type//,/ } for type in $types; do properties[NAME$INDEX]=$method if [[ $type == @(sn|ve)* && -s $ODMDIR/HACMPcustom ]] then print -- "$0()[$LINENO]($SECONDS): cllscustom -c -t \"$type\" -n \"$method\" | grep \"^$method:\"" >>$CLMGR_TMPLOG # Always log commands OUTPUT=$(cllscustom -c -t "$type" -n "$method" | grep "^$method:") cmd_rc=$? print "$0()[$LINENO]($SECONDS): cllscustom RC: $cmd_rc" >>$CLMGR_TMPLOG # Always log command result elif [[ $type == no* && -s $ODMDIR/HACMPpager ]] then print -- "$0()[$LINENO]($SECONDS): cllspgr -m \"$method\" -s" >>$CLMGR_TMPLOG # Always log commands OUTPUT=$(cllspgr -m "$method" -s) cmd_rc=$? print "$0()[$LINENO]($SECONDS): cllspgr RC: $cmd_rc" >>$CLMGR_TMPLOG # Always log command result fi if (( $cmd_rc == RC_SUCCESS )); then # # SNAPSHOT / VERIFY # if [[ $type == @(sn|ve)* ]]; then print -- "$OUTPUT" |\ while IFS=: read oname otype desc value relation status; do [[ $oname == \#* ]] && continue break done properties[DESCRIPTION$INDEX]="$desc" properties[FILE$INDEX]="$value" properties[TYPE$INDEX]=$type if [[ $type == ve* ]]; then typeset MODE=$(clodmget -q "name=$method" -f mode HACMPcustom) if [[ ${MODE//\"/} == 1 ]]; then properties[SOURCE$INDEX]="library" elif [[ ${MODE//\"/} == 0 ]]; then properties[SOURCE$INDEX]="script" else properties[SOURCE$INDEX]=$MODE fi fi # # NOTIFY # elif [[ $type == no* ]]; then print -- "$OUTPUT" |\ while IFS=: read oname desc nodes contact file events retry timeout; do [[ $oname == \#* ]] && continue break done properties[DESCRIPTION$INDEX]="$desc" properties[FILE$INDEX]="$file" properties[TYPE$INDEX]=$type properties[CONTACT$INDEX]=$contact properties[EVENTS$INDEX]=$events properties[NODES$INDEX]=$nodes properties[RETRY$INDEX]=$retry properties[TIMEOUT$INDEX]=$timeout fi else dspmsg -s $CLMGR_SET $CLMGR_MSGS 118 '\nERROR: the specified method, "%1$s", could not be queried.\n\n' "$method" 1>&2 rc=$RC_ERROR break fi #============================================================== : Even if there is no value for a given attribute, we want to : display a placeholder for it, so the customer always sees a : consistent, complete set of attributes. #============================================================== for key in ${_COLON_ATTR_ORDER[method]}; do if [[ $type == @(sn|ve)* && $key == @(CO|EV|NO|RE|TI)* ]]; then continue fi if [[ -z ${properties[$key$INDEX]} ]]; then properties[$key$INDEX]="" fi done [[ $type != ve* ]] && unset properties[SOURCE$INDEX] [[ $types == *\ * ]] && (( INDEX++ )) # Multiple types! done [[ $types != *\ * ]] && (( INDEX++ )) [[ $INDEX == *0 ]] && (( INDEX++ )) done #========================================================== : If any searches/filters were specified, handle them now #========================================================== if (( $rc == RC_SUCCESS && ${#queries[*]} > 0 )); then CL=$LINENO search_properties queries properties rc=$? fi (( $rc == RC_SUCCESS )) && CL=$LINENO prune_indexes properties log_return_msg "$rc" "$0()" "$LINENO" return $? } # End of "KLIB_HACMP_get_method_attributes()" #============================================================================ # # 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_get_method_attributes =head1 SYNOPSIS clmgr query method [,,,...] clmgr -v query method NOTE: the alias for "method" is "me". =head1 DESCRIPTION Retrieves the configuration data for one or more PowerHA custom methods. =head1 ARGUMENTS 1. method [REQUIRED] [string] The label of one or more methods (comma or space separated) that are to be queried. 2. properties [REQUIRED] [hash ref] An associative array within which data about the queried objects can be returned to the caller. =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 "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 #==============================================================================