| 1 | Request handle | Output | Char(16) |
| 2 | Cluster name | Input | Char(10) |
| 3 | Node entry | Input | Char(*) |
| 4 | Option | Input | Binary(4) |
| 5 | Format name | Input | Char(8) |
| 6 | Results information | Input | Char(30) |
| 7 | Error code | I/O | Char(*) |
The End Cluster Node (QcstEndClusterNode) API is used to end Cluster Resource Services on one or all the nodes in the membership list of an existing cluster. The status of each node that is ended is set to Inactive. In order to restart Cluster Resource Services on nodes that have been ended, the Start Cluster Node (QcstStartClusterNode) API is used.
When a node in the cluster is ended, it is not removed from the cluster membership list.
If all the nodes in the cluster are being ended, cluster resource group exit programs will not be called with an indication to failover.
The following conditions apply to this API:
This API operates in an asynchronous mode. See Behavior of Cluster Resource Services APIs for more information.
Restriction: This API cannot be called from a cluster
resource group exit program.
The program that calls this API must be running under a user profile with *IOSYSCFG special authority.
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.
The name of the cluster that contains the node or nodes being ended.
This parameter contains the node id being ended. It is ignored if the special value *ALL is specified as the node id.
The method used to end the node:
| 0 | Immediate. The request to end replication for all CRGs on the node will be processed immediately. |
| 1 | Controlled. Pending CRG actions will complete before the request to end replication is processed. |
The content and format of the information supplied in the node entry array. The possible format names are:
| ENDN0100 | Node id information |
A library qualified user queue name followed by a reserved field.
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 Usage Notes 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.
Reserved: The last 10 characters of results information are reserved and must be set to hexadecimal zero.
The structure in which to return error information. For the format of the structure, see Error code parameter.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(8) | Node id |
A valid simple name that uniquely identifies a node. A special value of *ALL
can be specified to end all nodes in a cluster. The special value must be
left-justified.
Asynchronous results are returned to a user queue specified by the Results Information parameter of the API. See Cluster APIs Use of User Queues and Using Results Information 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).
| Message ID | Message Text |
|---|---|
| CPCBB01 C | Cluster Resource Services API &1 completed. |
| CPF18BA D | Error occurred with subsystem. |
| CPF3CF2 D | Error(s) occurred during running of &1 API. |
| CPFBB09 D | Cluster node &1 does not exist in cluster &2. |
| CPFBB17 D | &1 API cannot be processed in cluster &2. |
| CPFBB1C D | Cluster node &1 in cluster &2 cannot be ended. |
| CPFBB24 D | Node &1 not participating in &2 protocol. |
| CPFBB2D D | Timeout detected while waiting for a response. |
| CPFBB46 D | Cluster Resource Services internal error. |
| CPIBB06 I | Cluster node &1 ended in cluster &2. |
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 Usage Notes above.
| Message ID | Error Message Text |
|---|---|
| CPF2113 E | Cannot allocate library &1. |
| CPF3C1E E | Required parameter &1 omitted. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C39 E | Value for reserved field not valid. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3CF2 E | Error(s) occurred during running of &1 API. |
| CPF9801 E | Object &2 in library &3 not found. |
| CPF9802 E | Not authorized to object &2 in &3. |
| CPF9804 E | Object &2 in library &3 damaged. |
| CF980C E | Object &1 in library &2 cannot be in an independent auxiliary storage pool. |
| CPF9810 E | Library &1 not found. |
| CPF9820 E | Not authorized to use library &1. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
| CPFBB02 E | Cluster &1 does not exist. |
| CPFBB09 E | Cluster node &1 does not exist in cluster &2. |
| CPFBB17 E | &1 API cannot be processed in cluster &2. |
| CPFBB1C E | Cluster node &1 in cluster &2 already ended. |
| CPFBB26 E | Cluster Resource Services not active or not responding. |
| CPFBB32 E | Attributes of user queue &1 in library &1 are not valid. |
| CPFBB39 E | Current user does not have IOSYSCFG special authority. |
| CPFBB44 E | &1 API cannot be used within a cluster resource group exit program. |
| CPFBB46 E | Cluster Resource Services internal error. |
| CPFBB59 E | Value &1 specified for option not valid. |
[ Back to top | Cluster APIs | APIs by category ]