software required for
SSL installed on the systems.
| 1 | Request handle | Output | Char(16) |
| 2 | Cluster name | Input | Char(10) |
| 3 | Node entry | Input | Char(*) |
| 4 | Start indicator | Input | Binary(4) |
| 5 | Format name | Input | Char(8) |
| 6 | Results information | Input | Char(30) |
| 7 | Error code | I/O | Char(*) |
The Add Cluster Node Entry (QcstAddClusterNodeEntry) API is used to add a node to the membership list of an existing cluster.
If the "Start Indicator" parameter is set to 0, the node that is being added will have a status of New and Cluster Resource Services will not be started on that node. The Start Cluster Node (QcstStartClusterNode) API can be called from a program running on one of the active nodes in the cluster to start Cluster Resource Services on a node that does not have a status of Active.
If the "Start Indicator" parameter on this API is set to 1, Cluster Resource Services will be started on the node that is being added. If Cluster Resource Services is successfully started, the status for the added node will be set to Active. If the Cluster Resource Services cannot be started, the status of the added node will be set to New.
During the activation of Cluster Resource Services, the allow add to cluster
(ALWADDCLU) network attribute is checked to see whether the node being added
should be part of the cluster and whether to validate the cluster request
through the use of X.509 digital certificates. If validation is required, the
requesting node and the node being added must have the
software required for
SSL installed on the systems.
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 to which the node is being added. It must be a valid simple name.
This parameter contains the information associated with the node which is being added to the cluster membership list.
An indicator which specifies whether or not Cluster Resource Services is to be started on the node that is being added.
| 0 | Cluster Resource Services will not be started on the node. |
| 1 | Cluster Resource Services will be started on the node. |
The content and format of the information supplied for the node entry. The possible format names are:
| ADDN0100 | Node entry 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 |
| 8 | 8 | BINARY(4) | Offset to first cluster interface entry |
| 12 | C | BINARY(4) | Number of cluster interfaces |
| This field repeats for each number of cluster interfaces. | CHAR(16) | Cluster interface address | |
Cluster interface address. 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.
Note: Cluster Resource Services uses existing IP interfaces configured for an iSeries. See TCP/IP for instructions for configuring IP interfaces 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 (QcstChangeClusterNodeEntry) API should be used to make the corresponding change to the cluster interface address. A mismatch will cause cluster errors to occur.
Node id. A valid simple name that uniquely identifies the node.
Number of cluster interfaces. The number of IP interfaces associated with a cluster node. It is limited to 1 or 2 entries only.
Offset to first cluster interface entry. The offset from the beginning of the structure to the first cluster interface address entry.
Results Information User Queue. 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. |
| CPF2204 D | User profile &1 not found. |
| CPF3CF2 D | Error(s) occurred during running of &1 API. |
| CPFBB01 D | Cluster already exists. |
| CPFBB05 D | Cluster node &1 cannot be started. |
| CPFBB07 D | Node &1 could not be added to cluster &2. |
| CPFBB11 D | Cluster node &1 already exists in cluster &2. |
| CPFBB12 D | Cluster node &1 in cluster &2 could not be started. |
| CPFBB13 D | Cluster interface address &1 already assigned to cluster node &2. |
| CPFBB17 D | &1 API cannot be processed in cluster &2. |
| CPFBB24 D | Node &1 not participating in &2 API protocol. |
| CPFBB2D D | Timeout detected while waiting for a response. |
| CPFBB46 D | Cluster Resource Services internal error. |
| CPFBB54 D | Node &1 not be added to the cluster &2. |
| CPFBB71 D | Potential node version &1 of node &2 not compatible. |
| CPFBB96 D | Internal device domain mismatch. |
| CPIBB03 I | Cluster node &1 added to cluster &2. |
| CPIBB05 I | Cluster node &1 started 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 | Message Text |
|---|---|
| CPF2113 E | Cannot allocate library &1. |
| CPF3C1E E | Required parameter &1 omitted. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C29 E | Object 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. |
| CPF980C 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. |
| CPFBB04 E | Number of cluster interface addresses not valid. |
| CPFBB07 E | Node &1 could not be added to cluster &2. |
| CPFBB0D E | Cluster interface address &1 specified more than once. |
| CPFBB11 E | Cluster node &1 already exists in cluster &2. |
| CPFBB13 E | Cluster interface address &1 already assigned to cluster node &2. |
| CPFBB17 E | &1 API cannot be processed in cluster &2. |
| 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 called from a cluster resource group exit program. |
| CPFBB46 E | Cluster Resource Services internal error. |
| CPFBB55 E | Value &1 specified for start indicator not valid. |
| CPFBB57 E | Offset to cluster interface entry not valid. |
| TCP1901 E | Internet address &1 not valid. |
| Top | Cluster APIs | APIs by category |