229 lines
11 KiB
HTML
229 lines
11 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 Apache Server Instance Data (QzuiChangeInstanceData) 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_qzuichangeinstancedata" />
|
|
<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 Apache Server Instance Data (QzuiChangeInstanceData) API</title>
|
|
</head>
|
|
<body id="rzaieapi_qzuichangeinstancedata"><a name="rzaieapi_qzuichangeinstancedata"><!-- --></a>
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
|
<!--Java sync-link--><h1 class="topictitle1">Change Apache Server Instance Data (QzuiChangeInstanceData) 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="note"><span class="notetitle">Note:</span> This API is for HTTP Server (powered by Apache)</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%">name</td>
|
|
<td valign="top" width="31.060606060606062%">Input</td>
|
|
<td valign="top" width="31.313131313131315%">Char(10)</td>
|
|
</tr>
|
|
<tr><td align="right" valign="top" width="6.313131313131313%">2</td>
|
|
<td valign="top" width="31.313131313131315%">idata</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%">3</td>
|
|
<td valign="top" width="31.313131313131315%">idata_size</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%">4</td>
|
|
<td valign="top" width="31.313131313131315%">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%">5</td>
|
|
<td valign="top" width="31.313131313131315%">errcode</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">Threadsafe: Yes</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p>Use the <em>QzuiChangeInstanceData</em> API to change the information contained
|
|
in the instance file. The idata information is retrieved in the format specified
|
|
by INSD0110.</p>
|
|
</div>
|
|
<div class="nested1" id="authoritylocks"><a name="authoritylocks"><!-- --></a><h2 class="topictitle2">Authorities and locks</h2>
|
|
<div><ul><li>*EXECUTE authority to the QUSRSYS library</li>
|
|
<li>*OBJOPR, *OBJMGT, *ADD, and *DLT authority to the QUSRSYS/QATMHINSTC file</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>name</strong></dt>
|
|
<dd>INPUT:CHAR(10) <p>Name of the server instance from which data is retrieved.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>idata</strong></dt>
|
|
<dd>INPUT:CHAR(*) <p>Buffer in format INSD0110 containing instance file date.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>idata_size</strong></dt>
|
|
<dd>INPUT:BINARY(4) <p>Length of instance data passed.</p>
|
|
</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>format</strong></dt>
|
|
<dd>INPUT:CHAR(8) <p>Format of the instance data (INSD0110).</p>
|
|
</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>errcode</strong></dt>
|
|
<dd>I/O:CHAR(*) <p>Error information structure.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</div>
|
|
<div class="nested1" id="insd0110_format"><a name="insd0110_format"><!-- --></a><h2 class="topictitle2">INSD0110 format</h2>
|
|
<div><p>This data format is used by the <em>QzuiCreateInstance</em>, <em>QzuiGetInstanceData</em>,
|
|
and <em>QzuiChangeInstanceData</em> APIs.</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" id="d0e166">Offset</th>
|
|
<th valign="top" id="d0e168">Type</th>
|
|
<th valign="top" id="d0e170">Field</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td valign="top" headers="d0e166 ">0</td>
|
|
<td valign="top" headers="d0e168 ">Char(10)</td>
|
|
<td valign="top" headers="d0e170 ">Autostart</td>
|
|
</tr>
|
|
<tr><td valign="top" headers="d0e166 ">10</td>
|
|
<td valign="top" headers="d0e168 ">Binary(4)</td>
|
|
<td valign="top" headers="d0e170 ">Threads</td>
|
|
</tr>
|
|
<tr><td valign="top" headers="d0e166 ">14</td>
|
|
<td valign="top" headers="d0e168 ">Binary(4)</td>
|
|
<td valign="top" headers="d0e170 ">CCSID</td>
|
|
</tr>
|
|
<tr><td valign="top" headers="d0e166 ">18</td>
|
|
<td valign="top" headers="d0e168 ">Char(10)</td>
|
|
<td valign="top" headers="d0e170 ">Outgoing table name</td>
|
|
</tr>
|
|
<tr><td valign="top" headers="d0e166 ">28</td>
|
|
<td valign="top" headers="d0e168 ">Char(10)</td>
|
|
<td valign="top" headers="d0e170 ">Outgoing table library</td>
|
|
</tr>
|
|
<tr><td valign="top" headers="d0e166 ">38</td>
|
|
<td valign="top" headers="d0e168 ">Char(10)</td>
|
|
<td valign="top" headers="d0e170 ">Incoming table name</td>
|
|
</tr>
|
|
<tr><td valign="top" headers="d0e166 ">48</td>
|
|
<td valign="top" headers="d0e168 ">Char(10)</td>
|
|
<td valign="top" headers="d0e170 ">Incoming table library</td>
|
|
</tr>
|
|
<tr><td valign="top" headers="d0e166 ">58</td>
|
|
<td valign="top" headers="d0e168 ">Char(512)</td>
|
|
<td valign="top" headers="d0e170 ">Config file (full path)</td>
|
|
</tr>
|
|
<tr><td valign="top" headers="d0e166 ">570</td>
|
|
<td valign="top" headers="d0e168 ">Char(512)</td>
|
|
<td valign="top" headers="d0e170 ">Server root path</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="nested1" id="field_description"><a name="field_description"><!-- --></a><h2 class="topictitle2">Field description</h2>
|
|
<div><div class="note"><span class="notetitle">Note:</span> In the descriptions below, *GLOBAL indicates that the global server
|
|
parameter value for this field is used by the instance, and *CFG indicates
|
|
that the value from the named configuration file is used. All character strings
|
|
are padded with blanks as necessary, and are NOT null terminated.</div>
|
|
<dl><dt class="dlterm"><strong>Autostart</strong></dt>
|
|
<dd>Indicates if the instance starts automatically. It is a 10 character string
|
|
that contains *NO, *YES, or *GLOBAL.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>Threads</strong></dt>
|
|
<dd>The number of threads to use for this instance. It is an integer from
|
|
0 to 999, where 0 means the *CFG value.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>CCSID</strong></dt>
|
|
<dd>The character set to be used by the instance. It is an integer from 0
|
|
to 65533, where 0 means *GLOBAL.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>Outgoing table name</strong></dt>
|
|
<dd>The name of the table object to use as the EBCDIC to ASCII conversion
|
|
table for outgoing data. It is a 10 character name or *GLOBAL.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>Outgoing table library</strong></dt>
|
|
<dd>The library containing the EBCDIC to ASCII table. This field is blank
|
|
if the outgoing table name is *GLOBAL.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>Incoming table name</strong></dt>
|
|
<dd>The name of the table object to use as the ASCII to EBCDIC conversion
|
|
table for incoming data. It is a 10 character name or *GLOBAL.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>Incoming table library</strong></dt>
|
|
<dd>The library containing the ASCII to EBCDIC table. This field is blank
|
|
if the incoming table name is *GLOBAL.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>Config file (full path)</strong></dt>
|
|
<dd>The path to the server instance configuration file.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>Server root path</strong></dt>
|
|
<dd>The path to the server root.</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>CPF3C17 E</strong></dt>
|
|
<dd>Error occurred with input data parameter.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>CPF3C1D E</strong></dt>
|
|
<dd>Input variable length in parameter &1 not valid. CPF3C21 E</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>CPF3C21 E</strong></dt>
|
|
<dd>Format name &1 not valid.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>CPF3CF1 E</strong></dt>
|
|
<dd>Error code parameter not valid.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>CPF9822 E</strong></dt>
|
|
<dd>Not authorized to file &1 in library &2.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>CPFB602 E</strong></dt>
|
|
<dd>Cannot open file.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>HTPA001 E</strong></dt>
|
|
<dd>Input parameter &1 not valid.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>HTPA101 E</strong></dt>
|
|
<dd>Server instance &1 not found or is unreadable.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>HTPA102 E</strong></dt>
|
|
<dd>Unable to update server instance &1.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>HTPA103 E</strong></dt>
|
|
<dd>Value in field &1 of the instance data structure not valid.</dd>
|
|
</dl>
|
|
<dl><dt class="dlterm"><strong>HTPA127 E</strong></dt>
|
|
<dd>Server instance &1 is not a HTTP Server (powered by Apache) type instance.</dd>
|
|
</dl>
|
|
</div>
|
|
</div>
|
|
|
|
</body>
|
|
</html> |