#!/bin/ksh93
# IBM_PROLOG_BEGIN_TAG 
# This is an automatically generated prolog. 
#  
# 61haes_r714 src/43haes/lib/ksh93/hacmp/KLIB_HACMP_modify_storage_agent.sh 1.6 
#  
# Licensed Materials - Property of IBM 
#  
# COPYRIGHT International Business Machines Corp. 2011 
# 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 
# @(#)46	1.6  src/43haes/lib/ksh93/hacmp/KLIB_HACMP_modify_storage_agent.sh, hacmp.assist, 61haes_r714 12/3/12 09:10:01

# Start of POD-formatted documentation. Viewing suggestions:
#      perldoc <FILENAME>
#      pod2text -c <FILENAME>
#      pod2text -c --code <FILENAME>
#      pod2html <FILENAME>
function devDoc {
    : <<'=cut' >/dev/null 2>&1

=head1 NAME

 KLIB_HACMP_modify_storage_agent

=head1 VERSION

 Version Number:  1.6
 Last Extracted:  1/31/14 04:41:03
 Last Changed:    12/3/12 09:10:01

 Path, Component, Release(, Level):
 src/43haes/lib/ksh93/hacmp/KLIB_HACMP_modify_storage_agent.sh, hacmp.assist, 61haes_r714

=head1 SYNOPSIS

 clmgr modify storage_agent <agent_name> \
             [ NAME=<new_agent_name> ] \
             [ ADDRESSES=<IP>[<IP#2>,...] ] \
             [ USER=<user_id> ] \
             [ PASSWORD=<password> ] \
             [ ATTRIBUTES=<NAME>@<VALUE>[,<NAME#2>@<VALUE#2>,...] ]

 NOTE: the alias for "storage_agent" is "sta".

=head1 DESCRIPTION

Attempts to modify a storage agent.

=head1 ARGUMENTS

 1. properties [REQUIRED] [hash ref]
    An associative array within which data about the
    created object can be returned to the caller.

 2. storage_agent [REQUIRED] [string]
    The label of the object to be modified.

 3. new_name [REQUIRED] [set]
    A new label to apply to this object

 4. addresses  [OPTIONAL] [string]
    One or more (maximum of 4) IP addresses to be associated with this
    storage agent.

 5. user [OPTIONAL] [string]
    The user ID to be used for communication with this storage agent.

 6. password [OPTIONAL] [string]
    The password that is to be used with the provided user ID.

 7. attributes [OPTIONAL] [string]
    One or more storage-specific configuration attributes.

=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. 2005,2010
All Rights Reserved

=cut
} # End of POD-formatted documentation.


function KLIB_HACMP_modify_storage_agent {
    LINENO=2 . $HALIBROOT/log_entry "$0()" "$CL"
    : version=1.6, src/43haes/lib/ksh93/hacmp/KLIB_HACMP_modify_storage_agent.sh, hacmp.assist, 61haes_r714
    : INPUTS: $*

    typeset -n properties=$1
    typeset storage_agent=${2//\"/}
    typeset new_name=${3//\"/}
    typeset addresses=${4//\"/}
    typeset user=${5//\"/}
    typeset password=${6//\"/}
    typeset attributes=${7//\"/}

    [[ $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

    CL=$LINENO isEnterprise
    if (( $? != 1 )); then
        CL=$LINENO 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
    #===================================
    typeset -i rc=$RC_UNKNOWN
    typeset -A saAttrs
    CL=$LINENO KLIB_HACMP_get_storage_agent_attributes "$storage_agent" saAttrs
    typeset type=${saAttrs[TYPE]}

    typeset existing
    CL=$LINENO KLIB_HACMP_list_storage_agents existing 2>>$CLMGR_TMPLOG

    #=================
    : Validate input
    #=================
    if [[ -z $storage_agent ]]; then
        /usr/bin/dspmsg -s $CLMGR_SET $CLMGR_MSGS 100 "\nERROR: a name/label must be provided.\n\n" 1>&2
        rc=$RC_MISSING_INPUT

    elif [[ " ${existing[*]} " != *\ $storage_agent\ * ]]; then
        /usr/bin/dspmsg -s $CLMGR_SET $CLMGR_MSGS 102 "\nERROR: \"%1\$s\" does not appear to exist!\n\n" "$storage_agent" 1>&2
        /usr/bin/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
    fi

    #=================================================================
    : Create the storage agent if no input errors have been detected
    #=================================================================
    if (( $rc == RC_UNKNOWN )); then
        typeset nameOpt= addrOpt= userOpt= pswdOpt= attrsOpt=

        [[ $new_name  != *([[:space:]]) ]] && nameOpt=" -N $new_name"
        [[ $addresses != *([[:space:]]) ]] && addrOpt=" -i $addresses"
        [[ $user      != *([[:space:]]) ]] && userOpt=" -u $user"
        [[ $password  != *([[:space:]]) ]] && pswdOpt=" -p $password"

        if [[ -n $attributes ]]; then
            for pair in ${attributes//,/ }; do
                attrsOpt="$attrsOpt -o${pair//@/ }"
            done
        fi

        print -- "$0()[$LINENO]($SECONDS): $HAXDWIZ/clxd_change_sa_director -n $storage_agent -s $type$nameOpt$addrOpt$userOpt$pswdOpt$attrsOpt" >>$CLMGR_TMPLOG  # Always log commands
        $HAXDWIZ/clxd_change_sa_director -n $storage_agent -s $type$nameOpt$addrOpt$userOpt$pswdOpt$attrsOpt

        rc=$?
        print "$0()[$LINENO]($SECONDS): clxd_create_sa_director RC: $rc" >>$CLMGR_TMPLOG  # Always log command result

        if (( $rc != RC_SUCCESS )); then
            /usr/bin/dspmsg -s $CLMGR_SET $CLMGR_MSGS 400 "\nERROR: failed to modify \"%1\$s\".\n\n" "$storage_agent" 1>&2
            rc=$RC_ERROR
        fi

        #===========================================================
        : If output from this operation was requested, retrieve it
        #===========================================================
        if (( $rc == RC_SUCCESS )); then
            if (( CLMGR_VERBOSE )) || [[ -n $CLMGR_ATTRS ]]; then
                CL=$LINENO KLIB_HACMP_get_storage_agent_attributes "$storage_agent" properties
            fi
        fi
    fi

    #=======================================================================
    : If a user input error was detected, provide some helpful suggestions
    #=======================================================================
    if (( $rc == RC_MISSING_INPUT || $rc == RC_INCORRECT_INPUT )) && \
       [[ $CLMGR_GUI == *([[:space:]]) ]]
    then
        CL=$LINENO cl_dspmsg -s $CLMGR_SET $CLMGR_MSGS 104 "For more information about available options and syntax, try\n\"$HAUTILS/clmgr %1\$s\". As an\nalternative, if the PowerHA SystemMirror man pages have been installed, invoke\n\"$HAUTILS/clmgr -hv\" (or \"/usr/bin/man clmgr\"),\nsearching for \"%2\$s\" in the displayed text.\n\n" \
        "add storage_agent -h" "STORAGE AGENT:" "$CLMGR_PROGNAME" 1>&2
    fi

    log_return_msg "$rc" "$0()" "$LINENO"
    return $?
} # End of "KLIB_HACMP_modify_storage_agent()"