#!/bin/ksh93 # IBM_PROLOG_BEGIN_TAG # This is an automatically generated prolog. # # 61haes_r720 src/43haes/lib/ksh93/hacmp/KLIB_HACMP_get_storage_agent_attributes.sh 1.10 # # Licensed Materials - Property of IBM # # COPYRIGHT International Business Machines Corp. 2011,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 # @(#)97 1.10 src/43haes/lib/ksh93/hacmp/KLIB_HACMP_get_storage_agent_attributes.sh, hacmp.assist, 61haes_r720, 1525A_hacmp720 6/1/15 14:47:22 #============================================================================ # # Name: KLIB_HACMP_get_storage_agent_attributes # # Description: This is the main, FPATH function that is invoked by clmgr # to collect storage agent information. The clxd_list_sa_director # utility is 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_storage_agent_attributes { LINENO=2 . $HALIBROOT/log_entry "$0()" "$CL" : version=1.10, src/43haes/lib/ksh93/hacmp/KLIB_HACMP_get_storage_agent_attributes.sh, hacmp.assist, 61haes_r720, 1525A_hacmp720 : INPUTS: $* typeset storage_agent=${1//\"/} # Get the "properties" associative array reference, and initialize it if [[ -z $2 ]] || [[ -n $CLMGR_LOGGING && $2 == "|" ]]; then storage_agent= typeset -n properties=$1 else typeset -n properties=$2 fi [[ $CLMGR_LOGGING == 'med' ]] && set +x # Only trace param values CL=$LINENO isEnterprise if (( $? != 1 )); then cl_dspmsg -s $CLMGR_SET $CLMGR_MSGS 184 "\nERROR: this operation requires IBM PowerHA SystemMirror for AIX Enterprise Edition.\n\n" 1>&2 log_return_msg "$RC_MISSING_DEPENDENCY" "$0()" "$LINENO" return $? fi #=================================== : Declare and initialize variables #=================================== for k in ${!properties[*]}; do unset properties[$k]; done typeset AGENTS= typeset -A list 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 $storage_agent ]]; then [[ $storage_agent != *,* ]] && unset INDEX for storage_agent in ${storage_agent//,/ }; do CL=$LINENO KLIB_HACMP_is_known_storage_agent "$storage_agent" 2>/dev/null if (( $? != RC_SUCCESS )); then dspmsg -s $CLMGR_SET $CLMGR_MSGS 102 '\nERROR: "%1$s" does not appear to exist!\n\n' "$storage_agent" 1>&2 dspmsg -s $CLMGR_SET $CLMGR_MSGS 163 "Available Storage Agents:\n\n" 1>&2 typeset available CL=$LINENO KLIB_HACMP_list_storage_agents 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 AGENTS="$AGENTS $storage_agent" fi done elif (( CLMGR_VERBOSE || ${#queries[*]} > 0 )); then CL=$LINENO KLIB_HACMP_list_storage_agents list for name in ${list[*]}; do name=${name##+([[:space:]])} name=${name%%+([[:space:]])} AGENTS="$AGENTS $name" 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 AGENTS #================================================================ : Populate the return hash with the retrieved attributes/values #================================================================ for storage_agent in $AGENTS; do properties[NAME$INDEX]=$storage_agent print -- "$0()[$LINENO]($SECONDS): $HAXDWIZ/clxd_list_sa_director -d\"|\" -n $storage_agent" >>$CLMGR_TMPLOG # Always log commands $HAXDWIZ/clxd_list_sa_director -d"|" -n $storage_agent >$TMPDIR/clmgr.KHgsaa.$$ cmd_rc=$? print "$0()[$LINENO]($SECONDS): clxd_list_sa_director RC: $cmd_rc" >>$CLMGR_TMPLOG # Always log command result if (( $cmd_rc != RC_SUCCESS )); then dspmsg -s $CLMGR_SET $CLMGR_MSGS 102 '\nERROR: "%1$s" does not appear to exist!\n\n' "$storage_agent" 1>&2 rc=$RC_NOT_FOUND break fi cat $TMPDIR/clmgr.KHgsaa.$$ |\ while IFS=\| read name type user password systems ips attrs rem; do [[ $name == *\ * ]] && continue properties[NAME$INDEX]="$name" properties[TYPE$INDEX]=$type properties[USER$INDEX]=$user properties[PASSWORD$INDEX]=$password properties[SYSTEMS$INDEX]=$systems properties[ADDRESSES$INDEX]=$ips properties[ATTRIBUTES$INDEX]=$attrs done rm -f $TMPDIR/clmgr.KHgsaa.$$ #============================================================== : 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[storage_agent]}; do if [[ -z ${properties[$key$INDEX]} ]]; then properties[$key$INDEX]="" fi done (( 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_storage_agent_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_storage_agent_attributes =head1 VERSION Version Number: 1.10 Last Extracted: 6/16/15 17:51:09 Last Changed: 6/1/15 14:47:22 Path, Component, Release(, Level): src/43haes/lib/ksh93/hacmp/KLIB_HACMP_get_storage_agent_attributes.sh, hacmp.assist, 61haes_r720, 1525A_hacmp720 =head1 SYNOPSIS clmgr query storage_agent [,,...] clmgr -v query storage_agent NOTE: the alias for "storage_agent" is "sta". =head1 DESCRIPTION Retrieves the configuration data for one or more PowerHA SystemMirror storage agents. =head1 ARGUMENTS 1. storage_agent [REQUIRED] [string] The label of one or more storage_agents (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 #==============================================================================