#!/bin/ksh93
# IBM_PROLOG_BEGIN_TAG 
# This is an automatically generated prolog. 
#  
# 61haes_r714 src/43haes/lib/ksh93/hacmp/KLIB_HACMP_move_persistent_ip.sh 1.3 
#  
# Licensed Materials - Property of IBM 
#  
# COPYRIGHT International Business Machines Corp. 1990,2010 
# 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 
# @(#)57	1.3  src/43haes/lib/ksh93/hacmp/KLIB_HACMP_move_persistent_ip.sh, hacmp.assist, 61haes_r714 6/10/12 15:48:34

# 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_move_persistent_ip

=head1 VERSION

 Version Number:  1.3
 Last Extracted:  1/31/14 04:41:25
 Last Changed:    6/10/12 15:48:34

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

=head1 SYNOPSIS

 clmgr move persistent_ip <persistent_IP> \
             INTERFACE=<new_interface>

 NOTE: the alias for "persistent_ip" is "pe".

=head1 DESCRIPTION

Attempts to move the specified persistent address from its current
interface to the specified new interface.

=head1 ARGUMENTS

 1. service_ip [REQUIRED] [string]
    The name of the service IP to be moved.

 2. new_interface [REQUIRED] [string]
    The name of an interface to move the service IP to.

=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_move_persistent_ip {
    LINENO=2 . $HALIBROOT/log_entry "$0()" "$CL"
    : version=1.3, src/43haes/lib/ksh93/hacmp/KLIB_HACMP_move_persistent_ip.sh, hacmp.assist, 61haes_r714
    : INPUTS: $*

    typeset persistent_ip=${1//\"/}
    typeset new_interface=${2//\"/}

    [[ $CLMGR_LOGGING == 'med' ]] && set +x  # Only trace param values

    #===================================
    : Declare and initialize variables
    #===================================
    typeset -i rc=$RC_UNKNOWN
    typeset -i i=0
    typeset -A properties
    
    #==========================================================================
    : Verify that each specified object exists before attempting the operation
    #==========================================================================
    if [[ $persistent_ip != *([[:space:]]) ]]; then
        CL=$LINENO KLIB_HACMP_is_known_persistent_ip "$persistent_ip" >/dev/null 2>&1
        if (( $? != RC_SUCCESS )); then
            /usr/bin/dspmsg -s $CLVT_SET $CLVT_MSGS 102 "\nERROR: \"%1\$s\" does not appear to exist!\n\n" "$persistent_ip" 1>&2
            rc=$RC_NOT_FOUND
        fi
    fi

    #================================================================
    : Check for a defined cluster. No need to continue without one.
    #================================================================
    CL=$LINENO isClusterDefined
    if (( $? != RC_SUCCESS )); then
        rc=$RC_MISSING_DEPENDENCY

    #=================
    : Validate input
    #=================
    elif [[ $persistent_ip == *([[:space:]]) ]]; then
        /usr/bin/dspmsg -s $CLVT_SET $CLVT_MSGS 100 "\nERROR: a name/label must be provided.\n\n" 1>&2
        rc=$RC_MISSING_INPUT

    elif (( $rc == RC_NOT_FOUND )); then # The specified object was unrecognized
        /usr/bin/dspmsg -s $CLVT_SET $CLVT_MSGS 152 "Available Persistent Node IPs:\n\n" 1>&2

        typeset available
        CL=$LINENO KLIB_HACMP_list_persistent_ip available
        for (( i=0; i<${#available[*]}; i++ )); do
            if [[ ${available[$i]} != *([[:space:]]) ]]; then
                print -u2 "\t${available[$i]}"
            fi
        done
        print -u2 ""

    elif [[ $new_interface == *([[:space:]]) ]]; then
        /usr/bin/dspmsg -s $CLVT_SET $CLVT_MSGS 101 "\nERROR: this operation requires the \"%1\$s\" attribute.\n\n" INTERFACE 1>&2
        rc=$RC_MISSING_INPUT
    fi

    #===============================================================
    : Move the persistent IP if no input errors have been detected
    #===============================================================
    if (( $rc == RC_UNKNOWN )); then
        CL=$LINENO KLIB_HACMP_get_persistent_ip_attributes "$persistent_ip" properties

        #============================================================
        : This operation requires an IP address or label... not an
        : interface name, such as "en3". In testing this has proven
        : very confusing for new users. So an attempt is made here
        : to automatically convery any "en#" specifications to a
        : suitable IP address.
        #============================================================
        if [[ $new_interface == en+([[:digit:]]) ]]; then
            /usr/sbin/lsattr -El $new_interface 1>/dev/null 2>>$CLMGR_TMPLOG
            if (( $? == RC_SUCCESS )); then
                typeset -A IFs
                CL=$LINENO get_interfaces IFs "${properties[NODE]}" "$new_interface"
                if (( ${#IFs[*]} > 0 )); then
                    if [[ ${IFs[$new_interface]} != *([[:space:]]) ]]; then
                        new_interface=${IFs[$new_interface]}
                        new_interface=${new_interface%%+([[:space:]])*}
                    else
                        /usr/bin/dspmsg -s $CLVT_SET $CLVT_MSGS 611 "\nERROR: no usable IP addresses were found on interface \"%1\$s\".\n\n" "$new_interface" 1>&2
                        rc=$RC_INCORRECT_INPUT
                    fi
                fi
            fi
        fi

        if (( $rc == RC_UNKNOWN )); then
            print "$0()[$LINENO]($SECONDS): $HAUTILS/clswapaddress \"${properties[NETWORK]}\" \"$persistent_ip\" \"$new_interface\"" >>$CLMGR_TMPLOG  # Always log commands
            $HAUTILS/clswapaddress "${properties[NETWORK]}" \
                                   "$persistent_ip" \
                                   "$new_interface"
            rc=$?
            print "clswapaddress RC: $rc" >>$CLMGR_TMPLOG  # Always log command result
            if (( $rc != RC_SUCCESS )); then
                /usr/bin/dspmsg -s $CLVT_SET $CLVT_MSGS 128 "\nERROR: failed to move \"%1\$s\" to \"%2\$s\".\n\n" "$persistent_ip" "$new_interface" 1>&2
                rc=$RC_ERROR
            fi
        fi
    fi

    #=======================================================================
    : If a user input error was detected, provide some helpful suggestions
    #=======================================================================
    if (( $rc == RC_MISSING_INPUT || $rc == RC_INCORRECT_INPUT )) && \
       [[ $CLVT_GUI == *([[:space:]]) ]]
    then
        CL=$LINENO cl_dspmsg -s $CLVT_SET $CLVT_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" \
        "move persistent_ip -h" "PERSISTENT IP/LABEL:" "$CLVT_PROGNAME" 1>&2
    fi

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