#!/bin/ksh93 # IBM_PROLOG_BEGIN_TAG # This is an automatically generated prolog. # # 61haes_r720 src/43haes/lib/ksh93/hacmp/KLIB_HACMP_list_ldap_servers.sh 1.4 # # 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 # @(#)13 1.4 src/43haes/lib/ksh93/hacmp/KLIB_HACMP_list_ldap_servers.sh, hacmp.assist, 61haes_r720, 1525A_hacmp720 6/11/15 09:56:17 #============================================================================ # # Name: KLIB_HACMP_list_ldap_servers # # Description: This is the main, FPATH function that is invoked by clmgr # to collect LDAP server names. It uses the "clodmget" utility # to retrieve data from the HACMPLDAP ODM to generate the list # of LDAP server names unless a search is being conducted. # In the case of a search, the associated FPATH function, # KLIB_HACMP_get_ldap_server_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 LDAP server 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_ldap_servers { LINENO=2 . $HALIBROOT/log_entry "$0()" "$CL" : version=1.4, src/43haes/lib/ksh93/hacmp/KLIB_HACMP_list_ldap_servers.sh, hacmp.assist, 61haes_r720, 1525A_hacmp720 : INPUTS: $* typeset -n list=$1 shift [[ $CLMGR_LOGGING == 'med' ]] && set +x # Only trace param values #================================================================ : Check for a defined cluster. No need to continue without one. #================================================================ CL=$LINENO isClusterDefined if (( $? != RC_SUCCESS )); then log_return_msg "$RC_MISSING_DEPENDENCY" "$0()" "$LINENO" return $? fi #=================================== : Declare and initialize variables #=================================== typeset -A queries typeset -u attr= typeset LINE= OUTPUT= value= typeset -i index=0 matches=0 rc=$RC_UNKNOWN #=================================================== : 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 print "$0()[$LINENO]($SECONDS): clodmget -q \"group=LDAPServer and name=ServerList\" -f value HACMPLDAP" >>$CLMGR_TMPLOG # Always log commands OUTPUT=$(clodmget -q "group=LDAPServer and name=ServerList" -f value HACMPLDAP 2>/dev/null) rc=$? print "$0()[$LINENO]($SECONDS): clodmget RC: $rc; ldap_servers == \"${OUTPUT//+([[:space:]])/, }\"" >>$CLMGR_TMPLOG # Always log command result (( $rc != RC_SUCCESS )) && rc=$RC_ERROR print -- "$OUTPUT" |\ while read LINE; do LINE=${LINE//\"/} LINE=${LINE##+([[:space:]])} LINE=${LINE%%+([[:space:]])} for SERVER in ${LINE//,/ }; do if [[ -n $SERVER ]]; then list[$index]=$SERVER (( index++ )) fi done done else # A search was specified typeset -A allProperties CL=$LINENO CLMGR_VERBOSE=1 KLIB_HACMP_get_ldap_server_attributes allProperties CL=$LINENO search_properties queries allProperties rc=$? if (( $rc == RC_SUCCESS )); then for key in ${!allProperties[*]}; do [[ $key != SERVERS@(|+([0-9])) ]] && continue for NAME in ${allProperties[$key]//,/ }; do list[$index]=$NAME (( index++ )) done done fi fi log_return_msg "$rc" "$0()" "$LINENO" return $? } # End of "KLIB_HACMP_list_ldap_servers()" #============================================================================ # # 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_ldap_servers =head1 VERSION Version Number: 1.4 Last Extracted: 6/16/15 17:51:13 Last Changed: 6/11/15 09:56:17 Path, Component, Release(, Level): src/43haes/lib/ksh93/hacmp/KLIB_HACMP_list_ldap_servers.sh, hacmp.assist, 61haes_r720, 1525A_hacmp720 =head1 SYNOPSIS clmgr query ldap_server NOTE: the alias for "ldap_server" is "ls". =head1 DESCRIPTION Displays the current set of AIX LDAP servers. =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. 2011,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 #==============================================================================