#!/bin/ksh93 # IBM_PROLOG_BEGIN_TAG # This is an automatically generated prolog. # # 61haes_r714 src/43haes/lib/ksh93/hacmp/KLIB_HACMP_add_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 # @(#)91 1.6 src/43haes/lib/ksh93/hacmp/KLIB_HACMP_add_storage_agent.sh, hacmp.assist, 61haes_r714 8/6/13 16:54:58 #================================================ # The following, commented line enforces coding # standards when this file is edited via vim. #================================================ # vim:tabstop=4:shiftwidth=4:expandtab:smarttab #================================================ # Start of POD-formatted documentation. Viewing suggestions: # perldoc # pod2text -c # pod2text -c --code # pod2html function devDoc { : <<'=cut' >/dev/null 2>&1 =head1 NAME KLIB_HACMP_add_storage_agent =head1 VERSION Version Number: 1.6 Last Extracted: 1/31/14 04:41:41 Last Changed: 8/6/13 16:54:58 Path, Component, Release(, Level): src/43haes/lib/ksh93/hacmp/KLIB_HACMP_add_storage_agent.sh, hacmp.assist, 61haes_r714 =head1 SYNOPSIS clmgr add storage_agent \ TYPE={ds8k_gm|xiv_rm} \ ADDRESSES=[,...] \ [ USER= ] \ [ PASSWORD= ] \ [ ATTRIBUTES=@[,@,...] ] NOTE: the alias for "storage_agent" is "sta". =head1 DESCRIPTION Attempts to create a new 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. agent_name [REQUIRED] [string] The label that is to be applied to this storage agent. 3. type [REQUIRED] [set] The type of storage technology that this storage agent will be working with, from the set ds8k_gm and xiv_rm. 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_add_storage_agent { LINENO=2 . $HALIBROOT/log_entry "$0()" "$CL" : version=1.6, src/43haes/lib/ksh93/hacmp/KLIB_HACMP_add_storage_agent.sh, hacmp.assist, 61haes_r714 : INPUTS: $* typeset -n properties=$1 typeset storage_agent=${2//\"/} typeset -l type=${3//\"/} typeset addresses=${4//\"/} typeset user=${5//\"/} typeset password=${6//\"/} typeset attributes=${7//\"/} [[ $CLMGR_LOGGING == 'med' ]] && set +x # Only trace param values 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 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 229 "\nERROR: the specified object already exists: \"%1\$s\"\n\n" "$storage_agent" 1>&2 rc=$RC_INCORRECT_INPUT fi if [[ -z $type ]]; then /usr/bin/dspmsg -s $CLMGR_SET $CLMGR_MSGS 101 "\nERROR: this operation requires the \"%1\$s\" attribute.\n\n" TYPE 1>&2 rc=$RC_MISSING_INPUT else case $type in *8*g*) type=ds8k_gm ;; x*) type=xiv_rm ;; *) /usr/bin/dspmsg -s $CLMGR_SET $CLMGR_MSGS 110 "\nERROR: invalid value specified for \"%1\$s\": \"%2\$s\".\n" TYPE "$type" 1>&2 print -u2 "" /usr/bin/dspmsg -s $CLMGR_SET $CLMGR_MSGS 3 "Valid values: %1\$s\n\n" "ds8k_gm, xiv_rm" 1>&2 rc=$RC_INCORRECT_INPUT ;; esac fi if [[ -z $addresses ]]; then /usr/bin/dspmsg -s $CLMGR_SET $CLMGR_MSGS 101 "\nERROR: this operation requires the \"%1\$s\" attribute.\n\n" ADDRESSES 1>&2 rc=$RC_MISSING_INPUT fi if [[ $user == *([[:space:]]) && $password != *([[:space:]]) ]]; then password="" fi #================================== : Check for external dependencies #================================== case $type in ds8k_gm) if [[ ! -f "/opt/ibm/dscli/dscli" ]]; then CL=$LINENO cl_dspmsg -s $CLMGR_SET $CLMGR_MSGS 9999 '\nERROR: the DSCLI utility was not found in its expected location, "/opt/ibm/dscli/dscli". DSCLI is required, and must be installed in that location on all cluster nodes.\n\n' 1>&2 rc=$RC_MISSING_DEPENDENCY fi ;; xiv_rm) if [[ ! -f "/opt/xiv/XIVGUI/xcli" ]]; then CL=$LINENO cl_dspmsg -s $CLMGR_SET $CLMGR_MSGS 9999 '\nERROR: the XIV CLI utility was not found in its expected location, "/opt/xiv/XIVGUI/xcli". The XIV CLI is required, and must be installed in that location on all cluster nodes.\n\n' 1>&2 rc=$RC_MISSING_DEPENDENCY fi ;; esac #================================================================= : Create the storage agent if no input errors have been detected #================================================================= if (( $rc == RC_UNKNOWN )); then typeset userOpt="" pswdOpt="" attrsOpt="" [[ $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_create_sa_director -n $storage_agent -s $type -i $addresses$userOpt$pswdOpt$attrsOpt" >>$CLMGR_TMPLOG # Always log commands $HAXDWIZ/clxd_create_sa_director -n $storage_agent -s $type -i $addresses$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 201 "\nERROR: failed to create \"%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_add_storage_agent()"