#!/bin/ksh93
# IBM_PROLOG_BEGIN_TAG 
# This is an automatically generated prolog. 
#  
# 61haes_r714 src/43haes/lib/ksh93/hacmp/KLIB_HACMP_refresh_mirror_group.sh 1.1 
#  
# Licensed Materials - Property of IBM 
#  
# Restricted Materials of IBM 
#  
# COPYRIGHT International Business Machines Corp. 2012 
# 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 

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

=head1 NAME

 KLIB_HACMP_refresh_mirror_group

=head1 VERSION

 Version Number:  1.4
 Last Extracted:  10/18/12 17:50:40
 Last Changed:    10/8/12 12:21:43

 Path, Component, Release(, Level):
 src/43haes/lib/ksh93/hacmp/KLIB_HACMP_refresh_mirror_group.sh, hacmp.assist, 61haes_r712, 1242B_hacmp712

=head1 SYNOPSIS

 clmgr refresh mirror_group <mirror_group_name>[,<mg#2>,...] \
             [ NODE=<node_name> ]
 clmgr refresh mirror_group \
             NODES=<node_name>[,<node#2>,...] \
             [ SYSTEM_GROUPS={yes|no} ]
 clmgr refresh mirror_group \
             SITE=<site_name>[,<site#2>] \
             [ SYSTEM_GROUPS={yes|no} ]
             [ REPOSITORY_GROUP={yes|no} ]

 NOTE: the "refresh" action is only valid for DS-Series
       Inband (HyperSwap)
 NOTE: the alias for "mirror_group" is "mig".

=head1 DESCRIPTION

 Attempts to refresh the specified HyperSwap mirror groups.

=head1 ARGUMENTS

 1. mirror_groups [OPTIONAL] [string]
    One or more HyperSwap mirror groups to refresh.

 2. nodes [OPTIONAL] [string]
    The label of one or more cluster nodes.

 3. sites [OPTIONAL] [string]
    The label of one or more cluster sites.

 4. system_groups [OPTIONAL] [boolean]
    Indicates whether or not to include system mirror groups
    in the refresh. Defaults to "yes".

 5. repository_group [OPTIONAL] [boolean]
    Indicates whether or not to include the repository mirror
    group in the refresh. Defaults to "yes".

=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_refresh_mirror_group {
    LINENO=2 . $HALIBROOT/log_entry "$0()" "$CL"
    : version=1.4, src/43haes/lib/ksh93/hacmp/KLIB_HACMP_refresh_mirror_group.sh, hacmp.assist, 61haes_r712, 1242B_hacmp712
    : INPUTS: $*
    [[ $CLMGR_LOGGING == 'med' ]] && set +x  # Only trace param values

    CL=$LINENO OPERATION="refresh" KLIB_HACMP_replace_mirror_group "$@"
    log_return_msg "$?" "$0()" "$LINENO"
    return $?
} # End of "KLIB_HACMP_refresh_mirror_group()"