| 1 | Request handle | Output | Char(16) |
| 2 | Cluster name | Input | Char(10) |
| 3 | Device domain name | Input | Char(10) |
| 4 | Device domain entry information | Input | Char(*) |
| 5 | Format name | Input | Char(8) |
| 6 | Results information | Input | Char(30) |
| 7 | Error code | I/O | Char(*) |
The Add Device Domain Entry (QcstAddDeviceDomainEntry) API is used to add a cluster node to the membership list of a device domain. There is no API to create a device domain, the device domain will be created when the first cluster node is added to it.
The following conditions apply to this API:
This API requires that i5/OS option 41, HA Switchable Resources, is installed and a valid license key exists on all cluster nodes that will be in the device domain.
For more information, see these Information Center topics:
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.
The name of the device domain to which the node is being added. It must be a valid simple name. If the device domain does not currently exist, it will be created.
Detailed information about device domain entry to be added to the device domain.
The content and format of the device domain entry information. The possible format names are:
| ADDD0100 | 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 | BINARY(4) | Length of data provided |
| 4 | 4 | CHAR(8) | Node id |
Length of data provided. This is the total length of data provided (including this field) for the device domain entry information.
Node id. A unique string of characters that identifies a cluster node to be added to the device domain.
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. |
| CPF3CF2 D | Error(s) occurred during running of &1 API. |
| CPFBB02 D | Cluster &1 does not exist. |
| CPFBB09 D | Cluster node &1 does not exist in cluster &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. |
| CPFBB73 D | Cluster node &1 could not be added to device domain &2. |
| CPFBB74 D | Cluster node &1 already a member of device domain &2. |
| CPFBB78 E | Request cannot be processed in cluster &1. |
| CPFBB93 D | Base operating system option 41 not installed or license key not valid. |
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. |
| 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. |
| CPFBB09 E | Cluster node &1 does not exist in cluster &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. |
| CPFBB5F E | Field value within structure is not valid. |
| CPFBB70 E | API request &1 not compatible with current cluster version. |
| CPFBB73 E | Cluster node &1 could not be added to device domain &2. |
| CPFBB74 E | Cluster node &1 already a member of device domain &2. |
| CPFBB78 E | Request cannot be processed in cluster &1. |
| Top | Cluster APIs | APIs by category |