#!/bin/ksh93 # IBM_PROLOG_BEGIN_TAG # This is an automatically generated prolog. # # 61haes_r720 src/43haes/lib/ksh93/hacmp/KLIB_HACMP_list_volume_groups.sh 1.6 # # 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 # @(#)76 1.6 src/43haes/lib/ksh93/hacmp/KLIB_HACMP_list_volume_groups.sh, hacmp.assist, 61haes_r720, 1525A_hacmp720 6/11/15 17:12:11 #============================================================================ # # Name: KLIB_HACMP_list_volume_groups # # Description: This is the main, FPATH function that is invoked by clmgr # to collect volume group names. It uses the "cl_ls_shared_vgs" # utility 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_volume_group_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 volume group 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_volume_groups { trap 'on_exit_listvgs' EXIT LINENO=2 . $HALIBROOT/log_entry "$0()" "$CL" : version=1.6, src/43haes/lib/ksh93/hacmp/KLIB_HACMP_list_volume_groups.sh, hacmp.assist, 61haes_r720, 1525A_hacmp720 : INPUTS: $* typeset -n list=$1 shift [[ $CLMGR_LOGGING == 'med' ]] && set +x # Only trace param values #=================================== : Declare and initialize variables #=================================== typeset -A queries typeset -u attr= typeset line= OUTPUT= value= typeset -i index=0 matches=0 rc=$RC_UNKNOWN # Declare globally, so it is visible in the exit function errfile="$TMPDIR/clmgr.KHlvg.err.$$" # Global, for visibility in on_listvgs_exit()! #=================================================== : 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 if (( ${#queries[*]} == 0 )); then # List all #====================================================================== : Added a retry loop around "cl_ls_shared_vgs" after testing revealed : that it could potentially fail due to intermittent clcomd glitches. : The loop masks the user from the unfortunate consequences of clcomd. #====================================================================== typeset -i try=0 tries=5 found=0 for (( try=0; try>$CLMGR_TMPLOG # Always log commands OUTPUT=$(LC_ALL=C cl_ls_shared_vgs -c -C 2>>$errfile) rc=$? print "$0()[$LINENO]($SECONDS): cl_ls_shared_vgs RC: $rc; OUTPUT == \"$OUTPUT\"" >>$CLMGR_TMPLOG # Always log command result if (( $rc == RC_SUCCESS )); then [[ $OUTPUT == *cl_ls_shared_vgs:* ]] && unset OUTPUT found=1 break elif (( try < (tries -1) )); then if [[ $OUTPUT == *cl_ls_shared_vgs:* ]]; then print -- "$OUTPUT" >>$errfile unset OUTPUT break else sleep 3 fi fi done if (( ! found )); then grep -q "cl_ls_shared_vgs: No shared volume groups were found." $errfile if (( $? == 0 )); then rc=$RC_SUCCESS else dspmsg -s $CLMGR_SET $CLMGR_MSGS 461 "\nERROR: unable to list shared volume groups.\n\n" 1>&2 cat $errfile 1>&2 rc=$RC_ERROR fi fi rm -f $errfile if (( $rc == RC_SUCCESS )); then print -- "$OUTPUT" |\ while read line; do [[ $line == \#* ]] && continue typeset item=${line%%+([[:space:]])*} [[ $item == "caavg_private" ]] && continue list[$index]=$item (( index++ )) done fi else # A search was specified typeset -A allProperties CL=$LINENO CLMGR_VERBOSE=1 KLIB_HACMP_get_volume_group_attributes "" allProperties 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_volume_groups()" function on_exit_listvgs { if (( $rc == RC_UNKNOWN )); then if [[ -n $errfile && -f $errfile ]]; then cat $errfile 1>&2 fi exit $RC_ERROR fi [[ -n $errfile && -f $errfile ]] && rm -f $errfile } # End of "on_exit_listvgs()" #============================================================================ # # 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_volume_groups =head1 VERSION Version Number: 1.6 Last Extracted: 6/16/15 17:51:19 Last Changed: 6/11/15 17:12:11 Path, Component, Release(, Level): src/43haes/lib/ksh93/hacmp/KLIB_HACMP_list_volume_groups.sh, hacmp.assist, 61haes_r720, 1525A_hacmp720 =head1 SYNOPSIS clmgr query volume_group NOTE: the alias for "volume_group" is "vg". =head1 DESCRIPTION Constructs a list of the shared and/or concurrent volume groups within the cluster. =head1 ARGUMENTS 1. list [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 #==============================================================================