ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzaie_5.4.0.1/rzaieapi_qzhtchgtcmcachetargetdesc.htm

2010 lines
99 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="Change Triggered Cache Manager Cache Target Description (QzhtChgTCMCacheTargetDesc) 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_qzhtchgtcmcachetargetdesc" />
<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 Cache Target Description (QzhtChgTCMCacheTargetDesc)
API</title>
</head>
<body id="rzaieapi_qzhtchgtcmcachetargetdesc"><a name="rzaieapi_qzhtchgtcmcachetargetdesc"><!-- --></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 Cache Target Description (QzhtChgTCMCacheTargetDesc)
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%">server name</td>
<td valign="top" width="31.060606060606062%">Input</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%">description name</td>
<td valign="top" width="31.060606060606062%">Input</td>
<td valign="top" width="31.313131313131315%">Char(32)</td>
</tr>
<tr><td align="right" valign="top" width="6.313131313131313%">6</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 QzhtChgTCMCacheTargetDesc API to change cache target description
associated with triggered cache manager servers. Changes made to cache target
descriptions are utilized by all trigger handler 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 change
a cache target description. See Cache target description formats for more
information.</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. See Cache
target description formats for more information. The following values must
be used:</p>
<ul><li>CTDP0100: Basic information format for a cache target description.</li>
<li>CTDP0200: Detailed information format for an *IFS type cache target description.</li>
<li>CTDP0300: Detailed information format for a *HTTP1 type cache target description.</li>
<li>CTDP0310: Detailed information format for a *HTTP2 type cache target description.</li>
<li>CTDP0500: Detailed information format for a *ECCP1 type cache target description.</li>
<li>CTDP0510: Detailed information format for a *ECCP2 type cache target description.</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
description is changed (left justified and padded with blanks if necessary).</p>
</dd>
</dl>
<dl><dt class="dlterm"><strong>description name</strong></dt>
<dd>CHAR(32) <p>The name used to identify which cache target description information
is changed (left justified and padded with blanks if necessary).</p>
</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="ctdp0100_format"><a name="ctdp0100_format"><!-- --></a><h2 class="topictitle2">CTDP0100 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="d0e185">Offset</th>
<th rowspan="2" valign="top" id="d0e187">Type</th>
<th rowspan="2" valign="top" id="d0e189">Field</th>
</tr>
<tr><th valign="top" id="d0e192">Dec</th>
<th valign="top" id="d0e194">Hex</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e185 d0e192 ">0</td>
<td valign="top" headers="d0e185 d0e194 ">0</td>
<td valign="top" headers="d0e187 ">Char(32)</td>
<td valign="top" headers="d0e189 ">Server name</td>
</tr>
<tr><td valign="top" headers="d0e185 d0e192 ">32</td>
<td valign="top" headers="d0e185 d0e194 ">20</td>
<td valign="top" headers="d0e187 ">Char(32)</td>
<td valign="top" headers="d0e189 ">Cache target description name</td>
</tr>
<tr><td valign="top" headers="d0e185 d0e192 ">64</td>
<td valign="top" headers="d0e185 d0e194 ">40</td>
<td valign="top" headers="d0e187 ">Char(10)</td>
<td valign="top" headers="d0e189 ">Cache target type</td>
</tr>
<tr><td valign="top" headers="d0e185 d0e192 ">74</td>
<td valign="top" headers="d0e185 d0e194 ">4A</td>
<td valign="top" headers="d0e187 ">Char(2)</td>
<td valign="top" headers="d0e189 ">Reserved</td>
</tr>
<tr><td valign="top" headers="d0e185 d0e192 ">76</td>
<td valign="top" headers="d0e185 d0e194 ">4C</td>
<td valign="top" headers="d0e187 ">Binary(4)</td>
<td valign="top" headers="d0e189 ">Default property</td>
</tr>
<tr><td valign="top" headers="d0e185 d0e192 ">80</td>
<td valign="top" headers="d0e185 d0e194 ">50</td>
<td valign="top" headers="d0e187 ">Binary(4)</td>
<td valign="top" headers="d0e189 ">Number of threads</td>
</tr>
<tr><td valign="top" headers="d0e185 d0e192 ">84</td>
<td valign="top" headers="d0e185 d0e194 ">54</td>
<td valign="top" headers="d0e187 ">Binary(4)</td>
<td valign="top" headers="d0e189 ">Initial state</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="nested1" id="ctdp0100_field_descriptions"><a name="ctdp0100_field_descriptions"><!-- --></a><h2 class="topictitle2">CTDP0100 format field descriptions</h2>
<div><div class="note"><span class="notetitle">Note:</span> If a description type is specified in Cache target type that is different
than the current description type, the description is changed using default
values for all unspecified values according to the specified type). See other
cache target description formats for details regarding these default values.</div>
<dl><dt class="dlterm"><strong>Cache target description name</strong></dt>
<dd>The name used by the cache target description (left justified and padded
with blanks if necessary). The value must be a description name, or one of
the special values described below.<p>Special values and their meanings are
as follows:</p>
<dl><dt class="dlterm"><strong>*SAME</strong></dt>
<dd>QZHT_NO_CHANGE_CHAR: The current name is not changed.</dd>
</dl>
<div class="note"><span class="notetitle">Note:</span> Cache target description names must be unique for each
triggered cache manager server. If the name is changed, while the description
is referenced by trigger handler description, they too are changed to reference
the new name.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Cache target type</strong></dt>
<dd>The type of cache target description that is added (left justified and
padded with blanks if necessary). The value must be one of the special values
described below. <p>Special values and their meanings are as follows:</p>
<dl><dt class="dlterm"><strong>*SAME</strong></dt>
<dd>QZHT_NO_CHANGE_CHAR: The description is not changed.</dd>
</dl>
<dl><dt class="dlterm"><strong>*IFS</strong></dt>
<dd>QZHT_IFS_TYPE: The description is changed to an *IFS type cache target
description.</dd>
</dl>
<dl><dt class="dlterm"><strong>*HTTP1</strong></dt>
<dd>QZHT_HTTP_TYPE1: The description is changed to an *HTTP1 type cache target
description.</dd>
</dl>
<dl><dt class="dlterm"><strong>*HTTP2</strong></dt>
<dd>QZHT_HTTP_TYPE2: The description is changed to an *HTTP2 type cache target
description.</dd>
</dl>
<div class="note"><span class="notetitle">Note:</span> If a type is specified, that is different than the current
type, certain information is discarded if it cannot be mapped to values for
reuse by the new description type. See other cache target description formats
for details. Cache target description types of *ECCP1 and *ECCP2 must be added
using the CTDP0500 and CTDP0510 formats, respectively.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Default property</strong></dt>
<dd>Specifies if the new description will become the default cache target
description for the triggered cache manager server specified in Server name.
The value must equal one of the special values described below. 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="15.656565656565657%"><strong>1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The description becomes
the default cache target description for this server.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>0</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The description
is not the default cache target description.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_DEFAULT: The default value is used.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-2</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO_CHANGE: The current value is not changed.</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> Multiple default cache target descriptions are allowed. Trigger
handler descriptions added or changed using the *DEFAULT special value reference
all cache target descriptions designated as default at the time the trigger
handler descriptions are added or changed.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Initial state</strong></dt>
<dd>Specifies the state that the triggered cache manager server request processor,
for this cache target, is in at server startup. The value must equal one of
the special values described below. The default value is 1 (QZHT_ENABLED).
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.656565656565657%"><strong>1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The request processor
is enabled at server startup.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>0</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The request processor
is disabled at server startup.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_DEFAULT: The default value is used.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-2</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO_CHANGE: The current value is not changed.</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> The state of a cache target request processor can be changed
while the triggered cache manager server is active by using the -<em>chsink</em> command
in a trigger message.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Number of threads</strong></dt>
<dd>The number of concurrent threads the triggered cache manager server spawns
when processing requests sent to this cache target. The value must be greater
that 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 5. <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.656565656565657%"><strong>-1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_DEFAULT: The default value is used.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-2</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO_CHANGE: The current value is not changed.</td>
</tr>
</tbody>
</table>
</div>
</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 description is associated (left justified and padded with blanks if necessary).
The value must be a server name, or one of the special values described below.
If a server name is specified, that is different than the one with which the
description is currently associated, it is removed from its current association
and added for the new server. <p>Special values and their meanings are as
follows:</p>
<dl><dt class="dlterm"><strong>*SAME</strong></dt>
<dd>QZHT_NO_CHANGE_CHAR: The current server association is not changed.<div class="note"><span class="notetitle">Note:</span> An
escape message is sent if the description is removed from its current association
while being referenced by other descriptions.</div>
</dd>
</dl>
</dd>
</dl>
</div>
</div>
<div class="nested1" id="ctdp0200_format"><a name="ctdp0200_format"><!-- --></a><h2 class="topictitle2">CTDP0200 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="d0e466">Offset</th>
<th rowspan="2" valign="top" id="d0e468">Type</th>
<th rowspan="2" valign="top" id="d0e470">Field</th>
</tr>
<tr><th valign="top" id="d0e473">Dec</th>
<th valign="top" id="d0e475">Hex</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e466 d0e473 ">0</td>
<td valign="top" headers="d0e466 d0e475 ">0</td>
<td valign="top" headers="d0e468 ">&nbsp;</td>
<td valign="top" headers="d0e470 ">Everything from CTDP0100 format</td>
</tr>
<tr><td valign="top" headers="d0e466 d0e473 ">88</td>
<td valign="top" headers="d0e466 d0e475 ">58</td>
<td valign="top" headers="d0e468 ">Binary(4)</td>
<td valign="top" headers="d0e470 ">Offset to local directory root</td>
</tr>
<tr><td valign="top" headers="d0e466 d0e473 ">92</td>
<td valign="top" headers="d0e466 d0e475 ">5C</td>
<td valign="top" headers="d0e468 ">Binary(4)</td>
<td valign="top" headers="d0e470 ">Length of local directory root</td>
</tr>
<tr><td valign="top" headers="d0e466 d0e473 ">&nbsp;</td>
<td valign="top" headers="d0e466 d0e475 ">&nbsp;</td>
<td valign="top" headers="d0e468 ">Char(*)</td>
<td valign="top" headers="d0e470 ">Local directory root</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="nested1" id="ctdp0200_field_descriptions"><a name="ctdp0200_field_descriptions"><!-- --></a><h2 class="topictitle2">CTDP0200 format field descriptions</h2>
<div><div class="note"><span class="notetitle">Note:</span> If the current description type is not *IFS, all information currently
stored for the description (that is not mapped to one the following entries)
is discarded.</div>
<dl><dt class="dlterm"><strong>Length of local directory root</strong></dt>
<dd>The length of the information for the Local directory root entry.<div class="note"><span class="notetitle">Note:</span> If
Offset to local directory root equals 0 (QZHT_NONE), -1 (QZHT_DEFAULT), or
-2 (QZHT_NO_CHANGE) this value must equal 0.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Local directory root</strong></dt>
<dd>The path to the local file system directory that is the root of this cache
target (left justified and padded with blanks if necessary). The value must
be a path acceptable to the root (/) file system of the local iSeries™ system.
If a path is provided, but does not specify a absolute path (does not start
with / ), the path is prepended with the default path. The default path is
/QIBM/UserData/TCM/{Server name} where {Server name} is the name of the triggered
cache manager server as defined by Server name. <p>If Offset to local directory
root equals -2 (QZHT_NO_CHANGE), the following rules are used to map current
description values for reuse:</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" id="d0e545">If the current type is:</th>
<th valign="top" id="d0e547">&nbsp;</th>
<th valign="top" id="d0e548">Details</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e545 ">*IFS</td>
<td valign="top" headers="d0e547 ">use current Local directory root path</td>
<td valign="top" headers="d0e548 ">No change is made.</td>
</tr>
<tr><td valign="top" headers="d0e545 ">*HTTP1 or *HTTP2</td>
<td valign="top" headers="d0e547 ">use current HTTP URI root path</td>
<td valign="top" headers="d0e548 ">Refers to CTDP0300 or DSDP0310 format.</td>
</tr>
<tr><td valign="top" headers="d0e545 ">*ECCP1 or *ECCP2</td>
<td valign="top" headers="d0e547 ">use current HTTP cluster URI root path </td>
<td valign="top" headers="d0e548 ">Refers to CTDP0500 or CTDP0510 format.</td>
</tr>
<tr><td valign="top" headers="d0e545 ">any other</td>
<td valign="top" headers="d0e547 ">use default path</td>
<td valign="top" headers="d0e548 ">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> All file requests from the cache target must have this path
prepended to the file name, even if an absolute file path is specified. If
the value is null, Offset to local directory root must equal 0 (QZHT_NONE),
-1 (QZHT_DEFAULT), or -2 (QZHT_NO_CHANGE). See Offset to local directory root
for more details.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Offset to local directory root</strong></dt>
<dd>The offset from the beginning of the request variable to the Local directory
root data, in bytes. The value must be greater that 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="15.656565656565657%"><strong>0</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NONE: Same as -1 (QZHT_DEFAULT).</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_DEFAULT: The default path is used for Local directory
root.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-2</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO_CHANGE: If the current description type is *IFS,
the current path for Local directory root is not changed. If the current description
type is not *IFS, see details for Local directory root on how current description
values are mapped for reuse by the new description type.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
</div>
</div>
<div class="nested1" id="ctdp0300_format"><a name="ctdp0300_format"><!-- --></a><h2 class="topictitle2">CTDP0300 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="d0e624">Offset</th>
<th rowspan="2" valign="top" id="d0e626">Type</th>
<th rowspan="2" valign="top" id="d0e628">Field</th>
</tr>
<tr><th valign="top" id="d0e631">Dec</th>
<th valign="top" id="d0e633">Hex</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e624 d0e631 ">0</td>
<td valign="top" headers="d0e624 d0e633 ">0</td>
<td valign="top" headers="d0e626 ">Char(256)</td>
<td valign="top" headers="d0e628 ">Everything from CTDP0100 format</td>
</tr>
<tr><td valign="top" headers="d0e624 d0e631 ">88</td>
<td valign="top" headers="d0e624 d0e633 ">58</td>
<td valign="top" headers="d0e626 ">Binary(4)</td>
<td valign="top" headers="d0e628 ">HTTP IP interface</td>
</tr>
<tr><td valign="top" headers="d0e624 d0e631 ">344</td>
<td valign="top" headers="d0e624 d0e633 ">158</td>
<td valign="top" headers="d0e626 ">Binary(4)</td>
<td valign="top" headers="d0e628 ">HTTP TCP port</td>
</tr>
<tr><td valign="top" headers="d0e624 d0e631 ">348</td>
<td valign="top" headers="d0e624 d0e633 ">15C</td>
<td valign="top" headers="d0e626 ">Binary(4)</td>
<td valign="top" headers="d0e628 ">Offset to HTTP URI root</td>
</tr>
<tr><td valign="top" headers="d0e624 d0e631 ">352</td>
<td valign="top" headers="d0e624 d0e633 ">160</td>
<td valign="top" headers="d0e626 ">Binary(4)</td>
<td valign="top" headers="d0e628 ">Length of HTTP URI root</td>
</tr>
<tr><td valign="top" headers="d0e624 d0e631 ">356</td>
<td valign="top" headers="d0e624 d0e633 ">164</td>
<td valign="top" headers="d0e626 ">Binary(4)</td>
<td valign="top" headers="d0e628 ">HTTP keepalive</td>
</tr>
<tr><td valign="top" headers="d0e624 d0e631 ">360</td>
<td valign="top" headers="d0e624 d0e633 ">168</td>
<td valign="top" headers="d0e626 ">Binary(4)</td>
<td valign="top" headers="d0e628 ">Timeout</td>
</tr>
<tr><td valign="top" headers="d0e624 d0e631 ">&nbsp;</td>
<td valign="top" headers="d0e624 d0e633 ">&nbsp;</td>
<td valign="top" headers="d0e626 ">Char(*)</td>
<td valign="top" headers="d0e628 ">HTTP URI root</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="nested1" id="ctdp0300_field_descriptions"><a name="ctdp0300_field_descriptions"><!-- --></a><h2 class="topictitle2">CTDP0300 format field descriptions</h2>
<div><div class="note"><span class="notetitle">Note:</span> If the current description type is not *HTTP1, all information currently
stored for the description (that is not mapped to one the following entries)
is discarded.</div>
<dl><dt class="dlterm"><strong>HTTP IP interface</strong></dt>
<dd>The IP host name or address of the system hosting an HTTP server cache
target (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>
<dl><dt class="dlterm"><strong>*SAME</strong></dt>
<dd>QZHT_NO_CHANGE_CHAR: The following rules are used to map current description
values for reuse:</dd>
</dl>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" id="d0e742">If the current type is:</th>
<th valign="top" id="d0e744">&nbsp;</th>
<th valign="top" id="d0e745">Details</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e742 ">*HTTP1</td>
<td valign="top" headers="d0e744 ">use current HTTP IP interface value </td>
<td valign="top" headers="d0e745 ">No change is made.</td>
</tr>
<tr><td valign="top" headers="d0e742 ">*HTTP2</td>
<td valign="top" headers="d0e744 ">use IP interface value from the host description currently
referenced by HTTP host </td>
<td valign="top" headers="d0e745 ">An exception occurs if the referenced description does
not exist. Refers to the CTDP0310 format.</td>
</tr>
<tr><td valign="top" headers="d0e742 ">*ECCP1</td>
<td valign="top" headers="d0e744 ">use current ECCP IP interface value</td>
<td valign="top" headers="d0e745 ">Refers to CTDP0500 format.</td>
</tr>
<tr><td valign="top" headers="d0e742 ">*ECCP2</td>
<td valign="top" headers="d0e744 ">use IP interface value from the host description currently
referenced by ECCP host </td>
<td valign="top" headers="d0e745 ">An exception occurs if the referenced description does
not exist. Refers to CTDP0510 format.</td>
</tr>
<tr><td valign="top" headers="d0e742 ">any other</td>
<td valign="top" headers="d0e744 ">use default value</td>
<td valign="top" headers="d0e745 ">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>HTTP keepalive</strong></dt>
<dd>Specifies if connections to HTTP Server are kept open for reuse after
data is transferred. The value must equal one of the special values described
below. The default value is 0 (QZHT_DISABLED). <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.656565656565657%"><strong>1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The connection is
kept open after data transfer.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>0</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The connection is
closed after data transfer.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_DEFAULT: The default value is used.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-2</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO_CHANGE: If the current description type is *HTTP1
or *HTTP2, the current value is not changed. If the current description type
is not *HTTP1 or *HTTP2, the default value is used.</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> HTTP Server must support keepalive for this option to work properly.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>HTTP TCP port</strong></dt>
<dd>The TCP port number upon which HTTP Server listens for incoming requests.
The value must be greater than 0 and less than 65536, or equal to one of the
special values described below. The default value is 80.<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.656565656565657%"><strong>-1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_DEFAULT: The default value is used.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-2</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO_CHANGE: The following rules are used to map
current description values for reuse:</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" id="d0e855">If the current type is:</th>
<th valign="top" id="d0e857">&nbsp;</th>
<th valign="top" id="d0e858">Details</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e855 ">*HTTP1 or *HTTP2</td>
<td valign="top" headers="d0e857 ">use current HTTP TCP port value</td>
<td valign="top" headers="d0e858 ">No change is made.</td>
</tr>
<tr><td valign="top" headers="d0e855 ">*ECCP1 or *ECCP2</td>
<td valign="top" headers="d0e857 ">use current ECCP TCP port value</td>
<td valign="top" headers="d0e858 ">Refers to CTDP0500 or CTDP0510 format.</td>
</tr>
<tr><td valign="top" headers="d0e855 ">any other</td>
<td valign="top" headers="d0e857 ">use default value</td>
<td valign="top" headers="d0e858 ">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> The TCP port number is used in combination with the IP host
name or address in HTTP IP interface to establish communication with HTTP
Server cache target.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>HTTP URI root</strong></dt>
<dd>The path of HTTP Server URI that is the root of this cache target (left
justified and padded with blanks if necessary). The value must be a path acceptable
to HTTP Server. The default path is / . <p>If Offset to HTTP URI root equals
-2 (QZHT_NO_CHANGE), the following rules are used to map current description
values for reuse:</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" id="d0e899">If the current type is:</th>
<th valign="top" id="d0e901">&nbsp;</th>
<th valign="top" id="d0e902">Details</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e899 ">*IFS</td>
<td valign="top" headers="d0e901 ">use current Local directory root path</td>
<td valign="top" headers="d0e902 ">Refers to CTDP0200 format.</td>
</tr>
<tr><td valign="top" headers="d0e899 ">*HTTP1 or *HTTP2</td>
<td valign="top" headers="d0e901 ">use current HTTP URI root path</td>
<td valign="top" headers="d0e902 ">No change is made.</td>
</tr>
<tr><td valign="top" headers="d0e899 ">*ECCP1 or *ECCP2</td>
<td valign="top" headers="d0e901 ">use current HTTP cluster URI root path </td>
<td valign="top" headers="d0e902 ">Refers to CTDP0500 or CTDP0510 format.</td>
</tr>
<tr><td valign="top" headers="d0e899 ">any other</td>
<td valign="top" headers="d0e901 ">use default path</td>
<td valign="top" headers="d0e902 ">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> All file requests from this cache target have this path inserted
into the URI, even if an absolute file path is specified. If the value is
null, Offset to HTTP URI root must equal 0 (QZHT_NONE), -1 (QZHT_DEFAULT),
or -2 (QZHT_NO_CHANGE). See Offset to HTTP URI root for more details.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Length of HTTP URI root</strong></dt>
<dd>The length of the information for the HTTP URI root entry.<div class="note"><span class="notetitle">Note:</span> If Offset
to HTTP URI root equals 0 (QZHT_NONE), -1 (QZHT_DEFAULT), or -2 (QZHT_NO_CHANGE),
this value must equal 0.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Offset to HTTP URI root</strong></dt>
<dd>The offset from the beginning of the request variable to the HTTP URI
root data, in bytes. The value must be greater than 0, or equal to one of
the special values defined 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="15.656565656565657%"><strong>0</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NONE: Same as -1 (QZHT_DEFAULT).</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_DEFAULT: The default value is used for HTTP URI
root.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-2</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO_CHANGE: If the current description type is *HTTP1
or *HTTP2, the current path for HTTP URI root is not changed. If the current
description type is not *HTTP1 or *HTTP2, see details for HTTP URI root on
how current description values are mapped for reuse by the new description
type.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Timeout</strong></dt>
<dd>The number of seconds the triggered cache manager server waits before
canceling a read operation on sockets and ending transactions, with the HTTP
host, in error. 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 0 (QZHT_DISABLED). <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.656565656565657%"><strong>0</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The time out operation
is disabled. The triggered cache manager server should never cancel a read
operation.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_DEFAULT: The default value is used.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-2</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO_CHANGE: If the current description type is *HTTP1
or *HTTP2, the current value is not changed. If the current description type
is not *HTTP1 or *HTTP2, the default value is used.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
</div>
</div>
<div class="nested1" id="ctdp0310_format"><a name="ctdp0310_format"><!-- --></a><h2 class="topictitle2">CTDP0310 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="d0e1025">Offset</th>
<th rowspan="2" valign="top" id="d0e1027">Type</th>
<th rowspan="2" valign="top" id="d0e1029">Field</th>
</tr>
<tr><th valign="top" id="d0e1032">Dec</th>
<th valign="top" id="d0e1034">Hex</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e1025 d0e1032 ">0</td>
<td valign="top" headers="d0e1025 d0e1034 ">0</td>
<td valign="top" headers="d0e1027 ">&nbsp;</td>
<td valign="top" headers="d0e1029 ">Everything from CTDP0100 format</td>
</tr>
<tr><td valign="top" headers="d0e1025 d0e1032 ">88</td>
<td valign="top" headers="d0e1025 d0e1034 ">58</td>
<td valign="top" headers="d0e1027 ">Char(32)</td>
<td valign="top" headers="d0e1029 ">HTTP host</td>
</tr>
<tr><td valign="top" headers="d0e1025 d0e1032 ">120</td>
<td valign="top" headers="d0e1025 d0e1034 ">78</td>
<td valign="top" headers="d0e1027 ">Binary(4)</td>
<td valign="top" headers="d0e1029 ">HTTP TCP port</td>
</tr>
<tr><td valign="top" headers="d0e1025 d0e1032 ">124</td>
<td valign="top" headers="d0e1025 d0e1034 ">7C</td>
<td valign="top" headers="d0e1027 ">Binary(4)</td>
<td valign="top" headers="d0e1029 ">Offset to HTTP URI root</td>
</tr>
<tr><td valign="top" headers="d0e1025 d0e1032 ">128</td>
<td valign="top" headers="d0e1025 d0e1034 ">80</td>
<td valign="top" headers="d0e1027 ">Binary(4)</td>
<td valign="top" headers="d0e1029 ">Length of HTTP URI root</td>
</tr>
<tr><td valign="top" headers="d0e1025 d0e1032 ">132</td>
<td valign="top" headers="d0e1025 d0e1034 ">84</td>
<td valign="top" headers="d0e1027 ">Binary(4)</td>
<td valign="top" headers="d0e1029 ">HTTP keepalive</td>
</tr>
<tr><td valign="top" headers="d0e1025 d0e1032 ">136</td>
<td valign="top" headers="d0e1025 d0e1034 ">88</td>
<td valign="top" headers="d0e1027 ">Binary(4)</td>
<td valign="top" headers="d0e1029 ">Timeout</td>
</tr>
<tr><td valign="top" headers="d0e1025 d0e1032 ">&nbsp;</td>
<td valign="top" headers="d0e1025 d0e1034 ">&nbsp;</td>
<td valign="top" headers="d0e1027 ">Char(*)</td>
<td valign="top" headers="d0e1029 ">HTTP URI root</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="nested1" id="ctdp0310_field_descriptions"><a name="ctdp0310_field_descriptions"><!-- --></a><h2 class="topictitle2">CTDP0310 format field descriptions</h2>
<div><div class="note"><span class="notetitle">Note:</span> If the current description type is not *HTTP2, all information currently
stored for the description, that is not mapped to one the following entries,
is discarded.</div>
<dl><dt class="dlterm"><strong>HTTP host</strong></dt>
<dd>The name of a host description associated with the triggered cache manager
server that is referenced by the new cache target description and used later,
at server startup, to obtain information about the system hosting an HTTP
server cache target. The value must be a host description name, or one of
the special values described below (left justified and padded with blanks
if necessary). The default value is to reference the description currently
designated as the default host description for the triggered cache manager
server. <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 referenced.</dd>
</dl>
<dl><dt class="dlterm"><strong>*SAME</strong></dt>
<dd>QZHT_NO_CHANGE_CHAR: The following rules are used to map current description
values for reuse:</dd>
</dl>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" id="d0e1142">If the current type is:</th>
<th valign="top" id="d0e1144">&nbsp;</th>
<th valign="top" id="d0e1145">Details</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e1142 ">*HTTP2</td>
<td valign="top" headers="d0e1144 ">the description currently referenced for HTTP host is
not changed </td>
<td valign="top" headers="d0e1145 ">No change is made.</td>
</tr>
<tr><td valign="top" headers="d0e1142 ">*ECCP2</td>
<td valign="top" headers="d0e1144 ">the description currently referenced for ECCP host is
referenced </td>
<td valign="top" headers="d0e1145 ">An exception occurs if the referenced description does
not exist. Refers to CTDP0510 format.</td>
</tr>
<tr><td valign="top" headers="d0e1142 ">any other</td>
<td valign="top" headers="d0e1144 ">the default host description currently associated with
the triggered cache manager server is referenced</td>
<td valign="top" headers="d0e1145 ">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> See HTTP TCP port for more information. An escape message is
sent if the referenced description does not currently exist, or if *DEFAULT
is specified and there is currently no default host description for the server.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>HTTP keepalive</strong></dt>
<dd>Specifies if connections to HTTP Server are kept open for reuse after
data is transferred. The value must equal one of the special values described
below. The default value is 0 (QZHT_DISABLED).<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.656565656565657%"><strong>1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The connection is
kept open after data transfer.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>0</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The connection is
closed after data transfer.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_DEFAULT: The default value is used.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-2</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO_CHANGE: If the current description type is *HTTP1
or *HTTP2, the current value is not changed. If the current description type
is not *HTTP1 or *HTTP2, the default value is used.</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> HTTP Server must support keepalive for this option to work properly.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>HTTP TCP port</strong></dt>
<dd>The TCP port number upon which HTTP Server listens for incoming requests.
The value must be greater than 0 and less than 65536, or equal to one of the
special values described below. The default value is 80. <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.656565656565657%"><strong>-1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_DEFAULT: The default value is used.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-2</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO_CHANGE: The following rules are used to map
current description values for reuse:</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" id="d0e1243">If the current type is:</th>
<th valign="top" id="d0e1245">&nbsp;</th>
<th valign="top" id="d0e1246">Details</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e1243 ">*HTTP1 or *HTTP2</td>
<td valign="top" headers="d0e1245 ">use current HTTP TCP port value</td>
<td valign="top" headers="d0e1246 ">No change is made.</td>
</tr>
<tr><td valign="top" headers="d0e1243 ">*ECCP1 or *ECCP2</td>
<td valign="top" headers="d0e1245 ">use current ECCP TCP port value</td>
<td valign="top" headers="d0e1246 ">Refers to CTDP0500 or CTDP0510 format.</td>
</tr>
<tr><td valign="top" headers="d0e1243 ">any other</td>
<td valign="top" headers="d0e1245 ">use default value</td>
<td valign="top" headers="d0e1246 ">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> The TCP port number is used in combination with information
obtained at server startup from the host description specified in HTTP host
to establish communication with HTTP Server cache target.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>HTTP URI root</strong></dt>
<dd>The path of HTTP Server URI that is the root of this cache target (left
justified and padded with blanks if necessary). The value must be a path acceptable
to HTTP Server. The default path is / . <p>If Offset to HTTP URI root equals
-2 (QZHT_NO_CHANGE), the following rules are used to map current description
values for reuse:</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" id="d0e1287">If the current type is:</th>
<th valign="top" id="d0e1289">&nbsp;</th>
<th valign="top" id="d0e1290">Details</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e1287 ">*IFS</td>
<td valign="top" headers="d0e1289 ">use current Local directory root path </td>
<td valign="top" headers="d0e1290 ">Refers to CTDP0200 format.</td>
</tr>
<tr><td valign="top" headers="d0e1287 ">*HTTP1 or *HTTP2</td>
<td valign="top" headers="d0e1289 ">use current HTTP URI root path </td>
<td valign="top" headers="d0e1290 ">No change is made.</td>
</tr>
<tr><td valign="top" headers="d0e1287 ">*ECCP1 or *ECCP2</td>
<td valign="top" headers="d0e1289 ">use current HTTP cluster URI root path </td>
<td valign="top" headers="d0e1290 ">Refers to CTDP0500 or CTDP0510 format.</td>
</tr>
<tr><td valign="top" headers="d0e1287 ">any other</td>
<td valign="top" headers="d0e1289 ">use default path</td>
<td valign="top" headers="d0e1290 ">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> All file requests sent to the cache target have this path inserted
into the URI, even if an absolute file path is specified. If the value is
null, Offset to HTTP URI root must equal 0 (QZHT_NONE), -1 (QZHT_DEFAULT),
or -2 (QZHT_NO_CHANGE). See Offset to HTTP URI root for more details.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Length of HTTP URI root</strong></dt>
<dd>The length of the information for the HTTP URI root entry.<div class="note"><span class="notetitle">Note:</span> If Offset
to HTTP URI root equals 0 (QZHT_NONE), -1 (QZHT_DEFAULT), or -2 (QZHT_NO_CHANGE),
this value must equal 0.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Offset to HTTP URI root</strong></dt>
<dd>The offset from the beginning of the request variable to the HTTP URI
root data, in bytes. The value must be greater than 0, or equal to one of
the special values defined 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="15.656565656565657%"><strong>0</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NONE: Same as -1 (QZHT_DEFAULT).</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-1</strong></td>
<td valign="top" width="84.34343434343434%">QQZHT_DEFAULT: The default path is used for HTTP URI
root.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-2</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO_CHANGE: If the current description type is *HTTP1
or *HTTP2, the current path for HTTP URI root is not changed. If the current
description type is not *HTTP1 or *HTTP2, see details for HTTP URI root on
how current description values are mapped for reuse by the new description
type.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Timeout</strong></dt>
<dd>The number of seconds the triggered cache manager server waits before
canceling a read operation on sockets and ending transactions, with the HTTP
host, in error. 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 0 (QZHT_DISABLED). <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.656565656565657%"><strong>0</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The time out operation
is disabled. The triggered cache manager server should never cancel a read
operation.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_DEFAULT: The default value is used.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-2</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO_CHANGE: If the current description type is *HTTP1
or *HTTP2, the current value is not changed. If the current description type
is not *HTTP1 or *HTTP2, the default value is used.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
</div>
</div>
<div class="nested1" id="ctdp0500_format"><a name="ctdp0500_format"><!-- --></a><h2 class="topictitle2">CTDP0500 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="d0e1413">Offset</th>
<th rowspan="2" valign="top" id="d0e1415">Type</th>
<th rowspan="2" valign="top" id="d0e1417">Field</th>
</tr>
<tr><th valign="top" id="d0e1420">Dec</th>
<th valign="top" id="d0e1422">Hex</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e1413 d0e1420 ">0</td>
<td valign="top" headers="d0e1413 d0e1422 ">0</td>
<td valign="top" headers="d0e1415 ">Char(32)</td>
<td valign="top" headers="d0e1417 ">Server name</td>
</tr>
<tr><td valign="top" headers="d0e1413 d0e1420 ">32</td>
<td valign="top" headers="d0e1413 d0e1422 ">20</td>
<td valign="top" headers="d0e1415 ">Char(32)</td>
<td valign="top" headers="d0e1417 ">Cache target description name</td>
</tr>
<tr><td valign="top" headers="d0e1413 d0e1420 ">64</td>
<td valign="top" headers="d0e1413 d0e1422 ">40</td>
<td valign="top" headers="d0e1415 ">Char(10)</td>
<td valign="top" headers="d0e1417 ">Cache target type</td>
</tr>
<tr><td valign="top" headers="d0e1413 d0e1420 ">74</td>
<td valign="top" headers="d0e1413 d0e1422 ">4A</td>
<td valign="top" headers="d0e1415 ">Char(2)</td>
<td valign="top" headers="d0e1417 ">Reserved</td>
</tr>
<tr><td valign="top" headers="d0e1413 d0e1420 ">76</td>
<td valign="top" headers="d0e1413 d0e1422 ">4C</td>
<td valign="top" headers="d0e1415 ">Binary(4)</td>
<td valign="top" headers="d0e1417 ">Default property</td>
</tr>
<tr><td valign="top" headers="d0e1413 d0e1420 ">80</td>
<td valign="top" headers="d0e1413 d0e1422 ">50</td>
<td valign="top" headers="d0e1415 ">Binary(4)</td>
<td valign="top" headers="d0e1417 ">Number of threads</td>
</tr>
<tr><td valign="top" headers="d0e1413 d0e1420 ">84</td>
<td valign="top" headers="d0e1413 d0e1422 ">54</td>
<td valign="top" headers="d0e1415 ">Binary(4)</td>
<td valign="top" headers="d0e1417 ">Initial state</td>
</tr>
<tr><td valign="top" headers="d0e1413 d0e1420 ">88</td>
<td valign="top" headers="d0e1413 d0e1422 ">58</td>
<td valign="top" headers="d0e1415 ">Char(256)</td>
<td valign="top" headers="d0e1417 ">ECCP IP interface</td>
</tr>
<tr><td valign="top" headers="d0e1413 d0e1420 ">344</td>
<td valign="top" headers="d0e1413 d0e1422 ">158</td>
<td valign="top" headers="d0e1415 ">Binary(4)</td>
<td valign="top" headers="d0e1417 ">ECCP TCP port</td>
</tr>
<tr><td valign="top" headers="d0e1413 d0e1420 ">348</td>
<td valign="top" headers="d0e1413 d0e1422 ">15C</td>
<td valign="top" headers="d0e1415 ">Char(32)</td>
<td valign="top" headers="d0e1417 ">HTTP cluster IP interface</td>
</tr>
<tr><td valign="top" headers="d0e1413 d0e1420 ">604</td>
<td valign="top" headers="d0e1413 d0e1422 ">260</td>
<td valign="top" headers="d0e1415 ">Binary(4)</td>
<td valign="top" headers="d0e1417 ">HTTP cluster TCP port</td>
</tr>
<tr><td valign="top" headers="d0e1413 d0e1420 ">608</td>
<td valign="top" headers="d0e1413 d0e1422 ">264</td>
<td valign="top" headers="d0e1415 ">Binary(4)</td>
<td valign="top" headers="d0e1417 ">Offset to HTTP cluster URI root</td>
</tr>
<tr><td valign="top" headers="d0e1413 d0e1420 ">612</td>
<td valign="top" headers="d0e1413 d0e1422 ">268</td>
<td valign="top" headers="d0e1415 ">Binary(4)</td>
<td valign="top" headers="d0e1417 ">Length of HTTP cluster URI root</td>
</tr>
<tr><td valign="top" headers="d0e1413 d0e1420 ">616</td>
<td valign="top" headers="d0e1413 d0e1422 ">26C</td>
<td valign="top" headers="d0e1415 ">Binary(4)</td>
<td valign="top" headers="d0e1417 ">ECCP keepalive</td>
</tr>
<tr><td valign="top" headers="d0e1413 d0e1420 ">&nbsp;</td>
<td valign="top" headers="d0e1413 d0e1422 ">&nbsp;</td>
<td valign="top" headers="d0e1415 ">Char(*)</td>
<td valign="top" headers="d0e1417 ">HTTP cluster URI root</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="nested1" id="ctdp0500_field_descriptions"><a name="ctdp0500_field_descriptions"><!-- --></a><h2 class="topictitle2">CTDP0500 format field descriptions</h2>
<div><div class="note"><span class="notetitle">Note:</span> If the current description type is not *ECCP1, all information currently
stored, for the description that is not mapped to one the following entries,
is discarded.</div>
<dl><dt class="dlterm"><strong>Cache target description name</strong></dt>
<dd>The name used by the cache target description (left justified and padded
with blanks if necessary). The value must be a description name, or one of
the special values described below. <p>Special values and their meanings are
as follows:</p>
<dl><dt class="dlterm"><strong>*SAME</strong></dt>
<dd>QZHT_NO_CHANGE_CHAR: The current name is not changed.</dd>
</dl>
<div class="note"><span class="notetitle">Note:</span> Cache target description names must be unique for each
triggered cache manager server. If the name is changed, while the description
is referenced by trigger handler description, they too are changed to reference
the new name.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Cache target type</strong></dt>
<dd>The changed cache target descriptions type (left justified and padded
with blanks if necessary). The value must be one of the special values described
below. <p>Special values and their meanings are as follows:</p>
<dl><dt class="dlterm"><strong>*SAME</strong></dt>
<dd>QZHT_NO_CHANGE_CHAR: The description is not changed to a different type.</dd>
</dl>
<dl><dt class="dlterm"><strong>*ECCP1</strong></dt>
<dd>QZHT_ECCP_TYPE1: The description is changed to an *ECCP1 type cache target
description.</dd>
</dl>
<div class="note"><span class="notetitle">Note:</span> If a type is specified, that is different than the current
type, certain information is discarded if it cannot be mapped to values for
reuse by the new description type.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Default property</strong></dt>
<dd>Specifies if the description is a default cache target description for
the triggered cache manager server specified in Server name. The value must
equal one of the special values described below. The default value is 0 (QZHT_NO).
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.656565656565657%"><strong>1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The description is
a default cache target description for this server.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>0</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The description
is not a default cache target description.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_DEFAULT: The default value is specified.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-2</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO_CHANGE: The current value is not changed.</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> Multiple default cache target descriptions are allowed. Trigger
handler descriptions added or changed, using the *DEFAULT special value, reference
all cache target descriptions designated as default at the time they are added
or changed.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>ECCP IP interface</strong></dt>
<dd>The IP host name or address of the backend IP interface to the network
router hosting a web server cluster cache target (left justified and padded
with blanks if necessary). The value must be a host name (for example, server.mycompany.com)
or dotted address (for example, 192.168.3.57). 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.
There is no default value for this entry. <p>Special values and their meanings
are as follows:</p>
<dl><dt class="dlterm"><strong>*SAME</strong></dt>
<dd>QZHT_NO_CHANGE_CHAR: The following rules are used to map current description
values for reuse:</dd>
</dl>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" id="d0e1668">If the current type is:</th>
<th valign="top" id="d0e1670">&nbsp;</th>
<th valign="top" id="d0e1671">Details</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e1668 ">*ECCP1</td>
<td valign="top" headers="d0e1670 ">use current ECCP IP interface value</td>
<td valign="top" headers="d0e1671 ">No change is made.</td>
</tr>
<tr><td valign="top" headers="d0e1668 ">*ECCP2</td>
<td valign="top" headers="d0e1670 ">use IP interface value from the host description currently
referenced by ECCP host </td>
<td valign="top" headers="d0e1671 ">An exception occurs if the referenced description does
not exist. Refers to CTDP0510 format.</td>
</tr>
<tr><td colspan="3" valign="top" headers="d0e1668 d0e1670 d0e1671 "><div class="note"><span class="notetitle">Note:</span> An exception occurs if the current
type is not one of the types listed above and *SAME is specified for ECCP
IP interface.</div>
</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>ECCP keepalive</strong></dt>
<dd>Specifies if the connection to the network router is kept open for reuse
after data is transferred. The value must equal one of the special values
described below. The default value is 0 (QZHT_DISABLED).
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.656565656565657%"><strong>1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The connection is
kept open after data transfer.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>0</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The connection is
closed after data transfer.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_DEFAULT: The default value is used.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-2</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO_CHANGE: The following rules are used to map
current description values for reuse:</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" id="d0e1735">If the current type is:</th>
<th valign="top" id="d0e1737">&nbsp;</th>
<th valign="top" id="d0e1738">Details</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e1735 ">*HTTP1 or *HTTP2</td>
<td valign="top" headers="d0e1737 ">use current HTTP keepalive value</td>
<td valign="top" headers="d0e1738 ">Refers to CTDP0300 or CTDP0310 format.</td>
</tr>
<tr><td valign="top" headers="d0e1735 ">*ECCP1 or *ECCP2</td>
<td valign="top" headers="d0e1737 ">use current ECCP keepalive value</td>
<td valign="top" headers="d0e1738 ">No change is made.</td>
</tr>
<tr><td valign="top" headers="d0e1735 ">any other</td>
<td valign="top" headers="d0e1737 ">use default value</td>
<td valign="top" headers="d0e1738 ">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> The network router must support keepalive for this option to
function properly.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>ECCP TCP port</strong></dt>
<dd>The TCP port number upon which the network router listens for incoming
requests. The value must be greater than 0 and less than 65536, or equal to
one of the special values described below. There is no default value for this
entry. <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.656565656565657%"><strong>-2</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO_CHANGE: If the current description type is *ECCP1
or *ECCP2, the current value is not changed.</td>
</tr>
<tr><td colspan="2" valign="top"><div class="note"><span class="notetitle">Note:</span> If the current description type
is not *ECCP1 or *ECCP2, an escape message is sent if -2 (QZHT_NO_CHANGE)
is specified.</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> The TCP port number is used in combination with the IP host
name or address, in ECCP IP interface, to establish communications with the
network router cache target.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>HTTP cluster IP interface</strong></dt>
<dd>The IP host name or address of the web server cluster from which the network
router is hosting a cache (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. There is no default value for this
entry. <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>
<dl><dt class="dlterm"><strong>*SAME</strong></dt>
<dd>QZHT_NO_CHANGE_CHAR: The following rules are used to map current description
values for reuse:</dd>
</dl>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" id="d0e1819">If the current type is:</th>
<th valign="top" id="d0e1821">&nbsp;</th>
<th valign="top" id="d0e1822">Details</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e1819 ">*HTTP1</td>
<td valign="top" headers="d0e1821 ">use current HTTP IP interface value</td>
<td valign="top" headers="d0e1822 ">Refers to CTDP0300 format.</td>
</tr>
<tr><td valign="top" headers="d0e1819 ">*HTTP2</td>
<td valign="top" headers="d0e1821 ">use IP interface value from the host description currently
referenced by HTTP host .</td>
<td valign="top" headers="d0e1822 ">Refers to the CTDP0310 format</td>
</tr>
<tr><td valign="top" headers="d0e1819 ">*ECCP1</td>
<td valign="top" headers="d0e1821 ">use current ECCP IP interface value</td>
<td valign="top" headers="d0e1822 ">No change is made.</td>
</tr>
<tr><td valign="top" headers="d0e1819 ">*ECCP2</td>
<td valign="top" headers="d0e1821 ">use IP interface value from the host description currently
referenced by ECCP host </td>
<td valign="top" headers="d0e1822 ">An exception occurs if the referenced description does
not exist. Refers to CTDP0510 format.</td>
</tr>
<tr><td valign="top" headers="d0e1819 ">any other</td>
<td valign="top" headers="d0e1821 ">use default value</td>
<td valign="top" headers="d0e1822 ">&nbsp;</td>
</tr>
<tr><td colspan="3" valign="top" headers="d0e1819 d0e1821 d0e1822 "><div class="note"><span class="notetitle">Note:</span> An exception occurs if the current
type is not one of the types listed above and *SAME is specified for HTTP
cluster IP interface.</div>
</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>HTTP cluster TCP port</strong></dt>
<dd>The TCP port number associated with the IP host name or address described
by HTTP cluster IP interface. The value must be greater than 0 and less than
65536, or one of the special values described below. There is no default value
for this entry. <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.656565656565657%"><strong>-2</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO_CHANGE: The following rules are used to map
current description values for reuse:</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" id="d0e1890">If the current type is:</th>
<th valign="top" id="d0e1892">&nbsp;</th>
<th valign="top" id="d0e1893">Details</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e1890 ">*HTTP1 or *HTTP2</td>
<td valign="top" headers="d0e1892 ">use current HTTP TCP port value</td>
<td valign="top" headers="d0e1893 ">Refers to CTDP0300 or CTDP0310 format.</td>
</tr>
<tr><td valign="top" headers="d0e1890 ">*ECCP1 or *ECCP2</td>
<td valign="top" headers="d0e1892 ">use current ECCP TCP port value</td>
<td valign="top" headers="d0e1893 ">No change is made.</td>
</tr>
<tr><td valign="top" headers="d0e1890 ">any other</td>
<td valign="top" headers="d0e1892 ">use default value</td>
<td valign="top" headers="d0e1893 ">&nbsp;</td>
</tr>
<tr><td colspan="3" valign="top" headers="d0e1890 d0e1892 d0e1893 "><div class="note"><span class="notetitle">Note:</span> An exception occurs if the current
type is not one of the types listed above and -2 (QZHT_NO_CHANGE) is specified
for HTTP cluster IP interface.</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> The network router using the address, described by ECCP IP interface,
may host multiple web server caches. The specified TCP port number is used
in combination with the IP interface in HTTP cluster IP interface to identify
a particular web server cache when communicating with the network router.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>HTTP cluster URI root</strong></dt>
<dd>The web server cluster URI path that is used to define the root of this
cache target (left justified and padded with blanks if necessary). The value
must be a path acceptable to the web server cluster from which the network
router is hosting a cache. The default path is /. <p>If Offset to HTTP cluster
URI root equals -2 (QZHT_NO_CHANGE), the following rules are used to map current
description values for reuse:</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" id="d0e1938">If the current type is:</th>
<th valign="top" id="d0e1940">&nbsp;</th>
<th valign="top" id="d0e1941">Details</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e1938 ">*IFS</td>
<td valign="top" headers="d0e1940 ">use current Local directory root path</td>
<td valign="top" headers="d0e1941 ">Refers to CTDP0200 format.</td>
</tr>
<tr><td valign="top" headers="d0e1938 ">*HTTP1 or *HTTP2</td>
<td valign="top" headers="d0e1940 ">use current HTTP URI root path</td>
<td valign="top" headers="d0e1941 ">Refers to CTDP0300 or CTDP0310 format.</td>
</tr>
<tr><td valign="top" headers="d0e1938 ">*ECCP1 or *ECCP2</td>
<td valign="top" headers="d0e1940 ">use current HTTP cluster URI root path </td>
<td valign="top" headers="d0e1941 ">No change is made.</td>
</tr>
<tr><td valign="top" headers="d0e1938 ">any other</td>
<td valign="top" headers="d0e1940 ">use default path</td>
<td valign="top" headers="d0e1941 ">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> All file requests sent to the cache target have this path inserted
into the URI, even if an absolute file path is specified. If the value is
null, Offset to HTTP cluster URI root must equal 0 (QZHT_NONE), -1 (QZHT_DEFAULT),
or -2 (QZHT_NO_CHANGE). See Offset to HTTP URI root for more details.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Initial state</strong></dt>
<dd>Specifies the state that the triggered cache manager server request processor,
for this cache target, is in at server startup. The value must equal one of
the special values described below. The default value is 1 (QZHT_ENABLED).
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.656565656565657%"><strong>1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The request processor
is enabled at server startup.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>0</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The request processor
is disabled at server startup.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_DEFAULT: The default value is used.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-2</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO_CHANGE: The current value is not changed.</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> The state of a cache target request processor can be changed
while the triggered cache manager server is active by using the -<em>chsink</em> command
in a trigger message.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Length of HTTP cluster URI root</strong></dt>
<dd>The length of the information for the HTTP cluster URI root entry.<div class="note"><span class="notetitle">Note:</span> If
Offset to HTTP cluster URI root equals 0 (QZHT_NONE), or -1 (QZHT_DEFAULT),
or -2 (QZHT_NO_CHANGE), this value must equal 0.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Number of threads</strong></dt>
<dd>The number of concurrent threads the triggered cache manager server spawns
when processing requests sent to this cache target. The value must be greater
that 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 5. <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.656565656565657%"><strong>-1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_DEFAULT: The default value is used.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-2</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO_CHANGE: The current value is not changed.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Offset to HTTP URI root</strong></dt>
<dd>The offset from the beginning of the request variable to the HTTP cluster
URI root data, in bytes. The value must be greater than 0, or equal to one
of the special values defined 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="15.656565656565657%"><strong>0</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NONE: Same as -1 (QZHT_DEFAULT).</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_DEFAULT: The default path is used for HTTP cluster
URI root.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-2</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO_CHANGE: If the current description type is *ECCP1
or *ECCP2, the current path for HTTP cluster URI root is not changed. If the
current description type is not *ECCP1 or *ECCP2, see details for HTTP cluster
URI root on how current description values are mapped for reuse by the new
description type.</td>
</tr>
</tbody>
</table>
</div>
</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). The value must specify a server name, or one of the special values
described below. If a server name is specified, that is different than the
one with which the description is currently associated, it is removed from
its current association and added for the new server.<p>Special values and
their meanings are as follows:</p>
<dl><dt class="dlterm"><strong>*SAME</strong></dt>
<dd>QZHT_NO_CHANGE_CHAR: The current server association is not changed.</dd>
</dl>
</dd>
</dl>
</div>
</div>
<div class="nested1" id="ctdp0510_format"><a name="ctdp0510_format"><!-- --></a><h2 class="topictitle2">CTDP0510 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="d0e2115">Offset</th>
<th rowspan="2" valign="top" id="d0e2117">Type</th>
<th rowspan="2" valign="top" id="d0e2119">Field</th>
</tr>
<tr><th valign="top" id="d0e2122">Dec</th>
<th valign="top" id="d0e2124">Hex</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e2115 d0e2122 ">0</td>
<td valign="top" headers="d0e2115 d0e2124 ">0</td>
<td valign="top" headers="d0e2117 ">Char(32)</td>
<td valign="top" headers="d0e2119 ">Server name</td>
</tr>
<tr><td valign="top" headers="d0e2115 d0e2122 ">32</td>
<td valign="top" headers="d0e2115 d0e2124 ">20</td>
<td valign="top" headers="d0e2117 ">Char(32)</td>
<td valign="top" headers="d0e2119 ">Cache target description name</td>
</tr>
<tr><td valign="top" headers="d0e2115 d0e2122 ">64</td>
<td valign="top" headers="d0e2115 d0e2124 ">40</td>
<td valign="top" headers="d0e2117 ">Char(10)</td>
<td valign="top" headers="d0e2119 ">Cache target type</td>
</tr>
<tr><td valign="top" headers="d0e2115 d0e2122 ">74</td>
<td valign="top" headers="d0e2115 d0e2124 ">4A</td>
<td valign="top" headers="d0e2117 ">Char(2)</td>
<td valign="top" headers="d0e2119 ">Reserved</td>
</tr>
<tr><td valign="top" headers="d0e2115 d0e2122 ">76</td>
<td valign="top" headers="d0e2115 d0e2124 ">4C</td>
<td valign="top" headers="d0e2117 ">Binary(4)</td>
<td valign="top" headers="d0e2119 ">Default property</td>
</tr>
<tr><td valign="top" headers="d0e2115 d0e2122 ">80</td>
<td valign="top" headers="d0e2115 d0e2124 ">50</td>
<td valign="top" headers="d0e2117 ">Binary(4)</td>
<td valign="top" headers="d0e2119 ">Number of threads</td>
</tr>
<tr><td valign="top" headers="d0e2115 d0e2122 ">84</td>
<td valign="top" headers="d0e2115 d0e2124 ">54</td>
<td valign="top" headers="d0e2117 ">Binary(4)</td>
<td valign="top" headers="d0e2119 ">Initial state</td>
</tr>
<tr><td valign="top" headers="d0e2115 d0e2122 ">88</td>
<td valign="top" headers="d0e2115 d0e2124 ">58</td>
<td valign="top" headers="d0e2117 ">Char(32)</td>
<td valign="top" headers="d0e2119 ">ECCP host</td>
</tr>
<tr><td valign="top" headers="d0e2115 d0e2122 ">120</td>
<td valign="top" headers="d0e2115 d0e2124 ">78</td>
<td valign="top" headers="d0e2117 ">Binary(4)</td>
<td valign="top" headers="d0e2119 ">ECCP TCP port</td>
</tr>
<tr><td valign="top" headers="d0e2115 d0e2122 ">124</td>
<td valign="top" headers="d0e2115 d0e2124 ">7C</td>
<td valign="top" headers="d0e2117 ">Char(256)</td>
<td valign="top" headers="d0e2119 ">HTTP cluster IP interface</td>
</tr>
<tr><td valign="top" headers="d0e2115 d0e2122 ">380</td>
<td valign="top" headers="d0e2115 d0e2124 ">17C</td>
<td valign="top" headers="d0e2117 ">Binary(4)</td>
<td valign="top" headers="d0e2119 ">HTTP cluster TCP port</td>
</tr>
<tr><td valign="top" headers="d0e2115 d0e2122 ">384</td>
<td valign="top" headers="d0e2115 d0e2124 ">180</td>
<td valign="top" headers="d0e2117 ">Binary(4)</td>
<td valign="top" headers="d0e2119 ">Offset to HTTP cluster URI root</td>
</tr>
<tr><td valign="top" headers="d0e2115 d0e2122 ">388</td>
<td valign="top" headers="d0e2115 d0e2124 ">184</td>
<td valign="top" headers="d0e2117 ">Binary(4)</td>
<td valign="top" headers="d0e2119 ">Length of HTTP cluster URI root</td>
</tr>
<tr><td valign="top" headers="d0e2115 d0e2122 ">392</td>
<td valign="top" headers="d0e2115 d0e2124 ">188</td>
<td valign="top" headers="d0e2117 ">Binary(4)</td>
<td valign="top" headers="d0e2119 ">ECCP keepalive</td>
</tr>
<tr><td valign="top" headers="d0e2115 d0e2122 ">&nbsp;</td>
<td valign="top" headers="d0e2115 d0e2124 ">&nbsp;</td>
<td valign="top" headers="d0e2117 ">Char(*)</td>
<td valign="top" headers="d0e2119 ">HTTP cluster URI root</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="nested1" id="ctdp0510_field_descriptions"><a name="ctdp0510_field_descriptions"><!-- --></a><h2 class="topictitle2">CTDP0510 format field descriptions</h2>
<div><div class="note"><span class="notetitle">Note:</span> If the current description type is not *ECCP2, all information currently
stored for the description, that is not mapped to one the following entries,
is discarded.</div>
<dl><dt class="dlterm"><strong>Cache target description name</strong></dt>
<dd>The name used by the cache target description (left justified and padded
with blanks if necessary). The value must be a description name, or one of
the special values described below. <p>Special values and their meanings are
as follows:</p>
<dl><dt class="dlterm"><strong>*SAME</strong></dt>
<dd>QZHT_NO_CHANGE_CHAR: The current name is not changed.</dd>
</dl>
<div class="note"><span class="notetitle">Note:</span> Cache target description names must be unique for each
triggered cache manager server. If the name is changed, while the description
is referenced by trigger handler description, they too are changed to reference
the new name.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Cache target type</strong></dt>
<dd>The changed cache target descriptions type (left justified and padded
with blanks if necessary). The value must be one of the special values described
below. <p>Special values and their meanings are as follows:</p>
<dl><dt class="dlterm"><strong>*SAME</strong></dt>
<dd>QZHT_NO_CHANGE_CHAR: The description is not changed to a different type.</dd>
</dl>
<dl><dt class="dlterm"><strong>*ECCP2</strong></dt>
<dd>QZHT_ECCP_TYPE2: The description is changed to an *ECCP2 type cache target
description.</dd>
</dl>
<div class="note"><span class="notetitle">Note:</span> If a type is specified, that is different than the current
type, certain information is discarded if it cannot be mapped to values for
reuse by the new description type.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Default property</strong></dt>
<dd>Specifies if the description is a default cache target description for
the triggered cache manager server specified in Server name. The value must
equal one of the special values described below. The default value is 0 (QZHT_NO).
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.656565656565657%"><strong>1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The description is
a default cache target description for this server.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>0</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The description
is not a default cache target description.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_DEFAULT: The default value is specified.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-2</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO_CHANGE: The current value is not changed.</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> Multiple default cache target descriptions are allowed. Trigger
handler descriptions added or changed, using the *DEFAULT special value, reference
all cache target descriptions designated as default at the time they are added
or changed.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>ECCP host</strong></dt>
<dd>The name of a host description associated with the triggered cache manager
server referenced by the cache target description and used later, at server
startup, to obtain information about the network router that hosts a web server
cluster cache target. The value must be a host description name, or one of
the special values described below (left justified and padded with blanks
if necessary). The default setting references the description currently designated
as the default host description for the triggered cache manager server. <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 referenced.</dd>
</dl>
<dl><dt class="dlterm"><strong>*SAME</strong></dt>
<dd>QZHT_NO_CHANGE_CHAR: The following rules are used to map current description
values for reuse:</dd>
</dl>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" id="d0e2377">If the current type is:</th>
<th valign="top" id="d0e2379">&nbsp;</th>
<th valign="top" id="d0e2380">Details</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e2377 ">*HTTP2</td>
<td valign="top" headers="d0e2379 ">the description currently referenced for HTTP host is
referenced </td>
<td valign="top" headers="d0e2380 ">An exception occurs if the referenced description does
not exist. Refers to CTDP0510 format.</td>
</tr>
<tr><td valign="top" headers="d0e2377 ">*ECCP2</td>
<td valign="top" headers="d0e2379 ">the description currently referenced for ECCP host is
not changed </td>
<td valign="top" headers="d0e2380 ">No change is made.</td>
</tr>
<tr><td valign="top" headers="d0e2377 ">any other</td>
<td valign="top" headers="d0e2379 ">the default host description currently associated with
the triggered cache manager server is referenced</td>
<td valign="top" headers="d0e2380 ">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> See ECCP TCP port for more information. An escape message is
sent if the referenced description does not currently exist, or if *DEFAULT
is specified and there is currently no default host description for the server.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>ECCP keepalive</strong></dt>
<dd>Specifies if the connection to the network router is kept open for reuse
after data is transferred. The value must equal one of the special values
described below. The default value is 0 (QZHT_DISABLED).
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.656565656565657%"><strong>1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The connection is
kept open after data transfer.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>0</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The connection is
closed after data transfer.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_DEFAULT: The default value is used.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-2</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO_CHANGE: The following rules are used to map
current description values for reuse:</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" id="d0e2448">If the current type is:</th>
<th valign="top" id="d0e2450">&nbsp;</th>
<th valign="top" id="d0e2451">Details</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e2448 ">*HTTP1 or *HTTP2</td>
<td valign="top" headers="d0e2450 ">use current HTTP keepalive value</td>
<td valign="top" headers="d0e2451 ">Refers to CTDP0300 or CTDP0310 format.</td>
</tr>
<tr><td valign="top" headers="d0e2448 ">*ECCP1 or *ECCP2</td>
<td valign="top" headers="d0e2450 ">use current ECCP keepalive value</td>
<td valign="top" headers="d0e2451 ">No change is made.</td>
</tr>
<tr><td valign="top" headers="d0e2448 ">any other</td>
<td valign="top" headers="d0e2450 ">use default value</td>
<td valign="top" headers="d0e2451 ">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> The network router must support keepalive for this option to
function properly.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>ECCP TCP port</strong></dt>
<dd>The TCP port number upon which the network router listens for incoming
requests. The value must be greater than 0 and less than 65536, or equal to
one of the special values described below. There is no default value for this
entry. <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.656565656565657%"><strong>-2</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO_CHANGE: If the current description type is *ECCP1
or *ECCP2, the current value is not changed.</td>
</tr>
<tr><td colspan="2" valign="top"><div class="note"><span class="notetitle">Note:</span> If the current description type
is not *ECCP1 or *ECCP2, an escape message is sent if -2 (QZHT_NO_CHANGE)
is specified.</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> The TCP port number is used in combination with the IP host
name or address, in ECCP host, to establish communications with the network
router cache target.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>HTTP cluster IP interface</strong></dt>
<dd>The IP host name or address of the web server cluster from which the network
router is hosting a cache (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. There is no default value for this
entry.<p>Special values and their meanings are as follows:</p>
<dl><dt class="dlterm"><strong>*SAME</strong></dt>
<dd>QZHT_NO_CHANGE_CHAR: The following rules are used to map current description
values for reuse:</dd>
</dl>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" id="d0e2525">If the current type is:</th>
<th valign="top" id="d0e2527">&nbsp;</th>
<th valign="top" id="d0e2528">Details</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e2525 ">*HTTP1</td>
<td valign="top" headers="d0e2527 ">use current HTTP IP interface value</td>
<td valign="top" headers="d0e2528 ">Refers to CTDP0300 format.</td>
</tr>
<tr><td valign="top" headers="d0e2525 ">*HTTP2</td>
<td valign="top" headers="d0e2527 ">use IP interface value from the host description currently
referenced by HTTP host </td>
<td valign="top" headers="d0e2528 ">Refers to the CTDP0310 format.</td>
</tr>
<tr><td valign="top" headers="d0e2525 ">*ECCP1</td>
<td valign="top" headers="d0e2527 ">use current ECCP IP interface value</td>
<td valign="top" headers="d0e2528 ">Refers to CTDP0500 format.</td>
</tr>
<tr><td valign="top" headers="d0e2525 ">*ECCP2</td>
<td valign="top" headers="d0e2527 ">use IP interface value from the host description currently
referenced by ECCP host </td>
<td valign="top" headers="d0e2528 ">No change is made.</td>
</tr>
<tr><td colspan="3" valign="top" headers="d0e2525 d0e2527 d0e2528 "><div class="note"><span class="notetitle">Note:</span> An exception occurs if the current
type is not one of the types listed above and *SAME is specified for HTTP
cluster IP interface.</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> See HTTP cluster TCP port for more information.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>HTTP cluster TCP port</strong></dt>
<dd>The TCP port number associated with the IP host name or address described
by HTTP cluster IP interface. The value must be greater than 0 and less than
65536, or one of the special values described below. There is no default value
for this entry. <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.656565656565657%"><strong>-2</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO_CHANGE: The following rules are used to map
current description values for reuse:</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" id="d0e2592">If the current type is:</th>
<th valign="top" id="d0e2594">&nbsp;</th>
<th valign="top" id="d0e2595">Details</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e2592 ">*HTTP1 or *HTTP2</td>
<td valign="top" headers="d0e2594 ">use current HTTP TCP port value</td>
<td valign="top" headers="d0e2595 ">Refers to CTDP0300 or CTDP0310 format.</td>
</tr>
<tr><td valign="top" headers="d0e2592 ">*ECCP1 or *ECCP2</td>
<td valign="top" headers="d0e2594 ">use current ECCP TCP port value</td>
<td valign="top" headers="d0e2595 ">No change is made.</td>
</tr>
<tr><td colspan="3" valign="top" headers="d0e2592 d0e2594 d0e2595 "><div class="note"><span class="notetitle">Note:</span> An exception occurs if the current
type is not one of the types listed above and -2 (QZHT_NO_CHANGE) is specified
for HTTP cluster IP interface.</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> The network router using the address, described by ECCP IP interface,
may host multiple web server caches. The specified TCP port number is used
in combination with the IP interface in HTTP cluster IP interface to identify
a particular web server cache when communicating with the network router.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>HTTP cluster URI root</strong></dt>
<dd>The web server cluster URI path that is used to define the root of this
cache target (left justified and padded with blanks if necessary). The value
must be a path acceptable to the web server cluster from which the network
router is hosting a cache. The default path is /. <p>If Offset to HTTP cluster
URI root equals -2 (QZHT_NO_CHANGE), the following rules are used to map current
description values for reuse:</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" id="d0e2634">If the current type is:</th>
<th valign="top" id="d0e2636">&nbsp;</th>
<th valign="top" id="d0e2637">Details</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e2634 ">*IFS</td>
<td valign="top" headers="d0e2636 ">use current Local directory root path</td>
<td valign="top" headers="d0e2637 ">Refers to CTDP0200 format.</td>
</tr>
<tr><td valign="top" headers="d0e2634 ">*HTTP1 or *HTTP2</td>
<td valign="top" headers="d0e2636 ">use current HTTP URI root path</td>
<td valign="top" headers="d0e2637 ">Refers to CTDP0300 or CTDP0310 format.</td>
</tr>
<tr><td valign="top" headers="d0e2634 ">*ECCP1 or *ECCP2</td>
<td valign="top" headers="d0e2636 ">use current HTTP cluster URI root path </td>
<td valign="top" headers="d0e2637 ">No change is made.</td>
</tr>
<tr><td valign="top" headers="d0e2634 ">any other</td>
<td valign="top" headers="d0e2636 ">use default path</td>
<td valign="top" headers="d0e2637 ">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> All file requests sent to the cache target have this path inserted
into the URI, even if an absolute file path is specified. If the value is
null, Offset to HTTP cluster URI root must equal 0 (QZHT_NONE), -1 (QZHT_DEFAULT),
or -2 (QZHT_NO_CHANGE). See Offset to HTTP URI root for more details.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Initial state</strong></dt>
<dd>Specifies the state that the triggered cache manager server request processor,
for this cache target, is in at server startup. The value must equal one of
the special values described below. The default value is 1 (QZHT_ENABLED).
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.656565656565657%"><strong>1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The request processor
is enabled at server startup.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>0</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The request processor
is disabled at server startup.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_DEFAULT: The default value is used.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-2</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO_CHANGE: The current value is not changed.</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> The state of a cache target request processor can be changed
while the triggered cache manager server is active by using the -<em>chsink</em> command
in a trigger message.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Length of HTTP cluster URI root</strong></dt>
<dd>The length of the information for the HTTP cluster URI root entry.<div class="note"><span class="notetitle">Note:</span> If
Offset to HTTP cluster URI root equals 0 (QZHT_NONE), or -1 (QZHT_DEFAULT),
or -2 (QZHT_NO_CHANGE), this value must equal 0.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Number of threads</strong></dt>
<dd>The number of concurrent threads the triggered cache manager server spawns
when processing requests sent to this cache target. The value must be greater
that 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 5. <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.656565656565657%"><strong>-1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_DEFAULT: The default value is used.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-2</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO_CHANGE: The current value is not changed.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Offset to HTTP URI root</strong></dt>
<dd>The offset from the beginning of the request variable to the HTTP cluster
URI root data, in bytes. The value must be greater than 0, or equal to one
of the special values defined 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="15.656565656565657%"><strong>0</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NONE: Same as -1 (QZHT_DEFAULT).</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_DEFAULT: The default path is used for HTTP cluster
URI root.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-2</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO_CHANGE: If the current description type is *ECCP1
or *ECCP2, the current path for HTTP cluster URI root is not changed. If the
current description type is not *ECCP1 or *ECCP2, see details for HTTP cluster
URI root on how current description values are mapped for reuse by the new
description type.</td>
</tr>
</tbody>
</table>
</div>
</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). The value must specify a server name, or one of the special values
described below. If a server name is specified, that is different than the
one with which the description is currently associated, it is removed from
its current association and added for the new server. <p>Special values and
their meanings are as follows:</p>
<dl><dt class="dlterm"><strong>*SAME</strong></dt>
<dd>QZHT_NO_CHANGE_CHAR: The current server association is not changed.</dd>
</dl>
<div class="note"><span class="notetitle">Note:</span> An escape message is sent if the description is removed
from its current association while being referenced by other descriptions.</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>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>TCM7222 E</strong></dt>
<dd>A default &amp;1 is not designated for triggered cache manager server &amp;2.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7290 E</strong></dt>
<dd>&amp;1 &amp;2 was not found for triggered cache manager server &amp;3.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7293 E</strong></dt>
<dd>A &amp;1 using the name &amp;2 already exists for triggered cache manager
server &amp;3.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM72C0 E</strong></dt>
<dd>Triggered cache manager &amp;1 name is not valid.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM72C1 E</strong></dt>
<dd>Triggered cache manager &amp;1 type is not valid.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM72C2 E</strong></dt>
<dd>Triggered cache manager description type &amp;1 cannot be specified when
using data format &amp;2.</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>