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

767 lines
23 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>Change Cluster Node Entry (QcstChangeClusterNodeEntry) API</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. -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- CLUST2A SCRIPT A converted by B2H R4.1 (346) (CMS) by NLJONES at -->
<!-- RCHVMX on 24 Feb 1999 at 17:15:51 -->
<!-- Edited by Kersten Oct 2001 -->
<!-- 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>Change Cluster Node Entry (QcstChangeClusterNodeEntry) API</h2>
<div class="box" style="width: 70%;">
<br>
&nbsp;&nbsp;Required Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="TOP" width="10%">1</td>
<td align="LEFT" valign="TOP" width="50%">Request handle</td>
<td align="LEFT" valign="TOP" width="20%">Output</td>
<td align="LEFT" valign="TOP" width="20%">Char(16)</td>
</tr>
<tr>
<td align="center" valign="TOP">2</td>
<td align="LEFT" valign="TOP">Cluster name</td>
<td align="LEFT" valign="TOP">Input</td>
<td align="LEFT" valign="TOP">Char(10)</td>
</tr>
<tr>
<td align="center" valign="TOP">3</td>
<td align="LEFT" valign="TOP">Node id</td>
<td align="LEFT" valign="TOP">Input</td>
<td align="LEFT" valign="TOP">Char(8)</td>
</tr>
<tr>
<td align="center" valign="TOP">4</td>
<td align="LEFT" valign="TOP">Format name</td>
<td align="LEFT" valign="TOP">Input</td>
<td align="LEFT" valign="TOP">Char(8)</td>
</tr>
<tr>
<td align="center" valign="TOP">5</td>
<td align="LEFT" valign="TOP">Node entry information</td>
<td align="LEFT" valign="TOP">Input</td>
<td align="LEFT" valign="TOP">Char(*)</td>
</tr>
<tr>
<td align="center" valign="TOP">6</td>
<td align="LEFT" valign="TOP">Length of node entry information</td>
<td align="LEFT" valign="TOP">Input</td>
<td align="LEFT" valign="TOP">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="TOP">7</td>
<td align="LEFT" valign="TOP">Results information</td>
<td align="LEFT" valign="TOP">Input</td>
<td align="LEFT" valign="TOP">Char(30)</td>
</tr>
<tr>
<td align="center" valign="TOP">8</td>
<td align="LEFT" valign="TOP">Error code</td>
<td align="LEFT" valign="TOP">I/O</td>
<td align="LEFT" valign="TOP">Char(*)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Service Program: QCSTCTL<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *EXCLUDE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Change Cluster Node Entry (QcstChangeClusterNodeEntry) API is used to
change the fields in the cluster node entry. The fields that can be changed are
the cluster interface addresses defined for the node and status of the node.
The node entry which is being changed may or may not have Cluster Resource
Services started.</p>
<p>The following conditions apply to this API:</p>
<ul>
<li>This API must be called from a program running on a cluster node with a
status of Active.</li>
<li>If the cluster is in a partitioned state, this operation can only be
performed within the partition running the API.</li>
<li>Only one cluster interface address can be changed at a time. If the cluster
is in partitioned state, the change cluster interface address is only allowed
for a node within the same partition.</li>
<li>To change the cluster node status, only a node that has a status of
Partition or Failed can be changed and it can only be changed to Failed
status.</li>
</ul>
<p>This API operates in an asynchronous mode. See <a href=
"clust1a3.htm#HDRASYMOD">Behavior of Cluster Resource Services APIs</a> for
more information.</p>
<p><img src="delta.gif" alt="Start of change">For <a href=
"clust3a1TOC.htm#PriBckModel">primary-backup model</a> cluster
resource groups:<img src="deltaend.gif" alt="End of change">
<ul>
<li>When the status of a node is changed to Failed, the role of nodes in the
recovery domain for each cluster resource group in the partition may be
reordered by assigning the specified node as the last backup. If multiple nodes
have failed and their status needs to be changed, the order in which the nodes
are changed will affect the final order of the recovery domain's backup nodes
in the cluster resource group.</li>
<li>If the failed node was the primary node for a cluster resource group, the
first active backup will be reassigned as the new primary node. When this
occurs for a device cluster resource group, ownership of the hardware will be
moved to the new primary node.</li>
</ul>
<p><img src="delta.gif" alt="Start of change">
For peer model cluster resource groups, the membership status is changed to
inactive.<img src="deltaend.gif" alt="End of change">
<p>If an exit program is specified for the cluster resource group, it will be
called with an action code of Change Node Status (20).</p>
<p>If a problem is detected and the API does not complete successfully, the API
can be run again once the problem is corrected. Any cluster resource group that
had already had the status of a node changed from Partition to Failed and the
recovery domain order changed will not be affected by running this API
again.</p>
<p><img src="delta.gif" alt="Start of change">When changing the node status to
failed, the exit program for any cluster resource group which has the changing
node in its recovery domain will be called with an action code of 20 (change node
status). Since this is not a failover, no message is sent
to the failover message queue. The cluster resource group status will remain at its
current status value.
<img src="deltaend.gif" alt="End of change">
<p><strong>Warning:</strong></p>
<dl>
<dd>Using this API to change the status of a node to failed provides a way to
tell Cluster Resource Services that a node has really failed. There are certain
failure conditions that Cluster Resource Services cannot detect as a node
failure. Rather, the problem appears to be a communication problem and the
cluster looks like it has become partitioned. By telling Cluster Resource
Services that a node has failed, it makes recovery from the partition state
simpler <img src="delta.gif" alt="Start of change"> for primary-backup
model cluster resource groups <img src="deltaend.gif" alt="End of change">
since a backup node from the remaining active cluster nodes can then be
assigned as the primary node. Changing the node status to Failed when, in fact,
the node is still active and a true partition has occurred should not be done.
Doing so allows a node in each partition to become the primary node for a
cluster resource group. When two nodes think they are the primary node, data
such as files or data bases could become corrupted if two different nodes are
each making independent changes to copies of their files. In addition, from the cluster resource group
perspective the two partitions
cannot be merged back together when a node in each partition has been assigned
the primary role.</dd>
</dl>
<p><strong>Restriction:</strong> This API cannot be called from a cluster
resource group exit program.</p>
<h3>Authorities and Locks</h3>
<p>The program that calls this API must be running under a user profile with
*IOSYSCFG special authority.</p>
<dl>
<dt><em>User Queue Authority</em></dt>
<dd>*OBJOPR and *ADD</dd>
<dt><em>User Queue Library Authority</em></dt>
<dd>*EXECUTE</dd>
<dt><em>User Queue Lock</em></dt>
<dd>*EXCLRD</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Request handle</strong></dt>
<dd>OUTPUT; CHAR(16)
<p>A unique string or handle that identifies this API call. It is used to
associate this call to any responses placed on the user queue specified in the
results information parameter.</p>
</dd>
<dt><strong>Cluster name</strong></dt>
<dd>INPUT; CHAR(10)
<p>The name of the cluster.</p>
</dd>
<dt><strong>Node id</strong></dt>
<dd>INPUT; CHAR(8)
<p>A valid simple name that uniquely identifies the node.</p>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The content and format of the node entry information. The possible format
names are:</p>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em><a href="#ifca0100">IFCA0100</a></em></td>
<td align="left" valign="top">Add cluster node interface</td>
</tr>
<tr>
<td align="left" valign="top"><em><a href="#ifcr0100">IFCR0100</a></em></td>
<td align="left" valign="top">Remove cluster node interface</td>
</tr>
<tr>
<td align="left" valign="top"><em><a href="#ifcc0100">IFCC0100</a></em></td>
<td align="left" valign="top">Replace cluster node interface</td>
</tr>
<tr>
<td align="left" valign="top"><em><a href="#stsc0100">STSC0100</a></em></td>
<td align="left" valign="top">Change cluster node status</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Node entry information</strong></dt>
<dd>INPUT; CHAR(*)
<p>Detailed information about the node entry.</p>
</dd>
<dt><strong>Length of node entry information</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the node entry information.</p>
</dd>
<dt><strong>Results information</strong></dt>
<dd>INPUT; CHAR(30)
<p>A library qualified user queue name followed by a reserved field.</p>
<p>Library qualified user queue: A user queue, which exists on the node from
which the API was called, that receives results information after the function
has completed on all active nodes in the cluster. See the <a href=
"#usage_notes">Usage Notes</a> section of this API for a description of the
data that is placed on this queue. This is a 20 character field. The first 10
characters contain the user queue name and the second 10 characters contain the
user queue library name. No special values are supported. QTEMP, *LIBL, and
*CURLIB are not valid for the library name. The attributes of this user queue
must be keyed.</p>
<p>Reserved: The last 10 characters of results information are reserved and
must be set to hexadecimal zero.</p>
</dd>
<dt><strong>Error code</strong></dt>
<dd>I/O; CHAR(*)
<p>The structure in which to return error information. For the format of the
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
</dd>
</dl>
<br>
<h3><a name="ifca0100">IFCA0100 Format</a></h3>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="TOP" width="10%">0</td>
<td align="center" valign="TOP" width="10%">0</td>
<td align="LEFT" valign="TOP" width="20%">CHAR(16)</td>
<td align="LEFT" valign="TOP" width="60%">Cluster interface address</td>
</tr>
</table>
<br>
<br>
<h3><a name="ifcr0100">IFCR0100 Format</a></h3>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="TOP" width="10%">0</td>
<td align="center" valign="TOP" width="10%">0</td>
<td align="LEFT" valign="TOP" width="20%">CHAR(16)</td>
<td align="LEFT" valign="TOP" width="60%">Cluster interface address</td>
</tr>
</table>
<br>
<br>
<h3><a name="ifcc0100">IFCC0100 Format</a></h3>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="TOP" width="10%">0</td>
<td align="center" valign="TOP" width="10%">0</td>
<td align="LEFT" valign="TOP" width="20%">CHAR(16)</td>
<td align="LEFT" valign="TOP" width="60%">Old cluster interface address</td>
</tr>
<tr>
<td align="center" valign="TOP">16</td>
<td align="center" valign="TOP">10</td>
<td align="LEFT" valign="TOP">CHAR(16)</td>
<td align="LEFT" valign="TOP">New cluster interface address</td>
</tr>
</table>
<br>
<br>
<h3><a name="stsc0100">STSC0100 Format</a></h3>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="TOP" width="10%">0</td>
<td align="center" valign="TOP" width="10%">0</td>
<td align="LEFT" valign="TOP" width="20%">BINARY(4)</td>
<td align="LEFT" valign="TOP" width="60%">New node status</td>
</tr>
</table>
<br>
<br>
<h3>Field Descriptions</h3>
<p><strong>Cluster interface address.</strong> The cluster interface address is
an IP address that is used by Cluster Resource Services to communicate with
other nodes in the cluster. The address is in dotted decimal format and is a
null-terminated string.</p>
<p><strong>Note:</strong> Cluster Resource Services uses existing interface
addresses configured for an iSeries. See <a href=
"../rzai2/rzai2kickoff.htm">TCP/IP</a> for instructions for configuring interface
addresses on the iSeries. The IP addresses defined as cluster interface
addresses can be used by other applications. If an IP address is reconfigured
through the TCP/IP configuration functions, the Change Cluster Node Entry API
should be used to make the corresponding change to the cluster interface
address. A mismatch will cause cluster errors to occur. An interface address should not be used
as a takeover IP address.</p>
<p><strong>New cluster interface address.</strong> The cluster interface
address which replaces the old cluster interface address. The address is in
dotted decimal format and is a null-terminated string.</p>
<p><strong>New node status.</strong> The new status of the node. The valid
value for new node status is:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>7</em></td>
<td align="left" valign="top">The node has failed.</td>
</tr>
</table>
<br>
<p><strong>Old cluster interface address.</strong> The cluster interface
address which is being replaced. The address is in dotted decimal format and is
a null-terminated string.</p>
<br>
<h3><a name="usage_notes">Usage Notes</a></h3>
<h4>Results Information User Queue</h4>
<p>Asynchronous results are returned to a user queue specified by the Results
Information parameter of the API. See <a href="clust1a4.htm">Cluster APIs Use of User Queues</a>
and <a href="clust1a5.htm">Using Results Information</a> for details on how to create the
results information user queue, the format of the entries, and how to use the
data placed on the queue. The data is sent to the user queue in the form of a
message identifier and the substitution data for the message (if any exists).
The following identifies the data sent to the user queue (excluding the message
text).</p>
<table width="100%" cellpadding="5">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Message Text</th>
</tr>
<tr>
<td width="15%" valign="top">CPCBB01 C</td>
<td width="85%" valign="top">Cluster Resource Services API &amp;1 completed.
completed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CF2 D</td>
<td align="left" valign="top">Error(s) occurred during running of &amp;1
API.</td>
</tr>
<tr>
<td align="left" valign="top">CPFBB09 D</td>
<td align="left" valign="top">Cluster node &amp;1 does not exist in cluster
&amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">CPFBB13 D</td>
<td align="left" valign="top">Cluster interface address &amp;1 already assigned
to cluster node &amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">CPFBB14 D</td>
<td align="left" valign="top">Cluster interface address &amp;1 cannot be added
for cluster node &amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">CPFBB15 D</td>
<td align="left" valign="top">Cluster interface address &amp;1 cannot be
removed.</td>
</tr>
<tr>
<td align="left" valign="top">CPFBB16 D</td>
<td align="left" valign="top">Cluster interface address &amp;1 cannot be
changed to &amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">CPFBB17 D</td>
<td align="left" valign="top">&amp;1 API cannot be processed in cluster
&amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">CPFBB24 D</td>
<td align="left" valign="top">Node &amp;1 not participating in &amp;2
protocol.</td>
</tr>
<tr>
<td align="left" valign="top">CPFBB2D D</td>
<td align="left" valign="top">Timeout detected while waiting for a
response.</td>
</tr>
<tr>
<td align="left" valign="top">CPFBB46 D</td>
<td align="left" valign="top">Cluster Resource Services internal error.</td>
</tr>
<tr>
<td align="left" valign="top">CPFBB47 D</td>
<td align="left" valign="top">Cluster Resource Services ended abnormally.</td>
</tr>
<tr>
<td align="left" valign="top">CPFBB89 D</td>
<td align="left" valign="top">The current status of cluster node &amp;1 cannot
be changed.</td>
</tr>
</table>
<br>
<br>
<h3>Error Messages</h3>
<p>Messages that are delivered
through the error code parameter are listed here. The data (messages) sent to
the results information user queue are listed in the <a href=
"#usage_notes">Usage Notes</a> above.</p>
<table width="100%" cellpadding="5">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td width="15%" valign="top">CPF2113 E</td>
<td width="85%" valign="top">Cannot allocate library &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C1E E</td>
<td align="left" valign="top">Required parameter &amp;1 omitted.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C21 E</td>
<td align="left" valign="top">Format name &amp;1 is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C39 E</td>
<td align="left" valign="top">Value for reserved field not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CF1 E</td>
<td align="left" valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CF2 E</td>
<td align="left" valign="top">Error(s) occurred during running of &amp;1
API.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9801 E</td>
<td align="left" valign="top">Object &amp;2 in library &amp;3 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9802 E</td>
<td align="left" valign="top">Not authorized to object &amp;2 in &amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9804 E</td>
<td align="left" valign="top">Object &amp;2 in library &amp;3 damaged.</td>
</tr>
<tr>
<td align="left" valign="top">CPF980C E</td>
<td align="left" valign="top">Object &amp;1 in library &amp;2 cannot be in an
independent auxiliary storage pool.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9810 E</td>
<td align="left" valign="top">Library &amp;1 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9820 E</td>
<td align="left" valign="top">Not authorized to use library &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9872 E</td>
<td align="left" valign="top">Program or service program &amp;1 in library
&amp;2 ended. Reason code &amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPFBB02 E</td>
<td align="left" valign="top">Cluster &amp;1 does not exist.</td>
</tr>
<tr>
<td align="left" valign="top">CPFBB09 E</td>
<td align="left" valign="top">Cluster node &amp;1 does not exist in cluster
&amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">CPFBB13 E</td>
<td align="left" valign="top">Cluster interface address &amp;1 already assigned
to cluster node &amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">CPFBB14 E</td>
<td align="left" valign="top">Cluster interface address &amp;1 cannot be added
for cluster node &amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">CPFBB15 E</td>
<td align="left" valign="top">Cluster interface address &amp;1 cannot be
removed.</td>
</tr>
<tr>
<td align="left" valign="top">CPFBB16 E</td>
<td align="left" valign="top">Cluster interface address &amp;1 cannot be
changed to &amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">CPFBB17 E</td>
<td align="left" valign="top">&amp;1 API cannot be processed in cluster
&amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">CPFBB32 E</td>
<td align="left" valign="top">Attributes of user queue &amp;1 in library &amp;2
are not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPFBB39 E</td>
<td align="left" valign="top">Current user does not have IOSYSCFG special
authority.</td>
</tr>
<tr>
<td align="left" valign="top">CPFBB44 E</td>
<td align="left" valign="top">&amp;1 API cannot be called from a cluster
resource group exit program.</td>
</tr>
<tr>
<td align="left" valign="top">CPFBB46 E</td>
<td align="left" valign="top">Cluster Resource Services internal error.</td>
</tr>
<tr>
<td align="left" valign="top">CPFBB56 E</td>
<td align="left" valign="top">Length of node entry not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPFBB5F E</td>
<td align="left" valign="top">Field value within structure is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPFBB70 E</td>
<td align="left" valign="top">API request &amp;1 not compatible with current
cluster version.</td>
</tr>
<tr>
<td align="left" valign="top">CPFBB89 E</td>
<td align="left" valign="top">The current status of cluster node &amp;1 cannot
be changed.</td>
</tr>
<tr>
<td align="left" valign="top">TCP1901 E</td>
<td align="left" valign="top">Internet address &amp;1 not valid.</td>
</tr>
</table>
<br>
<hr>
API introduced: V4R4
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"clust1a1.htm">Cluster APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</center>
</body>
</html>