| 1 | Request handle | Output | Char(16) |
| 2 | Cluster name | Input | Char(10) |
| 3 | Cluster administrative domain name | Input | Char(10) |
| 4 | Cluster administrative domain information | Input | Char(*) |
| 5 | Format name | Input | Char(8) |
| 6 | Results information | Input | Char(30) |
| 7 | Error code | I/O | Char(*) |
The Change Cluster Administrative Domain (QcstChgClusterAdminDomain) API changes the attributes of a cluster administrative domain. This API allows the synchronization option to be changed.
This API operates in an asynchronous mode. See Behavior of Cluster Resource Services APIs for more information.
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 cluster administrative domain belongs.
The name of the cluster administrative domain which is to be changed.
Detailed information about the cluster administrative domain. For more information, see Administrative Domain Change (ADCH0100 Format).
The content and format of the cluster administrative domain information. The possible format names are:
| ADCH0100 | This format describes cluster administrative domain information. |
This parameter identifies a qualified user queue field and is followed by a reserved field.
Qualified user queue: Completion information is returned to this user queue, which exists on the node from which the API was called, after the function has completed. 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, *CURLIB are not valid library names. The attributes of this user queue must be keyed.
Reserved: The last 10 characters of the 30-character results information are reserved. Each character in this field 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 fixed fields |
| 4 | 4 | Binary(4) | Synchronization option |
Length of fixed fields. The length of the fixed fields in the format. This field must be set to 8.
Synchronization option. Indicates how a cluster administrative domain will synchronize monitored resources when a node joins the domain. The possible values are:
| -1 | Same | The synchronization option is not changed. |
| 0 | Last Change | Changes made on a joining node while it was inactive are synchronized with changes made in the active domain. The most recent change made to each monitored resource across all active nodes is applied. |
| 1 | Active Domain | Changes made in the active domain while the joining
node was inactive are applied to the joining node. Changes made on the joining
node while it was inactive are discarded. Note: The Active Domain synchronization option does not apply to *NWSCFG and *NWSSTG resource types. The Last Change synchronization option will always be used for those resources. |
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. |
| CPF9801 D | Object &2 in library &3 not found. |
| CPF9802 D | Not authorized to object &2 in &3. |
| CPF9803 D | Cannot allocate object &2 in library &3. |
| CPF9804 D | Object &2 in library &3 damaged. |
| CPF9810 D | Library &1 not found. |
| CPFBB39 D | The current user does not have IOSYSCFG special authority. |
| CPFBB46 D | Cluster Resource Services internal error. |
| CPFBB70 D | API request &1 not compatible with current cluster version. |
| CPFBBC3 D | Cluster administrative domain &1 does not exist. |
| CPFBBC4 D | Request not valid for cluster node &1. |
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. |
| CPF24B4 E | Severe error while addressing parameter list. |
| 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. |
| CPF9803 E | Cannot allocate object &2 in library &3. |
| CPF9804 E | Object &2 in library &3 damaged. |
| 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. |
| CPFBB0A E | Cluster node &1 in cluster &2 not active. |
| CPFBB26 E | Cluster Resource Services not active or not responding. |
| CPFBB39 E | Current user does not have IOSYSCFG special authority. |
| CPFBB43 E | Invalid format name &1 for cluster resource group type &2. |
| CPFBB5F E | Field value within structure is not valid. |
| CPFBB70 E | API request &1 not compatible with current cluster version. |
| CPFBBC3 E | Cluster administrative domain &1 does not exist. |
| CPFBBC4 E | Request not valid for cluster node &1. |
[ Back to top | Cluster APIs | APIs by category ]