ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/clust1a5.htm

103 lines
3.8 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>Using Results Information</title>
<!-- Begin Header Records ========================================== -->
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- CLUST1A SCRIPT A converted by B2H R4.1 (346) (CMS) by NLJONES at -->
<!-- RCHVMX on 24 Feb 1999 at 15:32:00 -->
<!-- End Header Records -->
<!-- -->
<!-- -->
<!-- -->
<!-- Begin Developer Note ========================================== -->
<!-- NOTE: If you are adding, changing, or removing ANY requirements -->
<!-- for this API chance are good that the GUI code need to change -->
<!-- also. The Cluster GUI code is built on top of this API and it -->
<!-- does a certain amount of explicit and implicit validation -->
<!-- checking of user data prior to the API call being made. Please -->
<!-- have the Cluster GUI developer check the -->
<!--/as400/v5r4m0.guix/cur/cmvc/java.pgm/ugcl.guix/com/ibm/as400/opnav/ugcl/ClGuiActionsManager.java/ClGuiActionsManager.java -->
<!-- part to determine if any Cluster GUI code changes are needed. -->
<!-- End Developer Note -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<!--Java sync-link -->
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<a name="Top_Of_Page"></a>
<h2>Using Results Information</h2>
<p>Messages placed on the user queue should be handled by user written
programs. The messages will indicate the results of the function requested by
the API. There are three classes of completion results:</p>
<ul>
<li>Successful - The request completed successfully on all nodes that performed
the function.</li>
<li>Partially Successful - The request did not complete successfully on all of
the nodes that performed the function. In some instances, partial success is
caused by one or more nodes in an inactive state. The user program needs to
determine if a partially successful operation is considered successful or
unsuccessful.</li>
<li>Unsuccessful - The request failed on all nodes that performed the
function.</li>
</ul>
<p>Results that are partially successful or unsuccessful will have diagnostic
or informational messages describing the causes of failure and the node that
failed to process the request. See the description of each API for the possible
messages returned to the user queue.</p>
<br>
<h3><a name="Header_10">General Information Applicable to Cluster APIs</a></h3>
<p>The following parameters on Cluster APIs must be valid object names and uppercase only:</p>
<ul>
<li>Node ID</li>
<li>Cluster name</li>
<li>Cluster resource group name</li>
<li>Job name specified for an application cluster resource group</li>
<li>Device domain name</li>
<li>Site name</li>
</ul>
<p>To qualify as a valid object
name, the first character must be alphabetic (A-Z) or one of the special
characters, $, @, or #. The remaining characters are the same as the first
character, but can also include 0 through 9, underscores and periods.</p>
<br>
<hr>
<center>
<table cellpadding="2" cellspacing="20">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"clust1.htm">Cluster APIs</a> | <a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</center>
</body>
</html>