Ending a peer cluster resource group will end the access point for cluster
resources on all nodes defined as a peer node.
| 1 | Request handle | Output | Char(16) |
| 2 | Cluster name | Input | Char(10) |
| 3 | Cluster resource group name | Input | Char(10) |
| 4 | Exit program data | Input | Char(256) |
| 5 | Results information | Input | Char(30) |
| 6 | Error code | I/O | Char(*) |
The End Cluster Resource Group (QcstEndClusterResourceGroup) API disables resiliency of the specified cluster resource group. If an exit program is specified for the cluster resource group, the cluster resource group exit program is called with an action code of End (4) on each active node in the recovery domain.
When the exit program is called, the cluster resource group status is set to End Cluster Resource Group Pending (550). Successful completion of the exit program sets the cluster resource group status Inactive (20). After the exit program completes successful, for an application cluster resource group:
Ending a device cluster resource group will not change the ownership of devices. The devices remain on whatever nodes owns them at the time the API is run. Also, the devices are not varied off when the cluster resource group is ended.
Ending a peer cluster resource group will end the access point for cluster
resources on all nodes defined as a peer node.
This API requires:
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.
(applies
to user profile calling the API and user
profile to run the exit program) (applies to user profile calling the API and user
profile to run the exit program) (applies to user profile to run the exit program)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 containing the cluster resource group.
The name of the cluster resource group which will be ended.
256 bytes of data that is passed to the cluster resource group exit program when it is called. This parameter may contain any scalar data except pointers. For example, it can be used to provide state information. This data will be stored with the specified cluster resource group and copied to all nodes in the recovery domain. Pointers in this area will not resolve correctly on all nodes and should not be placed in the data. See Cluster Resource Group Exit Program for information about the cluster resource group exit program. The data specified will replace the existing exit program data stored with the cluster resource group. If blanks are specified, then the exit program data stored with the cluster resource group will be cleared. This parameter must be set to *SAME if no exit program is specified for the cluster resource group. The following special value can be used:
| *SAME | The exit program data stored with the cluster resource group specified will be passed to the exit program. This must be left justified. |
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.
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 | Error Message Text |
|---|---|
| CPCBB01 C | Cluster Resource Services API &1 completed. |
| CPF18BA D | Error occurred with subsystem. |
| CPF2113 E | Cannot allocate library &1. |
| CPF2204 D | User profile &1 not found. |
| 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. |
| CPFBB0F D | Cluster resource group &1 does not exist in cluster &2. |
| CPFBB17 D | &1 API cannot be processed in cluster &2. |
| CPFBB18 D | Request &1 not allowed for cluster resource group &2. |
| CPFBB2C D | Attributes of exit program &1 in library &2 are not valid. |
| CPFBB2D D | Timeout detected while waiting for a response. |
| CPFBB2E D | Job submission failed for cluster resource group &1 in cluster &2. |
| CPFBB32 D | Attributes of user queue &1 are not valid. |
| CPFBB47 D | Cluster Resource Services ended abnormally. |
| CPFBB48 D | Cluster Resource Services error detected. |
| CPFBB6E E | Exit program data cannot be specified. |
| CPIBB10 D | Cluster resource group exit program &1 in library &2 on node &3 failed. |
| TCP1B61 D | Unable to determine if &1 interface ended.&2 successful (&3 %). |
| TCP1B62 D | Cannot determine if &1 interface ended. |
| TCP1B65 D | &2 interface not ended. Reason &1. |
| TCP1B72 D | &1 interface not ended. &1 interface is not active. |
| TCP1B73 D | &1 interface not ended. &1 interface not defined in TCP/IP configuration. |
| TCP1B74 D | &1 interface not ended. Line description &2 not found. |
| TCP1B85 D | &1 interface not ended. |
| TCP9999 D | Internal system error in program &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. |
| CPF2204 E | User profile &1 not found. |
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3CF2 E | Error(s) occurred during running of &1 API. |
| CPF3C1E E | Required parameter &1 omitted. |
| CPF3C39 E | Value for reserved field not valid. |
| 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. |
| 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. |
| CPFBB02 E | Cluster &1 does not exist. |
| CPFBB0F E | Cluster resource group &1 does not exist in cluster &2. |
| CPFBB26 E | Cluster Resource Services not active or not responding. |
| CPFBB2C E | Attributes of exit program &1 in library &2 are not valid. |
| CPFBB32 E | Attributes of user queue &1 are not valid. |
| CPFBB38 E | Library name &1 not allowed for this request. |
| 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. |
| CPFBB6E E | Exit program data cannot be specified. |
| Top | Cluster APIs | APIs by category |