Delete Cluster Resource Group (QcstDeleteClusterResourceGroup) API
Required Parameter Group:
| 1 | Request handle | Output | Char(16) |
| 2 | Cluster name | Input | Char(10) |
| 3 | Cluster resource group name | Input | Char(10) |
| 4 | Results information | Input | Char(30) |
| 5 | Error code | I/O | Char(*) |
Service Program: QCSTCRG1
Default Public Authority: *EXCLUDE
Threadsafe: Yes
The Delete Cluster Resource Group API deletes a cluster resource group from all nodes in the recovery domain.
The cluster resource group object is marked for deletion and is deleted on each active cluster node. The cluster resource group object will be deleted on other nodes in the cluster when they become active. If an exit program is specified for the cluster resource group, the cluster resource group exit program is called on each active node in the recovery domain with an action code of Verification Phase (5) and action code dependent data of Delete (12). This gives the exit program the ability to verify the exit program. If this call returns with a failure, the delete request will not proceed. If this call returns with success, the exit program will be called with Delete (7). The cluster resource group status is set to Delete Pending (550). The cluster resource group will be deleted even if the exit program fails. This API will never call the cluster resource group exit program with an action code of Undo (15).
The Delete Cluster Resource Group (DLTCRG) command can be used to delete a cluster resource group object on a system that does not have Cluster Resource Services active.
Deleting a device cluster resource group will not change the ownership of devices. The devices remain on whatever nodes owns them at the time of the delete.
If Cluster Resource Services configured the takeover IP address for an application cluster resource group and the IP interface is not active, the takeover IP address will be removed. If Cluster Resource Services finds that the takeover IP address is active, the API will fail with an error message.
This API requires:
- Cluster Resource Services active on the node processing the request.
- Cluster resource group status must not be Active (10).
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.
Authorities and Locks
The program that calls this API must be running under a user profile with *IOSYSCFG special authority.
- Cluster Resource Group Authority
- *OBJEXIST, *USE
- Cluster Resource Group Library Authority
- *EXECUTE
- Cluster Resource Group Lock
- *EXCL
- Exit Program Authority (applies to user profile calling the API and user profile to run the exit program)
- *EXECUTE
- Exit Program Library Authority (applies to user profile calling the API and user profile to run the exit program)
- *EXECUTE
- User Profile Authority (applies to user profile to run the exit program)
- *USE
- Request Information User Queue Authority
- *OBJOPR, *ADD
- Request Information User Queue Library Authority
- *EXECUTE
- Request Information User Queue Lock
- *EXCLRD
Required Parameter Group
- Request handle
- OUTPUT; CHAR(16)
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.
- Cluster name
- INPUT; CHAR(10)
The name of the cluster containing the cluster resource group.
- Cluster resource group name
- INPUT; CHAR(10)
The name of the cluster resource group.
- Results information
- INPUT; CHAR(30)
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 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, *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.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Usage Notes
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 | 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. |
| 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 |
| CPFBB02 D | Cluster &1 does not exist. |
| CPFBB0F D | Cluster resource group &1 does not exist 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. |
| CPFBB39 D | Current user does not have IOSYSCFG special authority. |
| CPFBB46 D | Cluster resource service internal error. |
| CPFBB47 D | Cluster Resource Services ended abnormally. |
| CPIBB10 D | Cluster resource group exit program &1 in library &2 on node &3 failed. |
Error Messages
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. |
| CPF3C1E E | Required parameter &1 omitted. |
| 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 D | 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. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
| 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 in library &2 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. |
API introduced: V4R4
[ Back to top | Cluster APIs | APIs by category ]