#!/bin/ksh93 # IBM_PROLOG_BEGIN_TAG # This is an automatically generated prolog. # # 61haes_r720 src/43haes/lib/ksh93/hacmp/KLIB_HACMP_get_site_attributes.sh 1.18 # # 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 # @(#)81 1.18 src/43haes/lib/ksh93/hacmp/KLIB_HACMP_get_site_attributes.sh, hacmp.assist, 61haes_r720, 1525A_hacmp720 6/1/15 14:37:32 #============================================================================ # # Name: KLIB_HACMP_get_site_attributes # # Description: This is the main, FPATH function that is invoked by clmgr # to collect site information. The odmget utility is invoked # to extract the necessary data from the HACMPsite ODM. # # 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_site_attributes { LINENO=2 . $HALIBROOT/log_entry "$0()" "$CL" : version=1.18, src/43haes/lib/ksh93/hacmp/KLIB_HACMP_get_site_attributes.sh, hacmp.assist, 61haes_r720, 1525A_hacmp720 : INPUTS: $* typeset site=${1//\"/} # Get the "properties" associative array reference, and initialize it if [[ -z $2 ]] || [[ -n $CLMGR_LOGGING && $2 == "|" ]]; then site= 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 SITES= ID= name= value= DATA= typeset key= typeset -i matches=0 rc=$RC_SUCCESS 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 #================================================================ : Check for a defined cluster. No need to continue without one. #================================================================ CL=$LINENO isClusterDefined if (( $? != RC_SUCCESS )); then rc=$RC_MISSING_DEPENDENCY #======================================= : Make sure we have something to query #======================================= elif [[ -n $site ]]; then for site in ${site//,/ }; do site=$(CL=$LINENO KLIB_HACMP_is_known_site "$site" 2>/dev/null) if (( $? != RC_SUCCESS )); then dspmsg -s $CLMGR_SET $CLMGR_MSGS 102 '\nERROR: "%1$s" does not appear to exist!\n\n' "$site" 1>&2 dspmsg -s $CLMGR_SET $CLMGR_MSGS 157 "Available Sites:\n\n" 1>&2 typeset available CL=$LINENO KLIB_HACMP_list_sites 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 SITES="$SITES $site" fi done elif (( CLMGR_VERBOSE || ${#queries[*]} > 0 )); then typeset SITENAMES= print -- "$0()[$LINENO]($SECONDS): clodmget -n -f name HACMPsite" >>$CLMGR_TMPLOG # Always log commands SITENAMES=$(clodmget -n -f name HACMPsite) rc=$? print -- "$0()[$LINENO]($SECONDS): clodmget RC: $rc" >>$CLMGR_TMPLOG # Always log commands result if (( $rc == RC_SUCCESSS )); then for SITENAME in $SITENAMES; do SITES=${SITES:+$SITES }$SITENAME done fi 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 SITES #================================================================ : Populate the return hash with the retrieved attributes/values #================================================================ for site in $SITES; do if [[ $SITES == *\ * ]]; then print -- "$0()[$LINENO]($SECONDS): clodmget -q \"name=$site\" -f id HACMPsite" >>$CLMGR_TMPLOG # Always log commands ID=$(clodmget -q "name=$site" -f id HACMPsite) print "$0()[$LINENO]($SECONDS): clodmget RC: $?; $site ID == \"$ID\"" >>$CLMGR_TMPLOG # Always log command result fi print "$0()[$LINENO]($SECONDS): odmget -q \"name = $site\" HACMPsite" >>$CLMGR_TMPLOG # Always log commands DATA=$(odmget -q "name = $site" HACMPsite) print "$0()[$LINENO]($SECONDS): odmget RC: $?" >>$CLMGR_TMPLOG # Always log command result print -- "$DATA" |\ while IFS='=' read name value do name=${name##+([[:space:]])} name=${name%%+([[:space:]])} [[ -z $name || $name == 'HACMPsite:' ]] && continue value=${value##+([[:space:]])} value=${value%%+([[:space:]])} value=${value//\"/} attr=$name # Make uppercase if [[ $attr == ID* ]]; then typeset CID=$(clodmget -f id HACMPcluster) properties[G$attr$ID]="$CID$value" else [[ $attr == "DOMINANCE" ]] && continue # NOTE: the "NODES" attribute is what is used to actually # set the node list, so that is what should be # displayed via queries. [[ $attr == "NODELIST" ]] && attr=NODES properties[$attr$ID]=$value fi done properties[STATE$ID]=$(CL=$LINENO KLIB_HACMP_get_site_state "$site") print "$0()[$LINENO]($SECONDS): clodmget -n -q name="${properties[NAME$ID]}_sircol" -f ip_address HACMPsircol" >>$CLMGR_TMPLOG # Always log commands properties[SITE_IP$ID]=$(clodmget -n -q name="${properties[NAME$ID]}_sircol" -f ip_address HACMPsircol) print "$0()[$LINENO]($SECONDS): clodmget RC: $?, ${properties[NAME$ID]} IP == ${properties[SITE_IP$ID]}" >>$CLMGR_TMPLOG # Always log command result #======================================= : Get the site merge/recovery priority #======================================= print "$0()[$LINENO]($SECONDS): clodmget -n -q name=$site -f merge_priority HACMPsite" >>$CLMGR_TMPLOG value=$(clodmget -n -q name=$site -f merge_priority HACMPsite) print "$0()[$LINENO]($SECONDS): clodmget RC: $?; $site merge_priority == $value" >>$CLMGR_TMPLOG [[ $value == 0 ]] && value="MANUAL" properties[RECOVERY_PRIORITY$ID]=$value print "$0()[$LINENO]($SECONDS): odmget RC: $?" >>$CLMGR_TMPLOG #========================= : Get the site dominance #========================= print "$0()[$LINENO]($SECONDS): clodmget -n -q name=$site -f dominance HACMPsite" >>$CLMGR_TMPLOG properties[DOMINANT$ID]=$(clodmget -n -q name=$site -f dominance HACMPsite) print "$0()[$LINENO]($SECONDS): clodmget RC: $?, $site dominance == ${properties[DOMINANT$ID]}" >>$CLMGR_TMPLOG unset repositories # Make sure no previous results exist typeset repositories CL=$LINENO KLIB_HACMP_list_repositories repositories SITE=$site value=${repositories[*]} properties[REPOSITORIES$ID]="${value//\) /\), }" #================================== : Get the site HMCS for site $site #================================== typeset HMCLABELS= typeset hmclabels= print "$0()[$LINENO]($SECONDS): cllssite -S $site" >>$CLMGR_TMPLOG # Always log commands hmclabels=$(cllssite -S $site) (( rc |= $? )) print "$0()[$LINENO]($SECONDS): cllssite RC: $rc, $site HMCs == ${hmclabels//+([[:space:]])/ }" >>$CLMGR_TMPLOG # Always log commands result if (( $rc == RC_SUCCESS )); then for hmclabel in $hmclabels; do if [[ -n $hmclabel ]]; then HMCLABELS="${HMCLABELS:+$HMCLABELS }$hmclabel" fi done properties[HMCS$ID]=$HMCLABELS 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[site]}; do if [[ -z ${properties[$key$ID]} ]]; then properties[$key$ID]="" fi done if [[ ${properties[HEARTBEAT_TYPE]} == "UNICAST" ]]; then unset properties[SITE_IP$ID] fi [[ $CLUSTER_TYPE != "LC" ]] && unset properties[REPOSITORY$ID] done # End of the sites loop #========================================================== : 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_site_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_site_attributes =head1 VERSION Version Number: 1.18 Last Extracted: 6/16/15 17:51:09 Last Changed: 6/1/15 14:37:32 Path, Component, Release(, Level): src/43haes/lib/ksh93/hacmp/KLIB_HACMP_get_site_attributes.sh, hacmp.assist, 61haes_r720, 1525A_hacmp720 =head1 SYNOPSIS clmgr query site [,,,...] clmgr -v query site =head1 DESCRIPTION Retrieves the configuration data for one or more sites. =head1 ARGUMENTS 1. site [REQUIRED] [string] The label of one or more sites (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 =head1 COPYRIGHT COPYRIGHT International Business Machines Corp. 2010,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 #==============================================================================