239 lines
12 KiB
HTML
239 lines
12 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="Add Triggered Cache Manager Host Description (QzhtAddTCMHostDesc) 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_qzhtaddtcmhostdesc" />
|
|
<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>Add Triggered Cache Manager Host Description (QzhtAddTCMHostDesc) API</title>
|
|
</head>
|
|
<body id="rzaieapi_qzhtaddtcmhostdesc"><a name="rzaieapi_qzhtaddtcmhostdesc"><!-- --></a>
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
|
<!--Java sync-link--><h1 class="topictitle1">Add Triggered Cache Manager Host Description (QzhtAddTCMHostDesc) 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 QzhtAddTCMHostDesc API to add new host descriptions to the configuration
|
|
of triggered cache manager servers. New host descriptions are referenced subsequently,
|
|
by name, from certain types of data source, cache target, and acknowledgment
|
|
target descriptions associated with the same server. New host descriptions
|
|
are utilized by all descriptions referencing them the next time the servers
|
|
are started. 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 add
|
|
a new host description.</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>HSDP0100: Basic information format for a host description.</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="hsdp0100_format"><a name="hsdp0100_format"><!-- --></a><h2 class="topictitle2">HSDP0100 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 ">Char(32)</td>
|
|
<td valign="top" headers="d0e143 ">Host description</td>
|
|
</tr>
|
|
<tr><td valign="top" headers="d0e139 d0e146 ">64</td>
|
|
<td valign="top" headers="d0e139 d0e148 ">40</td>
|
|
<td valign="top" headers="d0e141 ">Binary(4)</td>
|
|
<td valign="top" headers="d0e143 ">Default property</td>
|
|
</tr>
|
|
<tr><td valign="top" headers="d0e139 d0e146 ">68</td>
|
|
<td valign="top" headers="d0e139 d0e148 ">44</td>
|
|
<td valign="top" headers="d0e141 ">Char(32)</td>
|
|
<td valign="top" headers="d0e143 ">IP interface</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>Default property</strong></dt>
|
|
<dd>Specifies if the new description is the default host description for the
|
|
triggered cache manager server specified in Server name. The value must equal
|
|
one of the special values described below. If the value equals 1 (QZHT_YES),
|
|
the default property for the current default host description is set to 0
|
|
(QZHT_NO), and this description takes over the default role. 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.243654822335024%"><strong>1</strong></td>
|
|
<td valign="top" width="83.75634517766497%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The description is
|
|
the default host description for this server.</td>
|
|
</tr>
|
|
<tr><td valign="top" width="16.243654822335024%"><strong>0</strong></td>
|
|
<td valign="top" width="83.75634517766497%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The description
|
|
is not the default host description.</td>
|
|
</tr>
|
|
<tr><td valign="top" width="16.243654822335024%"><strong>-2</strong></td>
|
|
<td valign="top" width="83.75634517766497%">QZHT_DEFAULT: The default value is used.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="note"><span class="notetitle">Note:</span> Data source, cache target, and acknowledgment target descriptions,
|
|
added or changed using the *DEFAULT special value, reference the host description
|
|
designated as default at the time they are added or changed.</div>
|
|
</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>Host description name</strong></dt>
|
|
<dd>The name used by the new host description (left justified and padded with
|
|
blanks if necessary).<div class="note"><span class="notetitle">Note:</span> Host description names must be unique for each
|
|
triggered cache manager server. They are referenced, by name, from certain
|
|
types of data source, cache target, and acknowledgment target descriptions
|
|
associated with the same server.</div>
|
|
</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>IP interface</strong></dt>
|
|
<dd>The IP host name or address of the system hosting servers used by the
|
|
triggered cache manager server (left justified and padded with blanks if necessary).
|
|
The value must be a host name (for example, server.mycompany.com), dotted
|
|
address (for example, 192.168.3.57), or one of the special values described
|
|
below. If a host name is specified, it must use proper naming conventions
|
|
as defined by RFC 1034, Domain Names - Concepts and Facilities. If a dotted
|
|
address is specified, it must use proper IP version 4 address conventions
|
|
as defined by RFC 791, Internet Protocol. The default value is 127.0.0.1,
|
|
the local system loopback interface.<p>Special values and their meanings are
|
|
as follows:</p>
|
|
<dl><dt class="dlterm"><strong>*DEFAULT</strong></dt>
|
|
<dd>QZHT_DEFAULT_CHAR: The default value is used.</dd>
|
|
</dl>
|
|
</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>Server name</strong></dt>
|
|
<dd>The name used to identify the triggered cache manager server for which
|
|
the new description is associated (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 &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><strong>Request variable format is not valid.</strong></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 &1.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>TCM7190 E</strong></dt>
|
|
<dd>A configuration file for triggered cache manager server &1 was not
|
|
found.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>TCM7293 E</strong></dt>
|
|
<dd>A &1 using the name &2 already exists for triggered cache manager
|
|
server &3.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>TCM72C0 E</strong></dt>
|
|
<dd>Triggered cache manager &1 name is not valid.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>TCM72C3 E</strong></dt>
|
|
<dd>Value passed to offset &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> |