286 lines
14 KiB
HTML
286 lines
14 KiB
HTML
<?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="topic" />
|
|
<meta name="DC.Title" content="Get Triggered Cache Manager Server Status (QzhtGetTCMServerStatus) API" />
|
|
<meta name="copyright" content="(C) Copyright IBM Corporation 2002,2006" />
|
|
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 2002,2006" />
|
|
<meta name="DC.Format" content="XHTML" />
|
|
<meta name="DC.Identifier" content="rzaieapi_qzhtgettcmserverstatus" />
|
|
<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>Get Triggered Cache Manager Server Status (QzhtGetTCMServerStatus)
|
|
API</title>
|
|
</head>
|
|
<body id="rzaieapi_qzhtgettcmserverstatus"><a name="rzaieapi_qzhtgettcmserverstatus"><!-- --></a>
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
|
<!--Java sync-link--><h1 class="topictitle1">Get Triggered Cache Manager Server Status (QzhtGetTCMServerStatus)
|
|
API</h1>
|
|
<div><div class="important"><span class="importanttitle">Important:</span> Information
|
|
for this topic supports the latest PTF levels for HTTP Server for i5/OS .
|
|
It is recommended that you install the latest PTFs to upgrade to the latest
|
|
level of the HTTP Server for i5/OS. Some of the topics documented here are
|
|
not available prior to this update. See <a href="http://www-03.ibm.com/servers/eserver/iseries/software/http/services/service.html" target="_blank">http://www.ibm.com/servers/eserver/iseries/software/http/services/service.htm</a> <img src="www.gif" alt="Link outside Information Center" /> for more information. </div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" class="figborder" frame="void" border="0" rules="none"><tbody><tr><td colspan="4" valign="top">Required Parameter Group:</td>
|
|
</tr>
|
|
<tr><td align="right" valign="top" width="6.313131313131313%">1</td>
|
|
<td valign="top" width="31.313131313131315%">receiver variable</td>
|
|
<td valign="top" width="31.060606060606062%">Output</td>
|
|
<td valign="top" width="31.313131313131315%">Char(*)</td>
|
|
</tr>
|
|
<tr><td align="right" valign="top" width="6.313131313131313%">2</td>
|
|
<td valign="top" width="31.313131313131315%">length of receiver variable</td>
|
|
<td valign="top" width="31.060606060606062%">Input</td>
|
|
<td valign="top" width="31.313131313131315%">Binary(4)</td>
|
|
</tr>
|
|
<tr><td align="right" valign="top" width="6.313131313131313%">3</td>
|
|
<td valign="top" width="31.313131313131315%">receiver variable format</td>
|
|
<td valign="top" width="31.060606060606062%">Input</td>
|
|
<td valign="top" width="31.313131313131315%">Char(8)</td>
|
|
</tr>
|
|
<tr><td align="right" valign="top" width="6.313131313131313%">4</td>
|
|
<td valign="top" width="31.313131313131315%">server name</td>
|
|
<td valign="top" width="31.060606060606062%">I/O</td>
|
|
<td valign="top" width="31.313131313131315%">Char(32)</td>
|
|
</tr>
|
|
<tr><td align="right" valign="top" width="6.313131313131313%">5</td>
|
|
<td valign="top" width="31.313131313131315%">error code</td>
|
|
<td valign="top" width="31.060606060606062%">I/O</td>
|
|
<td valign="top" width="31.313131313131315%">Char(*)</td>
|
|
</tr>
|
|
<tr><td colspan="4" valign="top">Library Name/Service Program: QTCM/QZHTINCONF</td>
|
|
</tr>
|
|
<tr><td colspan="4" valign="top">Threadsafe: Yes</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p>The <em>QzhtGetTCMServerStatus</em> API retrieves the current status (or
|
|
state) of triggered cache manager servers along with their respective autostart
|
|
property. The API is a callable service implemented as an ILE entry point
|
|
within QZHTINCONF *SRVPGM in QTCM *LIB. </p>
|
|
<p>The QTCM/H(QZHTINCONF) header file includes ILE C prototypes for this API.</p>
|
|
</div>
|
|
<div class="nested1" id="authoritylocks"><a name="authoritylocks"><!-- --></a><h2 class="topictitle2">Authorities and locks</h2>
|
|
<div><p>None.</p>
|
|
</div>
|
|
</div>
|
|
<div class="nested1" id="required"><a name="required"><!-- --></a><h2 class="topictitle2">Required parameter group</h2>
|
|
<div><dl><dt class="dlterm"><strong>receiver variable</strong></dt>
|
|
<dd>OUTPUT: CHAR(*) <p>The variable used to return the information indicating
|
|
the status and autostart property of triggered cache manager servers.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>length of receiver variable</strong></dt>
|
|
<dd>INPUT: BINARY(4)<p>The number of bytes that the calling program provides
|
|
for receiver variable. This value must be greater than or equal to 8.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>receiver variable format</strong></dt>
|
|
<dd>INPUT: CHAR(8) <p>The format name of Receiver variable data. The following
|
|
values must be used:</p>
|
|
<ul><li>INSG0100: Basic status information format for triggered cache manager
|
|
servers.</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>server name</strong></dt>
|
|
<dd>INPUT: CHAR(32) <p>The name used to identify the server for which the
|
|
status information is returned (left justified and padded with blanks if necessary).
|
|
The value must specify a server name, or be one of the special values described
|
|
below. </p>
|
|
<p>The special value and its meaning is as follows:</p>
|
|
<dl><dt class="dlterm"><strong>*ALL</strong></dt>
|
|
<dd>QZHT_ALL_CHAR: Status information for all triggered cache manager servers
|
|
returned.</dd>
|
|
</dl>
|
|
</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>error code</strong></dt>
|
|
<dd>I/O:CHAR(*) <p>The structure in which to return error information.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</div>
|
|
<div class="nested1" id="insg0100_format"><a name="insg0100_format"><!-- --></a><h2 class="topictitle2">INSG0100 format</h2>
|
|
<div>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th colspan="2" valign="top" id="d0e168">Offset</th>
|
|
<th rowspan="2" valign="top" id="d0e170">Type</th>
|
|
<th rowspan="2" valign="top" id="d0e172">Field</th>
|
|
</tr>
|
|
<tr><th valign="top" id="d0e175">Dec</th>
|
|
<th valign="top" id="d0e177">Hex</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td valign="top" headers="d0e168 d0e175 ">0</td>
|
|
<td valign="top" headers="d0e168 d0e177 ">0</td>
|
|
<td valign="top" headers="d0e170 ">Binary(4)</td>
|
|
<td valign="top" headers="d0e172 ">Bytes returned</td>
|
|
</tr>
|
|
<tr><td valign="top" headers="d0e168 d0e175 ">4</td>
|
|
<td valign="top" headers="d0e168 d0e177 ">4</td>
|
|
<td valign="top" headers="d0e170 ">Binary(4)</td>
|
|
<td valign="top" headers="d0e172 ">Bytes available</td>
|
|
</tr>
|
|
<tr><td valign="top" headers="d0e168 d0e175 ">8</td>
|
|
<td valign="top" headers="d0e168 d0e177 ">8</td>
|
|
<td valign="top" headers="d0e170 ">Binary(4)</td>
|
|
<td valign="top" headers="d0e172 ">Offset to server entries</td>
|
|
</tr>
|
|
<tr><td valign="top" headers="d0e168 d0e175 ">12</td>
|
|
<td valign="top" headers="d0e168 d0e177 ">C</td>
|
|
<td valign="top" headers="d0e170 ">Binary(4)</td>
|
|
<td valign="top" headers="d0e172 ">Number of server entries</td>
|
|
</tr>
|
|
<tr><td valign="top" headers="d0e168 d0e175 ">16</td>
|
|
<td valign="top" headers="d0e168 d0e177 ">10</td>
|
|
<td valign="top" headers="d0e170 ">Binary(4)</td>
|
|
<td valign="top" headers="d0e172 ">Length of server entry</td>
|
|
</tr>
|
|
<tr><td colspan="4" valign="top" headers="d0e168 d0e170 d0e172 d0e175 d0e177 "><strong>Server entries</strong><div class="note"><span class="notetitle">Note:</span> The following
|
|
entries are repeated for each set of server data returned.</div>
|
|
</td>
|
|
</tr>
|
|
<tr><td valign="top" headers="d0e168 d0e175 "> </td>
|
|
<td valign="top" headers="d0e168 d0e177 "> </td>
|
|
<td valign="top" headers="d0e170 ">Char(32)</td>
|
|
<td valign="top" headers="d0e172 ">Server name</td>
|
|
</tr>
|
|
<tr><td valign="top" headers="d0e168 d0e175 "> </td>
|
|
<td valign="top" headers="d0e168 d0e177 "> </td>
|
|
<td valign="top" headers="d0e170 ">Binary(4)</td>
|
|
<td valign="top" headers="d0e172 ">Autostart property</td>
|
|
</tr>
|
|
<tr><td valign="top" headers="d0e168 d0e175 "> </td>
|
|
<td valign="top" headers="d0e168 d0e177 "> </td>
|
|
<td valign="top" headers="d0e170 ">Binary(4)</td>
|
|
<td valign="top" headers="d0e172 ">Current state</td>
|
|
</tr>
|
|
<tr><td valign="top" headers="d0e168 d0e175 "> </td>
|
|
<td valign="top" headers="d0e168 d0e177 "> </td>
|
|
<td valign="top" headers="d0e170 ">Binary(4)</td>
|
|
<td valign="top" headers="d0e172 ">Local TCP port</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="nested1" id="field_descriptions"><a name="field_descriptions"><!-- --></a><h2 class="topictitle2">Field descriptions</h2>
|
|
<div><dl><dt class="dlterm"><strong>Bytes returned</strong></dt>
|
|
<dd>The number of information bytes returned to the caller of the API.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>Bytes available</strong></dt>
|
|
<dd>The number of information bytes available for return to the caller of
|
|
the API.<div class="note"><span class="notetitle">Note:</span> If this value is greater than the value of Bytes Returned, the
|
|
receiver variable was not large enough to return all information.</div>
|
|
</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>Offset to server entries</strong></dt>
|
|
<dd>The offset from the beginning of the receiver variable to the Server entries
|
|
data, in bytes.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>Number of server entries</strong></dt>
|
|
<dd>The number of entries returned in server entries.<div class="note"><span class="notetitle">Note:</span> If no servers exist,
|
|
the returned value equals 0 (QZHT_NONE).</div>
|
|
</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>Length of server entry</strong></dt>
|
|
<dd>The length of the information for each entry in server entries.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>Server name</strong></dt>
|
|
<dd>The name of the triggered cache manager server (left justified and padded
|
|
with blanks if necessary).</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>Autostart property</strong></dt>
|
|
<dd>Indicates whether the new triggered cache manager server is to start when
|
|
startup of *AUTOSTART triggered cache manager servers is requested. Usually
|
|
*AUTOSTART servers are requested to start when TCP/IP is started, however
|
|
they may also be requested via the STRTCPSVR command or QzhtStrTCMServer API. <p>Special
|
|
values and their meanings are as follows:</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.228426395939088%"><strong>1</strong></td>
|
|
<td valign="top" width="84.77157360406092%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The server is set
|
|
to start when startup of *AUTOSTART servers is requested.</td>
|
|
</tr>
|
|
<tr><td valign="top" width="15.228426395939088%"><strong>0</strong></td>
|
|
<td valign="top" width="84.77157360406092%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The server is not
|
|
set to start when startup of *AUTOSTART servers is requested.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>Current state</strong></dt>
|
|
<dd>The current sate of the triggered cache manager server identified by Server
|
|
name. The possible values are:
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.228426395939088%"><strong>1</strong></td>
|
|
<td valign="top" width="84.77157360406092%">QZHT_INACTIVE: The server is not active.</td>
|
|
</tr>
|
|
<tr><td valign="top" width="15.228426395939088%"><strong>2</strong></td>
|
|
<td valign="top" width="84.77157360406092%">QZHT_STARTING: The server is in the process of starting
|
|
up.</td>
|
|
</tr>
|
|
<tr><td valign="top" width="15.228426395939088%"><strong>3</strong></td>
|
|
<td valign="top" width="84.77157360406092%">QZHT_ACTIVE: The server is active.</td>
|
|
</tr>
|
|
<tr><td valign="top" width="15.228426395939088%"><strong>4</strong></td>
|
|
<td valign="top" width="84.77157360406092%">QZHT_ENDING: The server is in the process of shutting
|
|
down.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>Local TCP port</strong></dt>
|
|
<dd>The number of one of the TCP ports used by the triggered cache manager
|
|
server. The value will be greater than 0 and less than 65536.<div class="note"><span class="notetitle">Note:</span> Triggered
|
|
cache manager servers use the same port number for all IP interfaces.</div>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</div>
|
|
<div class="nested1" id="error"><a name="error"><!-- --></a><h2 class="topictitle2">Error messages</h2>
|
|
<div><dl><dt class="dlterm"><strong>TCM7030 E</strong></dt>
|
|
<dd>Severe error occurred while addressing parameter list.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>TCM7032 E</strong></dt>
|
|
<dd>Receiver variable format is not valid.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>TCM7034 E</strong></dt>
|
|
<dd>Length of receiver variable is not valid for the format specified.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>TCM7035 E</strong></dt>
|
|
<dd>Server parameter is not valid.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>TCM703E E</strong></dt>
|
|
<dd>Error code parameter is not valid.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>TCM70F0 E</strong></dt>
|
|
<dd>Unknown error occurred while processing request.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>TCM7390 E</strong></dt>
|
|
<dd>TCM server instance server &1 not found.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>TCM74C0 E</strong></dt>
|
|
<dd>TCM server instance server name is not valid.</dd>
|
|
</dl>
|
|
</div>
|
|
</div>
|
|
|
|
</body>
|
|
</html> |