friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
master
ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzaie_5.4.0.1/rzaieapi_qzhtchgtcmbasicconfig.htm

338 lines
17 KiB
HTML
Raw Permalink Blame History

<?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="Change Triggered Cache Manager Basic Configuration (QzhtChgTCMBasicConfig) 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_qzhtchgtcmbasicconfig" />
<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>Change Triggered Cache Manager Basic Configuration (QzhtChgTCMBasicConfig)
API</title>
</head>
<body id="rzaieapi_qzhtchgtcmbasicconfig"><a name="rzaieapi_qzhtchgtcmbasicconfig"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<!--Java sync-link--><h1 class="topictitle1">Change Triggered Cache Manager Basic Configuration (QzhtChgTCMBasicConfig)
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%">request variable</td>
<td valign="top" width="31.060606060606062%">Input</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 request 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%">request 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%">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>Use the QzhtChgTCMBasicConfig API to change the basic configuration information
for a triggered cache manager server. The API is a callable service implemented
as an ILE entry point within the QZHTINCONF *SRVPGM in the 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><ul><li>*IOSYSCFG special authority</li>
</ul>
</div>
</div>
<div class="nested1" id="required"><a name="required"><!-- --></a><h2 class="topictitle2">Required parameter group</h2>
<div><dl><dt class="dlterm"><strong>request variable</strong></dt>
<dd>INPUT: CHAR(*) <p>The variable used to pass the information used to change
the basic configuration information for a triggered cache manager server.</p>
</dd>
</dl>
<dl><dt class="dlterm"><strong>length of request variable</strong></dt>
<dd>INPUT: BINARY(4)<p> The number of bytes that the calling program provides
for request variable.</p>
</dd>
</dl>
<dl><dt class="dlterm"><strong>request variable format</strong></dt>
<dd>INPUT: CHAR(8) <p>The format name of the request variable data. The following
values must be used:</p>
<ul><li>INDP0200: Detailed information format for server data.</li>
</ul>
</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="indp0200_format"><a name="indp0200_format"><!-- --></a><h2 class="topictitle2">INDP0200 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="d0e139">Offset</th>
<th rowspan="2" valign="top" id="d0e141">Type</th>
<th rowspan="2" valign="top" id="d0e143">Field</th>
</tr>
<tr><th valign="top" id="d0e146">Dec</th>
<th valign="top" id="d0e148">Hex</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e139 d0e146 ">0</td>
<td valign="top" headers="d0e139 d0e148 ">0</td>
<td valign="top" headers="d0e141 ">Char(32)</td>
<td valign="top" headers="d0e143 ">Server name</td>
</tr>
<tr><td valign="top" headers="d0e139 d0e146 ">32</td>
<td valign="top" headers="d0e139 d0e148 ">20</td>
<td valign="top" headers="d0e141 ">Binary(4)</td>
<td valign="top" headers="d0e143 ">Autostart property</td>
</tr>
<tr><td valign="top" headers="d0e139 d0e146 ">36</td>
<td valign="top" headers="d0e139 d0e148 ">24</td>
<td valign="top" headers="d0e141 ">Binary(4)</td>
<td valign="top" headers="d0e143 ">Local TCP port</td>
</tr>
<tr><td valign="top" headers="d0e139 d0e146 ">40</td>
<td valign="top" headers="d0e139 d0e148 ">28</td>
<td valign="top" headers="d0e141 ">Binary(4)</td>
<td valign="top" headers="d0e143 ">Offset to root directory</td>
</tr>
<tr><td valign="top" headers="d0e139 d0e146 ">44</td>
<td valign="top" headers="d0e139 d0e148 ">2C</td>
<td valign="top" headers="d0e141 ">Binary(4)</td>
<td valign="top" headers="d0e143 ">Length of root directory</td>
</tr>
<tr><td valign="top" headers="d0e139 d0e146 ">48</td>
<td valign="top" headers="d0e139 d0e148 ">30</td>
<td valign="top" headers="d0e141 ">Binary(4)</td>
<td valign="top" headers="d0e143 ">Maximum number of retries</td>
</tr>
<tr><td valign="top" headers="d0e139 d0e146 ">52</td>
<td valign="top" headers="d0e139 d0e148 ">34</td>
<td valign="top" headers="d0e141 ">Binary(4)</td>
<td valign="top" headers="d0e143 ">Defer time between retries</td>
</tr>
<tr><td valign="top" headers="d0e139 d0e146 ">56</td>
<td valign="top" headers="d0e139 d0e148 ">38</td>
<td valign="top" headers="d0e141 ">Binary(4)</td>
<td valign="top" headers="d0e143 ">Memory buffer size</td>
</tr>
<tr><td valign="top" headers="d0e139 d0e146 ">&nbsp;</td>
<td valign="top" headers="d0e139 d0e148 ">&nbsp;</td>
<td valign="top" headers="d0e141 ">Char(*)</td>
<td valign="top" headers="d0e143 ">Root directory</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>Autostart property</strong></dt>
<dd>Specifies if 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. The default
value is 0 (QZHT_NO). <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="16.06217616580311%"><strong>1</strong></td>
<td valign="top" width="83.93782383419689%">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="16.06217616580311%"><strong>0</strong></td>
<td valign="top" width="83.93782383419689%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The server is not
set to start when startup of *AUTOSTART servers is requested.</td>
</tr>
<tr><td valign="top" width="16.06217616580311%"><strong>-1</strong></td>
<td valign="top" width="83.93782383419689%">QZHT_DEFAULT: The default value is used.</td>
</tr>
<tr><td valign="top" width="16.06217616580311%"><strong>-2</strong></td>
<td valign="top" width="83.93782383419689%">QZHT_NO_CHANGE: No change is made to the current auto
start setting.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Defer time between retries</strong></dt>
<dd>The number of seconds the triggered cache manager server is to wait between
retry attempts for a failing action. The value must be greater than 0 and
less than 2<sup>31</sup> (or 2.147x10<sup>9</sup>), or equal to one of the
special values described below. The default value is 60. <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="16.06217616580311%"><strong>0</strong></td>
<td valign="top" width="83.93782383419689%">QZHT_NONE: No defer time is to be used.</td>
</tr>
<tr><td valign="top" width="16.06217616580311%"><strong>-1</strong></td>
<td valign="top" width="83.93782383419689%">QZHT_DEFAULT: The default value is to be used.</td>
</tr>
<tr><td valign="top" width="16.06217616580311%"><strong>-2</strong></td>
<td valign="top" width="83.93782383419689%">QZHT_NO_CHANGE: The current defer time value is not
to be changed.</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> If maximum number of retries is equal to 0 (QZHT_NONE), this
value must be equal to 0 (QZHT_NONE).</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Length of root directory</strong></dt>
<dd>The length of the information for the root directory entry.<div class="note"><span class="notetitle">Note:</span> If offset
to root directory is equal to 0 (QZHT_NONE), -1 (QZHT_DEFAULT), or -2 (QZHT_NO_CHANGE),
this value must be equal to 0.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Maximum number of retries</strong></dt>
<dd>The maximum number of time the server will attempt to retry a failing
action. The value must be greater than 0 and less than 2<sup>31</sup> (or
2.147x10<sup>9</sup>), or equal to one of the special values described below.
The default is to retry failing actions until successful (QZHT_NOMAX). <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="16.06217616580311%"><strong>0</strong></td>
<td valign="top" width="83.93782383419689%">QZHT_NONE: Do not retry failing actions.</td>
</tr>
<tr><td valign="top" width="16.06217616580311%"><strong>-1</strong></td>
<td valign="top" width="83.93782383419689%">QZHT_DEFAULT: The default action is specified.</td>
</tr>
<tr><td valign="top" width="16.06217616580311%"><strong>-2</strong></td>
<td valign="top" width="83.93782383419689%">QZHT_NO_CHANGE: The current maximum number of retries
value is not to be changed.</td>
</tr>
<tr><td valign="top" width="16.06217616580311%"><strong>-3</strong></td>
<td valign="top" width="83.93782383419689%">QZHT_NOMAX: Failing actions are to be retried until
successful.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Memory buffer size</strong></dt>
<dd>The maximum amount of working data the triggered cache manager server
attempts to store in memory, in bytes. The value must be greater than -1 and
less than 2<sup>31</sup> (or 2.147x10<sup>9</sup>), or equal to one of the
special values described below. A value equal to <strong>0</strong> indicates that the
new triggered cache manager server should attempt to run in the least memory
possible. The default value is 10,000,000 (or 1x10<sup>7</sup>).<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="16.06217616580311%"><strong>-1</strong></td>
<td valign="top" width="83.93782383419689%">QZHT_DEFAULT: The default value is to be used.</td>
</tr>
<tr><td valign="top" width="16.06217616580311%"><strong>-2</strong></td>
<td valign="top" width="83.93782383419689%">QZHT_NO_CHANGE: The current memory buffer size value
is not to be changed.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Offset to root directory</strong></dt>
<dd>The offset from the beginning of the request variable to the Root directory
data, in bytes. The value must be greater than 0, or equal to one of the special
values described below. <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="16.06217616580311%"><strong>0</strong></td>
<td valign="top" width="83.93782383419689%">QZHT_NONE: Same as -2 (QZHT_NO_CHANGE).</td>
</tr>
<tr><td valign="top" width="16.06217616580311%"><strong>-1</strong></td>
<td valign="top" width="83.93782383419689%">QZHT_DEFAULT: The default value is to be used for Root
directory. The value for Root directory is null.</td>
</tr>
<tr><td valign="top" width="16.06217616580311%"><strong>-2</strong></td>
<td valign="top" width="83.93782383419689%">QZHT_NO_CHANGE: The current root directory name is not
to be changed for Root directory. The value for Root directory is null.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Root directory</strong></dt>
<dd>The name of the local file system directory in which the triggered cache
manager server is to maintain its persistent record of incoming transactions.
The value must be null, or specify a directory name, left justified and padded
with blanks if necessary. The default name is /QIBM/UserData/TCM/{servername}/
root, where {server-name} is the name of the server as defined by Server name.<div class="note"><span class="notetitle">Note:</span> If
the value is null, Offset to root directory must be set to 0 (QZHT_NONE),
-1 (QZHT_DEFAULT), or -2 (QZHT_NO_CHANGE).</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Server name</strong></dt>
<dd>The name used to identify the server for which the configuration change
is made (left justified and padded with blanks if necessary).</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>TCM7001 E</strong></dt>
<dd>User &amp;1 is not authorized.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7030 E</strong></dt>
<dd>Severe error occurred while addressing parameter list.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7031 E</strong></dt>
<dd>Request variable format is not valid.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7033 E</strong></dt>
<dd>Length of request variable is not valid for the specified format.</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>TCM7101 E</strong></dt>
<dd>User QTCM is not authorized to the configuration file for triggered cache
manager server &amp;1.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7190 E</strong></dt>
<dd>A configuration file for triggered cache manager server &amp;1 was not
found.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM72C3 E</strong></dt>
<dd>Value passed to offset &amp;1 is not valid.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM74C0 E</strong></dt>
<dd>Triggered cache manager server name is not valid.</dd>
</dl>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink