Delete Cluster (QcstDeleteCluster) API

Required Parameter Group:

1	Request handle	Output	Char(16)
2	Cluster name	Input	Char(10)
3	Results information	Input	Char(30)
4	Error code	I/O	Char(*)

  Service Program: QCSTCTL

  Default Public Authority: *EXCLUDE

  Threadsafe: Yes

The Delete Cluster (QcstDeleteCluster) API is used to delete a cluster created by the Create Cluster (QcstCreateCluster) API. All cluster resource group (CRG) objects and device domains associated with the cluster are deleted, Cluster Resource Services is ended on each node in the cluster membership list, and the cluster is deleted.

The following conditions apply to this API:

The Delete Cluster API must be called from a program running on a node in the cluster.
If the API is initiated from a cluster node with a status of Active, all active cluster nodes will be removed from the cluster, and the cluster resource group objects associated with the cluster will be deleted. Cluster resource group objects on nodes with a status of Inactive or Failed will not be deleted.
If the API is initiated from a cluster node with a status of Failed or Inactive, only that node is removed from the cluster and cluster resource group objects on that node are deleted.
Cluster Resource Group Manager will call cluster resource group exit programs with an action code of Delete (7) or Delete Command(14) if Cluster Resource Services is not active on the node where the API is run.
This API may be called when the cluster is in a partitioned state. In this case, the delete operation will only be performed within the partition running the API.
A node which was a member of a device domain has internal information related to auxiliary storage pools such as disk unit numbers or virtual memory addresses. After a cluster is deleted, this internal information persists until the node is IPLed. If the cluster is deleted, the node must be IPLed before the node can become a member of another device domain.

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

This API is shipped with *EXCLUDE public authority.

The program that calls this API must be running under a user profile with *IOSYSCFG special authority.

User Queue Authority: *OBJOPR and *ADD
User Queue Library Authority: *EXECUTE
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 which is being deleted. This must be a valid simple name.

Results information

INPUT; CHAR(30)

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.

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	Message Text
CPCBB01 C	Cluster Resource Services API &1 completed.
CPF18BA D	Error occurred with subsystem.
CPF3CF2 D	Error(s) occurred during running of &1 API.
CPFBB24 D	Node &1 is not participating in &2 API protocol
CPFBB2D D	Timeout detected while waiting for a response.
CPFBB46 D	Cluster Resource Services internal error.
CPIBB02 I	Cluster &1 deleted from node &2.

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.
CPF3C1E E	Required parameter &1 omitted.
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.
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.
CPFBB46 E	Cluster Resource Services internal error.

API introduced: V4R4

[ Back to top | Cluster APIs | APIs by category ]