friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
14ed2849c6
ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzaig_5.4.0.1/rzaigconfigapidescriptions.htm

442 lines
28 KiB
HTML
Raw Normal View History

Add readme and dist folders
2024-04-02 14:02:31 +00:00
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html lang="en-us" xml:lang="en-us">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="security" content="public" />
<meta name="Robots" content="index,follow" />
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
<meta name="DC.Type" content="concept" />
<meta name="DC.Title" content="Cluster CL command and API descriptions" />
<meta name="abstract" content="There are many APIs and CL commands that you can use for configuring, activating, and managing clusters, cluster nodes, and cluster resource groups." />
<meta name="description" content="There are many APIs and CL commands that you can use for configuring, activating, and managing clusters, cluster nodes, and cluster resource groups." />
<meta name="DC.Relation" scheme="URI" content="rzaigconfigapicl.htm" />
<meta name="DC.Relation" scheme="URI" content="../apis/clust1a1.htm" />
<meta name="copyright" content="(C) Copyright IBM Corporation 1998, 2006" />
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 1998, 2006" />
<meta name="DC.Format" content="XHTML" />
<meta name="DC.Identifier" content="rzaigconfigapidescriptions" />
<meta name="DC.Language" content="en-us" />
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
<link rel="stylesheet" type="text/css" href="./ic.css" />
<title>Cluster CL command and API descriptions</title>
</head>
<body id="rzaigconfigapidescriptions"><a name="rzaigconfigapidescriptions"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">Cluster CL command and API descriptions</h1>
<div><p>There are many APIs and CL commands that you can use for configuring,
activating, and managing clusters, cluster nodes, and cluster resource groups.</p>
<p>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<sup>®</sup> V5R2M0
or later.</p>
<p><img src="./delta.gif" alt="Start of change" />The first table contains commands and APIs for configuring,
activating, and managing a <span class="uicontrol">cluster and the nodes</span> in
a cluster. The second table contains commands and APIs for configuring, activating,
and managing <span class="uicontrol">cluster resource groups</span> in a cluster.
The third table contains commands for configuring and managing a <span class="uicontrol">cluster
administrative domain</span>. 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.<img src="./deltaend.gif" alt="End of change" /></p>
<div class="tablenoborder"><a name="rzaigconfigapidescriptions__clustertable1"><!-- --></a><table cellpadding="4" cellspacing="0" summary="" id="rzaigconfigapidescriptions__clustertable1" frame="border" border="1" rules="all"><caption>Table 1. Cluster Control CL Command and API Descriptions</caption><thead align="left"><tr><th valign="top" width="40%" id="d0e40">Description</th>
<th valign="top" width="20%" id="d0e42">Cluster Control CL Command</th>
<th valign="top" width="40%" id="d0e44">Cluster Control API Name</th>
</tr>
</thead>
<tbody><tr><td valign="top" width="40%" headers="d0e40 "><dl><dt class="dlterm">Add Cluster Node Entry</dt>
<dd>Adds a node to the membership list of an existing cluster. Also assigns
the IP interface addresses to be used by cluster communications.</dd>
</dl>
</td>
<td valign="top" width="20%" headers="d0e42 "><a href="../cl/addclunode.htm">ADDCLUNODE</a></td>
<td valign="top" width="40%" headers="d0e44 "><a href="../apis/clcntaddcne.htm">Add Cluster Node
Entry (QcstAddClusterNodeEntry)</a></td>
</tr>
<tr><td valign="top" width="40%" headers="d0e40 "><dl><dt class="dlterm">Add Device Domain Entry</dt>
<dd>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.</dd>
</dl>
</td>
<td valign="top" width="20%" headers="d0e42 "><a href="../cl/adddevdmne.htm">ADDDEVDMNE</a></td>
<td valign="top" width="40%" headers="d0e44 "><a href="../apis/clcntadddde.htm">Add Device Domain
Entry (QcstAddDeviceDomainEntry)</a></td>
</tr>
<tr><td valign="top" width="40%" headers="d0e40 "><dl><dt class="dlterm">Adjust Cluster Version, Change Cluster Version</dt>
<dd>Adjusts the current cluster version to the next level, for example, so
that new function can be used within the cluster.</dd>
</dl>
</td>
<td valign="top" width="20%" headers="d0e42 "><a href="../cl/chgcluver.htm">CHGCLUVER</a></td>
<td valign="top" width="40%" headers="d0e44 "><a href="../apis/clcntchgcv.htm">Adjust Cluster Version
(QcstAdjustClusterVersion)</a> </td>
</tr>
<tr><td valign="top" width="40%" headers="d0e40 "><dl><dt class="dlterm">Change Cluster Node Entry</dt>
<dd>Changes the fields in the cluster node entry. For example, the IP interface
addresses used for cluster communications can be changed.</dd>
</dl>
</td>
<td valign="top" width="20%" headers="d0e42 "><a href="../cl/chgclunode.htm">CHGCLUNODE</a></td>
<td valign="top" width="40%" headers="d0e44 "><a href="../apis/clcntchgcne.htm">Change Cluster Node
Entry (QcstChangeClusterNodeEntry)</a></td>
</tr>
<tr><td valign="top" width="40%" headers="d0e40 "><dl><dt class="dlterm">Change Cluster Resource Services, Change Cluster Configuration </dt>
<dd>Adjusts cluster performance and configuration tuning parameters to match
the communications environment of the network used for cluster communications.</dd>
</dl>
</td>
<td valign="top" width="20%" headers="d0e42 "><a href="../cl/chgclucfg.htm">CHGCLUCFG</a></td>
<td valign="top" width="40%" headers="d0e44 "><a href="../apis/clcntchgcrs.htm">Change Cluster Resource
Services (QcstChgClusterResourceServices)</a></td>
</tr>
<tr><td valign="top" width="40%" headers="d0e40 "><dl><dt class="dlterm">Create Cluster</dt>
<dd>Creates a new cluster of one or more nodes.</dd>
</dl>
</td>
<td valign="top" width="20%" headers="d0e42 "><a href="../cl/crtclu.htm">CRTCLU</a></td>
<td valign="top" width="40%" headers="d0e44 "><a href="../apis/clcntcrtc.htm">Create Cluster (QcstCreateCluster)</a></td>
</tr>
<tr><td valign="top" width="40%" headers="d0e40 "><dl><dt class="dlterm">Delete Cluster</dt>
<dd>Deletes an existing cluster. Cluster resource services is ended on all
active cluster nodes and they are removed from the cluster.</dd>
</dl>
</td>
<td valign="top" width="20%" headers="d0e42 "><a href="../cl/dltclu.htm">DLTCLU</a></td>
<td valign="top" width="40%" headers="d0e44 "><a href="../apis/clcntdltc.htm">Delete Cluster (QcstDeleteCluster)</a></td>
</tr>
<tr><td valign="top" width="40%" headers="d0e40 "><dl><dt class="dlterm">End Cluster Node</dt>
<dd>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.</dd>
</dl>
</td>
<td valign="top" width="20%" headers="d0e42 "><a href="../cl/endclunod.htm">ENDCLUNOD</a></td>
<td valign="top" width="40%" headers="d0e44 "><a href="../apis/clcntendcn.htm">End Cluster Node
(QcstEndClusterNode)</a></td>
</tr>
<tr><td valign="top" width="40%" headers="d0e40 "><dl><dt class="dlterm">List Cluster Information, Display Cluster Information</dt>
<dd>Retrieves information about a cluster. For example, the complete cluster
membership list can be returned.</dd>
</dl>
</td>
<td valign="top" width="20%" headers="d0e42 "><a href="../cl/dspcluinf.htm">DSPCLUINF</a></td>
<td valign="top" width="40%" headers="d0e44 "><a href="../apis/clcntlstci.htm">List Cluster Information
(QcstListClusterInfo)</a></td>
</tr>
<tr><td valign="top" width="40%" headers="d0e40 "><dl><dt class="dlterm">List Device Domain Information, Display Cluster Information</dt>
<dd>Lists device domain information of a cluster. For example, the list of
currently defined device domains can be returned.</dd>
</dl>
</td>
<td valign="top" width="20%" headers="d0e42 "><a href="../cl/dspcluinf.htm">DSPCLUINF</a></td>
<td valign="top" width="40%" headers="d0e44 "><a href="../apis/clcntlstddi.htm">List Device Domain
Information (QcstListDeviceDomainInfo)</a></td>
</tr>
<tr><td valign="top" width="40%" headers="d0e40 "><dl><dt class="dlterm">Remove Cluster Node Entry</dt>
<dd>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.</dd>
</dl>
</td>
<td valign="top" width="20%" headers="d0e42 "><a href="../cl/rmvclunode.htm">RMVCLUNODE</a></td>
<td valign="top" width="40%" headers="d0e44 "><a href="../apis/clcntrmvcne.htm">Remove Cluster Node
Entry (QcstRemoveClusterNodeEntry)</a></td>
</tr>
<tr><td valign="top" width="40%" headers="d0e40 "><dl><dt class="dlterm">Remove Device Domain Entry</dt>
<dd>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.</dd>
</dl>
</td>
<td valign="top" width="20%" headers="d0e42 "><a href="../cl/rmvdevdmne.htm">RMVDEVDMNE</a></td>
<td valign="top" width="40%" headers="d0e44 "><a href="../apis/clcntrmvdde.htm">Remove
Device Domain Entry (QcstRemoveDeviceDomainEntry)</a></td>
</tr>
<tr><td valign="top" width="40%" headers="d0e40 "><dl><dt class="dlterm">Retrieve Cluster Information, Display Cluster Information</dt>
<dd>Retrieves information about a cluster. For example, the cluster name and
current cluster version are returned.</dd>
</dl>
</td>
<td valign="top" width="20%" headers="d0e42 "><a href="../cl/dspcluinf.htm">DSPCLUINF</a></td>
<td valign="top" width="40%" headers="d0e44 "><a href="../apis/clcntrtvci.htm">Retrieve
Cluster Information (QcstRetrieveClusterInfo)</a></td>
</tr>
<tr><td valign="top" width="40%" headers="d0e40 "><dl><dt class="dlterm">Retrieve Cluster Resource Services Information, Display Cluster Information</dt>
<dd>Retrieves information about the cluster resource services performance
tuning and configuration parameters.</dd>
</dl>
</td>
<td valign="top" width="20%" headers="d0e42 "><a href="../cl/dspcluinf.htm">DSPCLUINF</a></td>
<td valign="top" width="40%" headers="d0e44 "><a href="../apis/clcntrtcrs.htm">Retrieve Cluster
Resource Services Information (QcstRetrieveCRSInfo)</a></td>
</tr>
<tr><td valign="top" width="40%" headers="d0e40 "><dl><dt class="dlterm">Start Cluster Node</dt>
<dd>Starts cluster resource services on a node that is part of a cluster but
is currently not active.</dd>
</dl>
</td>
<td valign="top" width="20%" headers="d0e42 "><a href="../cl/strclunod.htm">STRCLUNOD</a></td>
<td valign="top" width="40%" headers="d0e44 "><a href="../apis/clcntstcn.htm">Start Cluster Node
(QcstStartClusterNode)</a></td>
</tr>
<tr><td valign="top" width="40%" headers="d0e40 "><img src="./delta.gif" alt="Start of change" /><dl><dt class="dlterm">Work with Cluster</dt>
<dd><img src="./delta.gif" alt="Start of change" />Displays and works with cluster nodes and objects.<img src="./deltaend.gif" alt="End of change" /></dd>
</dl>
<img src="./deltaend.gif" alt="End of change" /></td>
<td valign="top" width="20%" headers="d0e42 "><img src="./delta.gif" alt="Start of change" /><a href="../cl/wrkclu.htm">WRKCLU</a><img src="./deltaend.gif" alt="End of change" /></td>
<td valign="top" width="40%" headers="d0e44 "><img src="./delta.gif" alt="Start of change" />none<img src="./deltaend.gif" alt="End of change" /></td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="rzaigconfigapidescriptions__clustertable2"><!-- --></a><table cellpadding="4" cellspacing="0" summary="" id="rzaigconfigapidescriptions__clustertable2" frame="border" border="1" rules="all"><caption>Table 2. Cluster Resource Group CL Command and API
Descriptions</caption><thead align="left"><tr><th valign="top" width="40%" id="d0e280">Description</th>
<th valign="top" width="20%" id="d0e282">Cluster Resource Group CL Command</th>
<th valign="top" width="40%" id="d0e284">Cluster Resource Group API</th>
</tr>
</thead>
<tbody><tr><td valign="top" width="40%" headers="d0e280 "><dl><dt class="dlterm">Add Cluster Resource Group Device Entry</dt>
<dd>Adds a new device entry to a cluster resource group. The device becomes
a member of the group of switchable devices.</dd>
</dl>
</td>
<td valign="top" width="20%" headers="d0e282 "><a href="../cl/addcrgdeve.htm">ADDCRGDEVE</a></td>
<td valign="top" width="40%" headers="d0e284 "><a href="../apis/clrgadddevent.htm">Add Cluster Resource
Group Device Entry (QcstAddClusterResourceGroupDevice)</a></td>
</tr>
<tr><td valign="top" width="40%" headers="d0e280 "><dl><dt class="dlterm"><img src="./delta.gif" alt="Start of change" />Add Node to Recovery Domain, Add Cluster Resource Group
Node Entry<img src="./deltaend.gif" alt="End of change" /></dt>
<dd>Adds a new node to the recovery domain of an existing cluster resource
group.</dd>
</dl>
</td>
<td valign="top" width="20%" headers="d0e282 "><a href="../cl/addcrgnode.htm">ADDCRGNODE</a></td>
<td valign="top" width="40%" headers="d0e284 "><a href="../apis/clrgaddnrd.htm">Add Node to Recovery
Domain (QcstAddNodeToRcvyDomain)</a></td>
</tr>
<tr><td valign="top" width="40%" headers="d0e280 "><dl><dt class="dlterm">Change Cluster Resource Group</dt>
<dd>Changes attributes of a cluster resource group. For example, the takeover
IP address for an application CRG can be modified.</dd>
</dl>
</td>
<td valign="top" width="20%" headers="d0e282 "><a href="../cl/chgcrg.htm">CHGCRG</a></td>
<td valign="top" width="40%" headers="d0e284 "><a href="../apis/clrgchgcrg.htm">Change Cluster Resource
Group (QcstChangeClusterResourceGroup)</a></td>
</tr>
<tr><td valign="top" width="40%" headers="d0e280 "><dl><dt class="dlterm">Change Cluster Resource Group Device Entry</dt>
<dd>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.</dd>
</dl>
</td>
<td valign="top" width="20%" headers="d0e282 "><a href="../cl/chgcrgdeve.htm">CHGCRGDEVE</a></td>
<td valign="top" width="40%" headers="d0e284 "><a href="../apis/clrgchgdevent.htm">Change Cluster
Resource Group Device Entry (QcstChangeClusterResourceGroupDev)</a></td>
</tr>
<tr><td valign="top" width="40%" headers="d0e280 "><dl><dt class="dlterm">Create Cluster Resource Group</dt>
<dd>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.</dd>
</dl>
</td>
<td valign="top" width="20%" headers="d0e282 "><a href="../cl/crtcrg.htm">CRTCRG</a></td>
<td valign="top" width="40%" headers="d0e284 "><a href="../apis/clrgcrtcrg.htm">Create Cluster Resource
Group (QcstCreateClusterResourceGroup)</a></td>
</tr>
<tr><td valign="top" width="40%" headers="d0e280 "><img src="./delta.gif" alt="Start of change" /><dl><dt class="dlterm">Delete Cluster Resource Group</dt>
<dd>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. </dd>
</dl>
<img src="./deltaend.gif" alt="End of change" /></td>
<td valign="top" width="20%" headers="d0e282 "><img src="./delta.gif" alt="Start of change" /><a href="../cl/dltcrg.htm">DLTCRG</a><img src="./deltaend.gif" alt="End of change" /></td>
<td valign="top" width="40%" headers="d0e284 "><img src="./delta.gif" alt="Start of change" />none<img src="./deltaend.gif" alt="End of change" /></td>
</tr>
<tr><td valign="top" width="40%" headers="d0e280 "><img src="./delta.gif" alt="Start of change" /><dl><dt class="dlterm">Delete Cluster Resource Group, Delete CRG Cluster</dt>
<dd>Deletes a cluster resource group from the cluster. The CRG object will
be deleted from all active nodes in the recovery domain.</dd>
</dl>
<img src="./deltaend.gif" alt="End of change" /></td>
<td valign="top" width="20%" headers="d0e282 "><img src="./delta.gif" alt="Start of change" /><a href="../cl/dltcrgclu.htm">DLTCRGCLU</a><img src="./deltaend.gif" alt="End of change" /></td>
<td valign="top" width="40%" headers="d0e284 "><img src="./delta.gif" alt="Start of change" /><a href="../apis/clrgdltcrg.htm">Delete Cluster Resource
Group (QcstDeleteClusterResourceGroup)</a><img src="./deltaend.gif" alt="End of change" /></td>
</tr>
<tr><td valign="top" width="40%" headers="d0e280 "><dl><dt class="dlterm">Distribute Information</dt>
<dd>Delivers information from a node in the recovery domain of a CRG to other
nodes in that CRG's recovery domain.</dd>
</dl>
</td>
<td valign="top" width="20%" headers="d0e282 ">none</td>
<td valign="top" width="40%" headers="d0e284 "><a href="../apis/cldistinfo.htm">Distribute Information
(QcstDistributeInformation)</a> </td>
</tr>
<tr><td valign="top" width="40%" headers="d0e280 "><dl><dt class="dlterm">End Cluster Resource Group</dt>
<dd>Disables resiliency of the specified cluster resource group. Upon successful
completion of this API, the cluster resource group status is set to inactive.</dd>
</dl>
</td>
<td valign="top" width="20%" headers="d0e282 "><a href="../cl/endcrg.htm">ENDCRG</a></td>
<td valign="top" width="40%" headers="d0e284 "><a href="../apis/clrgendcrg.htm">End Cluster Resource
Group (QcstEndClusterResourceGroup)</a></td>
</tr>
<tr><td valign="top" width="40%" headers="d0e280 "><dl><dt class="dlterm">Initiate Switchover, Change Cluster Resource Group Primary</dt>
<dd>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.</dd>
</dl>
</td>
<td valign="top" width="20%" headers="d0e282 "><a href="../cl/chgcrgpri.htm">CHGCRGPRI</a></td>
<td valign="top" width="40%" headers="d0e284 "><a href="../apis/clrginitso.htm">Initiate Switchover
(QcstInitiateSwitchover)</a></td>
</tr>
<tr><td valign="top" width="40%" headers="d0e280 "><dl><dt class="dlterm"><img src="./delta.gif" alt="Start of change" />List Cluster Resource Groups, Display Cluster Resource
Group Information<img src="./deltaend.gif" alt="End of change" /></dt>
<dd>Generates a list of cluster resource groups and some information about
the cluster resource group in the cluster.</dd>
</dl>
</td>
<td valign="top" width="20%" headers="d0e282 "><a href="../cl/dspcrginf.htm">DSPCRGINF</a></td>
<td valign="top" width="40%" headers="d0e284 "><a href="../apis/clrglstcrg.htm">List Cluster Resource
Groups (QcstListClusterResourceGroups)</a></td>
</tr>
<tr><td valign="top" width="40%" headers="d0e280 "><dl><dt class="dlterm">List Cluster Resource Group Information, Display Cluster Resource Group
Information</dt>
<dd>Returns the contents of a cluster resource group object. For example,
the recovery domain with the current node roles can be returned.</dd>
</dl>
</td>
<td valign="top" width="20%" headers="d0e282 "><a href="../cl/dspcrginf.htm">DSPCRGINF</a></td>
<td valign="top" width="40%" headers="d0e284 "><a href="../apis/clrglstcrgi.htm">List Cluster Resource
Group Information (QcstListClusterResourceGroupInf)</a></td>
</tr>
<tr><td valign="top" width="40%" headers="d0e280 "><dl><dt class="dlterm">Remove Cluster Resource Group Device Entry</dt>
<dd>Removes a device entry from a cluster resource group. The device will
no longer be a switchable resource.</dd>
</dl>
</td>
<td valign="top" width="20%" headers="d0e282 "><a href="../cl/rmvcrgdeve.htm">RMVCRGDEVE</a></td>
<td valign="top" width="40%" headers="d0e284 "><a href="../apis/clrgrmvdevent.htm">Remove Cluster
Resource Group Device Entry (QcstRemoveClusterResourceGroupDev)</a></td>
</tr>
<tr><td valign="top" width="40%" headers="d0e280 "><dl><dt class="dlterm"><img src="./delta.gif" alt="Start of change" />Remove Node From Recovery Domain, Remove Cluster Resource
Group Node Entry<img src="./deltaend.gif" alt="End of change" /></dt>
<dd>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.</dd>
</dl>
</td>
<td valign="top" width="20%" headers="d0e282 "><a href="../cl/rmvcrgnode.htm">RMVCRGNODE</a></td>
<td valign="top" width="40%" headers="d0e284 "><a href="../apis/clrgrmvnrd.htm">Remove Node From
Recovery Domain (QcstRemoveNodeFromRcvyDomain)</a></td>
</tr>
<tr><td valign="top" width="40%" headers="d0e280 "><dl><dt class="dlterm">Start Cluster Resource Group</dt>
<dd>Enables resiliency for the specified cluster resource group. The cluster
resource group becomes active within the cluster.</dd>
</dl>
</td>
<td valign="top" width="20%" headers="d0e282 "><a href="../cl/strcrg.htm">STRCRG</a></td>
<td valign="top" width="40%" headers="d0e284 "><a href="../apis/clrgstcrg.htm">Start Cluster Resource
Group (QcstStartClusterResourceGroup)</a></td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> 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.</div>
<div class="tablenoborder"><img src="./delta.gif" alt="Start of change" /><a name="rzaigconfigapidescriptions__clustertable3"><!-- --></a><table cellpadding="4" cellspacing="0" summary="" id="rzaigconfigapidescriptions__clustertable3" frame="border" border="1" rules="all"><caption>Table 3. Administrative Domain CL Command
Descriptions</caption><thead align="left"><tr><th valign="top" width="31.718061674008812%" id="d0e507">Description</th>
<th valign="top" width="34.140969162995596%" id="d0e509">Administrative Domain CL Command</th>
<th valign="top" width="34.140969162995596%" id="d0e511">Administrative Domain APIs</th>
</tr>
</thead>
<tbody><tr><td valign="top" width="31.718061674008812%" headers="d0e507 "><dl><dt class="dlterm">Create Administrative Domain</dt>
<dd>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. <div class="note"><span class="notetitle">Note:</span> Once the
cluster administrative domain is created you can use the CRG commands in <a href="#rzaigconfigapidescriptions__clustertable2">Table 2</a> to manage it.</div>
</dd>
</dl>
</td>
<td valign="top" width="34.140969162995596%" headers="d0e509 "><img src="./delta.gif" alt="Start of change" /><a href="../cl/crtadmdmn.htm">CRTADMDMN</a><img src="./deltaend.gif" alt="End of change" /></td>
<td valign="top" width="34.140969162995596%" headers="d0e511 ">None</td>
</tr>
<tr><td valign="top" width="31.718061674008812%" headers="d0e507 "><dl><dt class="dlterm">Delete Administrative Domain</dt>
<dd><img src="./delta.gif" alt="Start of change" />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.<img src="./deltaend.gif" alt="End of change" /></dd>
</dl>
</td>
<td valign="top" width="34.140969162995596%" headers="d0e509 "><a href="../cl/dltadmdmn.htm">DLTADMDMN</a></td>
<td valign="top" width="34.140969162995596%" headers="d0e511 ">None</td>
</tr>
</tbody>
</table>
<img src="./deltaend.gif" alt="End of change" /></div>
<div class="tablenoborder"><img src="./delta.gif" alt="Start of change" /><a name="rzaigconfigapidescriptions__clustertable4"><!-- --></a><table cellpadding="4" cellspacing="0" summary="" id="rzaigconfigapidescriptions__clustertable4" frame="border" border="1" rules="all"><caption>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. </caption><thead align="left"><tr><th valign="top" width="32.50564334085779%" id="d0e556">Description</th>
<th valign="top" width="32.50564334085779%" id="d0e558">CL Commands<sup>1</sup></th>
<th valign="top" width="34.988713318284425%" id="d0e562">Integrated Operating System API </th>
</tr>
</thead>
<tbody><tr><td valign="top" width="32.50564334085779%" headers="d0e556 "><img src="./delta.gif" alt="Start of change" /><dl><dt class="dlterm">Add Monitored Resource Entry</dt>
<dd>Adds a monitored resource entry for a system resource and its attributes.</dd>
</dl><img src="./deltaend.gif" alt="End of change" />
</td>
<td valign="top" width="32.50564334085779%" headers="d0e558 ">None</td>
<td valign="top" width="34.988713318284425%" headers="d0e562 "><img src="./delta.gif" alt="Start of change" /><a href="../apis/qfpaadde.htm">Add
Monitored Resource Entry (QfpadAddMonitoredResourceEntry)</a><img src="./deltaend.gif" alt="End of change" /></td>
</tr>
<tr><td valign="top" width="32.50564334085779%" headers="d0e556 "><dl><dt class="dlterm">Remove Monitored Resource Entry </dt>
<dd><img src="./delta.gif" alt="Start of change" />Removes an Monitored Resource Entry (MRE) from the monitored
resource directory. <img src="./deltaend.gif" alt="End of change" /></dd>
</dl>
</td>
<td valign="top" width="32.50564334085779%" headers="d0e558 ">None</td>
<td valign="top" width="34.988713318284425%" headers="d0e562 "><a href="../apis/qfparmve.htm">Remove Monitored Resource
Entry (QfpadRmvMonitoredResourceEntry)</a></td>
</tr>
<tr><td valign="top" width="32.50564334085779%" headers="d0e556 "><dl><dt class="dlterm">Retrieve Monitored Resource Information </dt>
<dd><img src="./delta.gif" alt="Start of change" />Returns information about monitored resources.<img src="./deltaend.gif" alt="End of change" /></dd>
</dl>
</td>
<td valign="top" width="32.50564334085779%" headers="d0e558 ">None</td>
<td valign="top" width="34.988713318284425%" headers="d0e562 "><a href="../apis/qfpartve.htm">Retrieve
Monitored Resource Information (QfpadRtvMonitoredResourceInfo)</a></td>
</tr>
<tr><td colspan="3" valign="top" headers="d0e556 d0e558 d0e562 "><div class="note"><span class="notetitle">Note:</span> <ol><li>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.</li>
</ol>
</div>
</td>
</tr>
</tbody>
</table>
<img src="./deltaend.gif" alt="End of change" /></div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaigconfigapicl.htm" title="i5/OS cluster resource services provides a set of control language (CL) commands, application program interfaces (APIs) and facilities that can be used by iSeries application providers or customers to enhance their application availability.">Cluster commands and APIs</a></div>
</div>
<div class="relref"><strong>Related reference</strong><br />
<div><a href="../apis/clust1a1.htm">Cluster APIs</a></div>
</div>
</div>
</body>
</html>
Reference in New Issue Copy Permalink