Cluster CL command and API descriptions

There are many APIs and CL commands that you can use for configuring, activating, and managing clusters, cluster nodes, and cluster resource groups.

The following tables show the name and a brief description of the cluster control and the cluster resource group control language (CL) commands and APIs that are available. The cluster CL commands are only available on OS/400^® V5R2M0 or later.

Start of change The first table contains commands and APIs for configuring, activating, and managing a cluster and the nodes in a cluster. The second table contains commands and APIs for configuring, activating, and managing cluster resource groups in a cluster. The third table contains commands for configuring and managing a cluster administrative domain. The fourth table contains descriptions of Integrated Operating System API which can be used to add and remove monitored resource entries from a cluster administrative domain. End of change

Table 1. Cluster Control CL Command and API Descriptions
Description	Cluster Control CL Command	Cluster Control API Name
Add Cluster Node Entry Adds a node to the membership list of an existing cluster. Also assigns the IP interface addresses to be used by cluster communications.	ADDCLUNODE	Add Cluster Node Entry (QcstAddClusterNodeEntry)
Add Device Domain Entry Adds a node to a device domain membership list so that it can participate in recovery actions for resilient devices. The addition of the first node to a device domain has the effect of creating that device domain.	ADDDEVDMNE	Add Device Domain Entry (QcstAddDeviceDomainEntry)
Adjust Cluster Version, Change Cluster Version Adjusts the current cluster version to the next level, for example, so that new function can be used within the cluster.	CHGCLUVER	Adjust Cluster Version (QcstAdjustClusterVersion)
Change Cluster Node Entry Changes the fields in the cluster node entry. For example, the IP interface addresses used for cluster communications can be changed.	CHGCLUNODE	Change Cluster Node Entry (QcstChangeClusterNodeEntry)
Change Cluster Resource Services, Change Cluster Configuration Adjusts cluster performance and configuration tuning parameters to match the communications environment of the network used for cluster communications.	CHGCLUCFG	Change Cluster Resource Services (QcstChgClusterResourceServices)
Create Cluster Creates a new cluster of one or more nodes.	CRTCLU	Create Cluster (QcstCreateCluster)
Delete Cluster Deletes an existing cluster. Cluster resource services is ended on all active cluster nodes and they are removed from the cluster.	DLTCLU	Delete Cluster (QcstDeleteCluster)
End Cluster Node Ends cluster resource services on one or all nodes in the membership list of an existing cluster. The node becomes unavailable to the cluster until it is restarted using the Start Cluster Node interface.	ENDCLUNOD	End Cluster Node (QcstEndClusterNode)
List Cluster Information, Display Cluster Information Retrieves information about a cluster. For example, the complete cluster membership list can be returned.	DSPCLUINF	List Cluster Information (QcstListClusterInfo)
List Device Domain Information, Display Cluster Information Lists device domain information of a cluster. For example, the list of currently defined device domains can be returned.	DSPCLUINF	List Device Domain Information (QcstListDeviceDomainInfo)
Remove Cluster Node Entry Removes a node from the membership list of a cluster. The node is removed from any recovery domains, cluster operations are ended on the node, and all cluster resource services objects are deleted from the node.	RMVCLUNODE	Remove Cluster Node Entry (QcstRemoveClusterNodeEntry)
Remove Device Domain Entry Removes a node from a device domain membership list. If this is the last node in the device domain, this also has the effect of deleting the device domain from the cluster.	RMVDEVDMNE	Remove Device Domain Entry (QcstRemoveDeviceDomainEntry)
Retrieve Cluster Information, Display Cluster Information Retrieves information about a cluster. For example, the cluster name and current cluster version are returned.	DSPCLUINF	Retrieve Cluster Information (QcstRetrieveClusterInfo)
Retrieve Cluster Resource Services Information, Display Cluster Information Retrieves information about the cluster resource services performance tuning and configuration parameters.	DSPCLUINF	Retrieve Cluster Resource Services Information (QcstRetrieveCRSInfo)
Start Cluster Node Starts cluster resource services on a node that is part of a cluster but is currently not active.	STRCLUNOD	Start Cluster Node (QcstStartClusterNode)
Work with Cluster Displays and works with cluster nodes and objects.	WRKCLU	none

Table 2. Cluster Resource Group CL Command and API Descriptions
Description	Cluster Resource Group CL Command	Cluster Resource Group API
Add Cluster Resource Group Device Entry Adds a new device entry to a cluster resource group. The device becomes a member of the group of switchable devices.	ADDCRGDEVE	Add Cluster Resource Group Device Entry (QcstAddClusterResourceGroupDevice)
Add Node to Recovery Domain, Add Cluster Resource Group Node Entry Adds a new node to the recovery domain of an existing cluster resource group.	ADDCRGNODE	Add Node to Recovery Domain (QcstAddNodeToRcvyDomain)
Change Cluster Resource Group Changes attributes of a cluster resource group. For example, the takeover IP address for an application CRG can be modified.	CHGCRG	Change Cluster Resource Group (QcstChangeClusterResourceGroup)
Change Cluster Resource Group Device Entry Changes a device entry in a cluster resource group. For example, the option to vary the configuration object online at switchover or failover can be modified.	CHGCRGDEVE	Change Cluster Resource Group Device Entry (QcstChangeClusterResourceGroupDev)
Create Cluster Resource Group Creates a cluster resource group object. The cluster resource group object identifies a recovery domain, which is a set of nodes in the cluster that will play a role in recovery.	CRTCRG	Create Cluster Resource Group (QcstCreateClusterResourceGroup)
Delete Cluster Resource Group Deletes a cluster resource group (CRG) on the local node only. Deleting a local cluster resource group requires the Cluster Resource Services to be inactive.	DLTCRG	none
Delete Cluster Resource Group, Delete CRG Cluster Deletes a cluster resource group from the cluster. The CRG object will be deleted from all active nodes in the recovery domain.	DLTCRGCLU	Delete Cluster Resource Group (QcstDeleteClusterResourceGroup)
Distribute Information Delivers information from a node in the recovery domain of a CRG to other nodes in that CRG's recovery domain.	none	Distribute Information (QcstDistributeInformation)
End Cluster Resource Group Disables resiliency of the specified cluster resource group. Upon successful completion of this API, the cluster resource group status is set to inactive.	ENDCRG	End Cluster Resource Group (QcstEndClusterResourceGroup)
Initiate Switchover, Change Cluster Resource Group Primary Causes an administrative switchover to be performed for the cluster resource group. The recovery domain is changed so that the current primary node becomes the last backup and the current first backup node becomes the new primary.	CHGCRGPRI	Initiate Switchover (QcstInitiateSwitchover)
List Cluster Resource Groups, Display Cluster Resource Group Information Generates a list of cluster resource groups and some information about the cluster resource group in the cluster.	DSPCRGINF	List Cluster Resource Groups (QcstListClusterResourceGroups)
List Cluster Resource Group Information, Display Cluster Resource Group Information Returns the contents of a cluster resource group object. For example, the recovery domain with the current node roles can be returned.	DSPCRGINF	List Cluster Resource Group Information (QcstListClusterResourceGroupInf)
Remove Cluster Resource Group Device Entry Removes a device entry from a cluster resource group. The device will no longer be a switchable resource.	RMVCRGDEVE	Remove Cluster Resource Group Device Entry (QcstRemoveClusterResourceGroupDev)
Remove Node From Recovery Domain, Remove Cluster Resource Group Node Entry Removes a node from the recovery domain of an existing cluster resource group. The node will no longer participate in recovery action for that group of resources.	RMVCRGNODE	Remove Node From Recovery Domain (QcstRemoveNodeFromRcvyDomain)
Start Cluster Resource Group Enables resiliency for the specified cluster resource group. The cluster resource group becomes active within the cluster.	STRCRG	Start Cluster Resource Group (QcstStartClusterResourceGroup)

Note: Cluster resource services also provides a set of example commands in the QUSRTOOL library that map to the CL commands and APIs mentioned above. The QUSRTOOL commands might be useful in some environments. For example, one can easily set up a cluster for testing cluster-enabled applications. See the member TCSTINFO in the file QUSRTOOL/QATTINFO for more information about these example commands.

Table 3. Administrative Domain CL Command Descriptions
Description	Administrative Domain CL Command	Administrative Domain APIs
Create Administrative Domain Creates a peer CRG which represents a cluster administrative domain. Once the cluster administrative domain is created, monitored resource entries (MREs), can be added to the domain to synchronize resource changes. Note: Once the cluster administrative domain is created you can use the CRG commands in Table 2 to manage it.	CRTADMDMN	None
Delete Administrative Domain Deletes the peer CRG representing the cluster administration domain. Upon completion all MREs are removed from the domain and changes to the resources that were being monitored will no longer be propagated.	DLTADMDMN	None

Table 4. Integrated Operating System API descriptions. In addition to these cluster administrative domain CL commands, there are also several Integrated Operating System application programmable interfaces (APIs) that provide the ability to add and remove monitored resource entries.
Description	CL Commands¹	Integrated Operating System API
Add Monitored Resource Entry Adds a monitored resource entry for a system resource and its attributes.	None	Add Monitored Resource Entry (QfpadAddMonitoredResourceEntry)
Remove Monitored Resource Entry Removes an Monitored Resource Entry (MRE) from the monitored resource directory.	None	Remove Monitored Resource Entry (QfpadRmvMonitoredResourceEntry)
Retrieve Monitored Resource Information Returns information about monitored resources.	None	Retrieve Monitored Resource Information (QfpadRtvMonitoredResourceInfo)
Note: There is no supported CL command equivalent for this function. The source for a non-supported command and call processing program (CPP) has been provided in the QUSRTOOL library. To learn about this command source and CPP, look at the member QFPADINFO in file QATTINFO.