248 lines
10 KiB
HTML
248 lines
10 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>Cluster Control APIs</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. -->
|
|
<!-- CLUST2A SCRIPT A converted by B2H R4.1 (346) (CMS) by NLJONES at -->
|
|
<!-- RCHVMX on 24 Feb 1999 at 17:15:51 -->
|
|
<!-- 031106 JETAYLOR replaced API and/or Exit listings with -->
|
|
<!-- pagegenerator output from javascript array -->
|
|
<!-- 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>Cluster Control APIs</h2>
|
|
|
|
<p>The cluster control APIs provide configuration, activation, and management
|
|
functions for the cluster and nodes in the cluster.</p>
|
|
|
|
<p>For additional information, see:</p>
|
|
|
|
<ul>
|
|
<li><a href="#header_2">Network Attributes</a></li>
|
|
|
|
<li><a href="#header_3">Cluster Node Status</a></li>
|
|
</ul>
|
|
|
|
<p>The cluster control APIs are:</p>
|
|
<!-- ***** NOTE ***** Do not manually update text or links in this section. -->
|
|
<!-- Updates made in this section *will* be overlaid by automated tools -->
|
|
<!-- Notify User Technologies of needed updates to be made in XML for API finder.-->
|
|
<!--***************API BEGIN PASTE***************-->
|
|
<ul>
|
|
<li><A HREF="clcntaddcne.htm">Add Cluster Node Entry</A> (QcstAddClusterNodeEntry) adds a node to the membership list of an existing cluster.</li>
|
|
<li><A HREF="clcntadddde.htm">Add Device Domain Entry</A> (QcstAddDeviceDomainEntry) adds a node entry to the membership list of a device domain.</li>
|
|
<li><A HREF="clcntchgcv.htm">Adjust Cluster Version</A> (QcstAdjustClusterVersion) adjusts the current cluster version.</li>
|
|
<li><A HREF="clcntchgcne.htm">Change Cluster Node Entry</A> (QcstChangeClusterNodeEntry) changes the fields in the cluster node entry.</li>
|
|
<li><A HREF="clcntchgcrs.htm">Change Cluster Resource Services</A> (QcstChgClusterResourceServices) tunes cluster performance and configuration parameters.</li>
|
|
<li><A HREF="clcntcrtc.htm">Create Cluster</A> (QcstCreateCluster) creates a new cluster of one or more nodes.</li>
|
|
<li><A HREF="clcntdltc.htm">Delete Cluster</A> (QcstDeleteCluster) deletes a cluster previously created by the Create Cluster API.</li>
|
|
<li><A HREF="clcntendcn.htm">End Cluster Node</A> (QcstEndClusterNode) ends Cluster Resource Services on one or all nodes in the cluster.</li>
|
|
<li><A HREF="clcntlstci.htm">List Cluster Information</A> (QcstListClusterInfo) retrieves information about a cluster.</li>
|
|
<li><A HREF="clcntlstddi.htm">List Device Domain Information</A> (QcstListDeviceDomainInfo) lists device domain information of a cluster.</li>
|
|
<li><A HREF="clcntrmvcne.htm">Remove Cluster Node Entry</A> (QcstRemoveClusterNodeEntry) removes a node from a cluster.</li>
|
|
<li><A HREF="clcntrmvdde.htm">Remove Device Domain Entry</A> (QcstRemoveDeviceDomainEntry) removes a node entry from the membership list of a device domain.</li>
|
|
<li><A HREF="clcntrtvci.htm">Retrieve Cluster Information</A> (QcstRetrieveClusterInfo) retrieves information about a cluster.</li>
|
|
<li><A HREF="clcntrtcrs.htm">Retrieve Cluster Resource Services Information</A> (QcstRetrieveCRSInfo) retrieves information about Cluster Resource Services parameters.</li>
|
|
<li><A HREF="clcntstcn.htm">Start Cluster Node</A> (QcstStartClusterNode) starts Cluster Resource Services on a node in the cluster.</li>
|
|
</ul>
|
|
<!--***************API END PASTE***************-->
|
|
|
|
<p>When a partition is detected, some APIs cannot be run in any of the partitions
|
|
and some other APIs may be run in any partition. However, the action performed
|
|
by the API will take effect only in the partition running the API. The
|
|
restrictions for each API are:</p>
|
|
|
|
<dl>
|
|
<dt><strong>Add Cluster Node Entry</strong></dt>
|
|
|
|
<dd>Not allowed in any partition.</dd>
|
|
|
|
<dt><strong>Add Device Domain Entry</strong></dt>
|
|
|
|
<dd>Only allowed for existing device domain where all members are in the same
|
|
partition.</dd>
|
|
|
|
<dt><strong>Adjust Cluster Version</strong></dt>
|
|
|
|
<dd>Not allowed in any partition.</dd>
|
|
|
|
<dt><strong>Change Cluster Node Entry</strong></dt>
|
|
|
|
<dd>To change cluster interface addresses, allowed only within the same
|
|
partition. To change node status, allowed only in partition containing the
|
|
non-failed nodes.</dd>
|
|
|
|
<dt><strong>Change Cluster Resource Services</strong></dt>
|
|
|
|
<dd>Allowed in any partition.</dd>
|
|
|
|
<dt><strong>Create Cluster</strong></dt>
|
|
|
|
<dd>Not allowed in any partition.</dd>
|
|
|
|
<dt><strong>Delete Cluster</strong></dt>
|
|
|
|
<dd>Allowed in any partition.</dd>
|
|
|
|
<dt><strong>End Cluster Node</strong></dt>
|
|
|
|
<dd>Allowed within the same partition as the node being ended.</dd>
|
|
|
|
<dt><strong>List Cluster Information</strong></dt>
|
|
|
|
<dd>Allowed in any partition.</dd>
|
|
|
|
<dt><strong>List Device Domain Information</strong></dt>
|
|
|
|
<dd>Allowed in any partition.</dd>
|
|
|
|
<dt><strong>Remove Cluster Node Entry</strong></dt>
|
|
|
|
<dd>Allowed in any partition.</dd>
|
|
|
|
<dt><strong>Remove Device Domain Entry</strong></dt>
|
|
|
|
<dd>Only allowed if all members are in the same partition.</dd>
|
|
|
|
<dt><strong>Retrieve Cluster Information</strong></dt>
|
|
|
|
<dd>Allowed in any partition.</dd>
|
|
|
|
<dt><strong>Retrieve Cluster Resource Services Information</strong></dt>
|
|
|
|
<dd>Allowed in any partition.</dd>
|
|
|
|
<dt><strong>Start Cluster Node</strong></dt>
|
|
|
|
<dd>Allowed in any partition.</dd>
|
|
</dl>
|
|
|
|
<h2><a name="header_2">Network Attributes</a></h2>
|
|
|
|
<p>A network attribute is used to control cluster access within a network. The
|
|
network attribute is ALWADDCLU (Allow Add to Cluster). This attribute can be
|
|
set as follows:</p>
|
|
|
|
<ul compact>
|
|
<li>*NONE - The system cannot be added to any cluster.</li>
|
|
|
|
<li>*ANY - The system will be added to a cluster without verification.</li>
|
|
|
|
<li>*RQSAUT - The system will be added to a cluster pending successful
|
|
verification through digital certificate exchange.</li>
|
|
</ul>
|
|
|
|
The default value is *NONE. If *RQSAUT is specified,
|
|
<img src="delta.gif" alt="Start of change">
|
|
see
|
|
<a href="..//rzain/rzainplanssl.htm">
|
|
SSL</a> for software which must be installed on the systems.
|
|
<img src="deltaend.gif" alt="End of change">
|
|
|
|
|
|
<h2><a name="header_3">Cluster Node Status</a></h2>
|
|
|
|
<p>Each cluster node has a status associated with it. The status of a cluster
|
|
node may govern the behavior of a particular API call. See the individual API
|
|
descriptions for more details. The possible values are:</p>
|
|
|
|
<dl>
|
|
<dt>1</dt>
|
|
|
|
<dd><strong>New.</strong> A node has been added to the cluster membership list
|
|
but the Cluster Resource Services has never been started on that node. The
|
|
Cluster Resource Service data structures have not been created on the node.
|
|
During a Create Cluster operation, the Cluster Resource Service data structures
|
|
will be created only on the node running the Create Cluster API.</dd>
|
|
|
|
<dt>2</dt>
|
|
|
|
<dd><strong>Active.</strong> The node has been started either with the Create
|
|
Cluster API or Add Cluster Node Entry API with the "Start indicator" parameter
|
|
set to 1, or with the Start Cluster Node API. Cluster Resource Services is
|
|
active on the node .</dd>
|
|
|
|
<dt>3</dt>
|
|
|
|
<dd><strong>Remove Pending.</strong> The node is in the process of being
|
|
removed from the cluster membership list as the result of a Remove Cluster Node
|
|
Entry API.</dd>
|
|
|
|
<dt>4</dt>
|
|
|
|
<dd><strong>Active Pending.</strong> The node is in the process of being
|
|
started either as the result of a Create Cluster API or Add Cluster Node Entry
|
|
API call with the "Start indicator" parameter set to 1 or because of a Start
|
|
Cluster Node API call. In addition, the node could have previously had a status
|
|
of Partition and will change to the Active Pending status as a result of the
|
|
partitions being merged.</dd>
|
|
|
|
<dt>5</dt>
|
|
|
|
<dd><strong>Inactive Pending.</strong> Cluster Resource Services is in the
|
|
process of ending on this node as the result of an End Cluster Node API call.
|
|
The node is still in the cluster membership list.</dd>
|
|
|
|
<dt>6</dt>
|
|
|
|
<dd><strong>Inactive.</strong> Cluster Resource Services has been ended on the
|
|
node as the result of an End Cluster Node API call. The node is still in the
|
|
cluster membership list, but is no longer communicating with other nodes in the
|
|
cluster.</dd>
|
|
|
|
<dt>7</dt>
|
|
|
|
<dd><strong>Failed.</strong> A previously active node has failed. A failure is
|
|
defined to be a system or clustering failure detected by Cluster Resource
|
|
Services.</dd>
|
|
|
|
<dt>8</dt>
|
|
|
|
<dd><strong>Partition.</strong> The node is only communicating with a subset of
|
|
the cluster due to a network failure detected by Cluster Resource Services
|
|
which has resulted in the loss of communications to one or more nodes in the
|
|
cluster. Once the partitioned nodes have been merged back into a whole cluster,
|
|
the node will change to Active status without operator intervention. Of course,
|
|
any node that had a status of Failed in any partition will still have a status
|
|
of Failed after the merge.</dd>
|
|
</dl>
|
|
|
|
<hr>
|
|
<center>
|
|
<table cellpadding="2" cellspacing="2">
|
|
<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>
|
|
|