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

277 lines
13 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?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 Host Description (QzhtChgTCMHostDesc) 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_qzhtchgtcmhostdesc" />
<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 Host Description (QzhtChgTCMHostDesc)
API</title>
</head>
<body id="rzaieapi_qzhtchgtcmhostdesc"><a name="rzaieapi_qzhtchgtcmhostdesc"><!-- --></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 Host Description (QzhtChgTCMHostDesc)
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>The QzhtChgTCMHostDesc API changes host descriptions associated with triggered
cache manager servers. Changes made to host descriptions are utilized by all
data source, cache target, and acknowledgment target descriptions referencing
them the next time the servers are started. </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 information used to change
a host description.</p>
</dd>
</dl>
<dl><dt class="dlterm"><strong>length of request variable</strong></dt>
<dd>INPUT: BINARY(4) <p>The number of bytes that the calling program provides
for request variable.</p>
</dd>
</dl>
<dl><dt class="dlterm"><strong>request variable format</strong></dt>
<dd>INPUT: CHAR(8) <p>The format name of request variable data. The following
values must be used:</p>
<ul><li>HSDP0100: Basic information format for a host description.</li>
</ul>
</dd>
</dl>
<dl><dt class="dlterm"><strong>server name</strong></dt>
<dd>INPUT: CHAR(32) <p>The name used to identify the server for which the
description is the be changed (left justified and padded with blanks if necessary).</p>
</dd>
</dl>
<dl><dt class="dlterm"><strong>description name</strong></dt>
<dd>INPUT: CHAR(32) <p>The name used to identify which host description is
the be 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="hsdp0100_format"><a name="hsdp0100_format"><!-- --></a><h2 class="topictitle2">HSDP0100 format</h2>
<div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th colspan="2" valign="top" id="d0e175">Offset</th>
<th rowspan="2" valign="top" id="d0e177">Type</th>
<th rowspan="2" valign="top" id="d0e179">Field</th>
</tr>
<tr><th valign="top" id="d0e182">Dec</th>
<th valign="top" id="d0e184">Hex</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e175 d0e182 ">0</td>
<td valign="top" headers="d0e175 d0e184 ">0</td>
<td valign="top" headers="d0e177 ">Char(32)</td>
<td valign="top" headers="d0e179 ">Server name</td>
</tr>
<tr><td valign="top" headers="d0e175 d0e182 ">32</td>
<td valign="top" headers="d0e175 d0e184 ">20</td>
<td valign="top" headers="d0e177 ">Char(32)</td>
<td valign="top" headers="d0e179 ">Host description</td>
</tr>
<tr><td valign="top" headers="d0e175 d0e182 ">64</td>
<td valign="top" headers="d0e175 d0e184 ">20</td>
<td valign="top" headers="d0e177 ">Binary(4)</td>
<td valign="top" headers="d0e179 ">Default property</td>
</tr>
<tr><td valign="top" headers="d0e175 d0e182 ">68</td>
<td valign="top" headers="d0e175 d0e184 ">44</td>
<td valign="top" headers="d0e177 ">Binary(4)</td>
<td valign="top" headers="d0e179 ">IP interface</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="nested1" id="field_descriptions"><a name="field_descriptions"><!-- --></a><h2 class="topictitle2">Field descriptions</h2>
<div><dl><dt class="dlterm"><strong>Default property</strong></dt>
<dd>Specifies whether the description is to become the default host description
for the triggered cache manager server specified in Server name. The value
must equal one of the special values described below. If the value equals
1 (QZHT_YES) and the description is not currently the default description,
the default property on the current default host description, if any, are
set to 0 (QZHT_NO) and this description takes over the default role. The default
value is –2 (QZHT_NO_CHANGE).<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.384615384615385%"><strong>1</strong></td>
<td valign="top" width="84.61538461538461%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The description is
to become the default host description for this server.</td>
</tr>
<tr><td valign="top" width="15.384615384615385%"><strong>-1</strong></td>
<td valign="top" width="84.61538461538461%">QZHT_DEFAULT: The default value is used.</td>
</tr>
<tr><td valign="top" width="15.384615384615385%"><strong>-2</strong></td>
<td valign="top" width="84.61538461538461%">QZHT_NO_CHANGE: The current value is not changed.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Host description name</strong></dt>
<dd>The name used by the host 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: The current name is not changed.</dd>
</dl>
<div class="note"><span class="notetitle">Note:</span> Host description name must be unique for each triggered
cache manager server. If the name is changed while the description is referenced
by data source, cache target, or acknowledgement target descriptions, they
too are changed to reference the new name.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>IP interface</strong></dt>
<dd>The IP host name or address of the computer system hosting servers used
by the triggered cache manager server (left justified and padded with blanks
if necessary). The value must specify a host name (i.e.: server.mycompany.com),
dotted address (i.e.: 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 systems 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 current value is not changed.</dd>
</dl>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Server name</strong></dt>
<dd>The name used to identify the triggered cache manager server with 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 which 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 it is 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">TCM7030 E</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 format specified.</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 servers &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>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>TCM72C3 E</strong></dt>
<dd>Value passed at offset &amp;1 is not valid.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM74C0 E</strong></dt>
<dd>Triggered cache manager server name is not valid.</dd>
</dl>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink