516 lines
15 KiB
HTML
516 lines
15 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<!-- Begin Header records -->
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
|
|
<title>Send Service Request (QPDETSND) API</title>
|
|
<!-- 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. -->
|
|
<!-- Created for VxRy on YYMMDD by INITIALS -->
|
|
<!-- Change history: -->
|
|
<!-- YYMMDD INITIALS change description -->
|
|
<!-- End Header Records -->
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
|
</head>
|
|
<body>
|
|
<!-- Java sync-link -->
|
|
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
|
|
</script>
|
|
|
|
<a name="Top_Of_Page"></a>
|
|
|
|
<h2><img src="delta.gif" alt="Start of change">Send Service Request (QPDETSND) API</h2>
|
|
<div class="box" style="width: 80%;">
|
|
<br>
|
|
Required Parameter Group:<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
<table width="100%">
|
|
|
|
<tr>
|
|
<td align="center" valign="top">1</td>
|
|
<td align="left" valign="top">Request Data</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">2</td>
|
|
<td align="left" valign="top">Length of request data</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">3</td>
|
|
<td align="left" valign="top" width="50%">Format or request data</td>
|
|
<td align="left" valign="top" width="20%">Input</td>
|
|
<td align="left" valign="top" width="20%">Char(8)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">Error Code</td>
|
|
<td align="left" valign="top">I/O</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: No<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
|
|
<br>
|
|
<br>
|
|
|
|
<p>The <strong>Send Service Request (QPDETSND) API</strong> will send the request to the Service Monitor or to the Service Control job.</p>
|
|
|
|
<p>If the Service Control job is not active, the job will be submitted.</p>
|
|
|
|
<p>If the Service Monitor is not active, and the request is for a Service Monitor function, a request will be submitted to the Service Control job to start the Service Monitor before sending the request.</p>
|
|
|
|
<br>
|
|
|
|
<!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and locks. -->
|
|
<!-- Instead, use the commented out coding below to indicate NONE. -->
|
|
<h3>Authorities and Locks</h3>
|
|
<dl>
|
|
<dt><em>Authority to use the API</em></dt>
|
|
|
|
<dd>None<br>
|
|
<br>
|
|
</dd></dl>
|
|
|
|
<!-- Use this if there are no authorities and locks. -->
|
|
<!-- <p>None.</p> -->
|
|
|
|
<br>
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Request data</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>Information to use while processing the request. The format of this data is specified by the Format of request data parameter.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Length of request data</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>How long the request data is.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Format of request data.</strong> This indicates the type of request being submitted. Only the following values are accepted:</dt>
|
|
<dd>
|
|
INPUT; CHAR(8)
|
|
<p><em><u><a href="#sndr0100">SNDR 0100</a></u></em> Send a refresh Service Monitor policy file request</p>
|
|
<p><em><u><a href="#sndr0200">SNDR 0200</a></u></em> Send a start function request</p>
|
|
<p><em><u><a href="#sndr0300">SNDR 0300</a></u></em> Send a stop function request</p>
|
|
<p><em><u><a href="#sndr0400">SNDR 0400</a></u></em> Send a Service event request</p>
|
|
<p><em><u><a href="#sndr0500">SNDR 0500</a></u></em> Send a change logging level request</p>
|
|
<p><em><u><a href="#sndr0600">SNDR 0600</a></u></em> Send a handle changed system value request</p>
|
|
</dd>
|
|
|
|
|
|
<dt><strong>Error code</strong></dt>
|
|
|
|
<dd>I/O; CHAR(*)
|
|
|
|
<p>The structure in which to return error information. For the format of the
|
|
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
<a name="sndr0100"></a>
|
|
<h3>SNDR0100 - Refresh Policy File Request</h3>
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th align="left" valign="bottom">Dec</th>
|
|
<th align="left" valign="bottom">Hex</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="left" valign="top" width="20%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Type of policy data</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Length of policy data</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Policy data</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
|
|
<a name="sndr0200"></a>
|
|
<h3>SNDR0200 - Start a Function Request</h3>
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th align="left" valign="bottom">Dec</th>
|
|
<th align="left" valign="bottom">Hex</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="left" valign="top" width="20%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Number of functions to start</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">Array of BIN(4)</td>
|
|
<td align="left" valign="top">Functions to start</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<a name="sndr0300"></a>
|
|
<h3>SNDR0300 - Stop a Function Request</h3>
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th align="left" valign="bottom">Dec</th>
|
|
<th align="left" valign="bottom">Hex</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="left" valign="top" width="20%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Number of functios to stop</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">Array of BIN(4)</td>
|
|
<td align="left" valign="top">Functions to stop</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<a name="sndr0400"></a>
|
|
<h3>SNDR0400 - Service Event Request</h3>
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th align="left" valign="bottom">Dec</th>
|
|
<th align="left" valign="bottom">Hex</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="left" valign="top" width="20%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Length of service event data</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Service event data</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<a name="sndr0500"></a>
|
|
<h3>SNDR0500 - Change Logging Levels Request</h3>
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th align="left" valign="bottom">Dec</th>
|
|
<th align="left" valign="bottom">Hex</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="left" valign="top" width="20%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Logging Level</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<a name="sndr0600"></a>
|
|
<h3>SNDR0600 - Handle Changed System Value Request</h3>
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th align="left" valign="bottom">Dec</th>
|
|
<th align="left" valign="bottom">Hex</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="left" valign="top" width="20%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Number of system values changed</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">Array of CHAR(10)</td>
|
|
<td align="left" valign="top">System Value names</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
<h3><a name="flddsc">Field Descriptions</a></h3>
|
|
|
|
<p><strong>Functions to start.</strong> An array of BINARY(4) values. Each value indicates a particular function to start. Supported values are:</p>
|
|
<table width="60%">
|
|
<tr>
|
|
<td width="10%">1</td>
|
|
<td width="90%"> Start the Service Monitor function</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="10%">2</td>
|
|
<td width="90%"> Start the Communications Trace Analyzer Function</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
<p><strong>Functions to stop.</strong> An array of BINARY(4) values. Each value indicates a particular function to stop. Supported values are:</p>
|
|
|
|
<table width="60%">
|
|
<tr>
|
|
<td width="10%">1</td>
|
|
<td width="90%"> Stop the Service Monitor function</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="10%">2</td>
|
|
<td width="90%"> Stop the Communications Trace Analyzer Function</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="10%">3</td>
|
|
<td width="90%"> Stop the Service Control function</td>
|
|
</tr>
|
|
</table>
|
|
<br>
|
|
<br>
|
|
|
|
<p><strong>Length of policy data.</strong> The length of the provided data.</p>
|
|
|
|
<p><strong>Length of service event data.</strong> The length of the service event data provided.</p>
|
|
|
|
<p><strong>Logging level.</strong> The logging level of the Service Monitor function. This value should only be used when requested by IBM Support personnel. This changes the amount of data which the Service Monitor logs for problem determination reasons. Supported values are:</p>
|
|
|
|
<table width="60%">
|
|
<tr>
|
|
<td width="10%">0</td>
|
|
<td width="90%"> No logging</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="10%">1</td>
|
|
<td width="90%"> Low logging</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="10%">2</td>
|
|
<td width="90%"> Medium logging</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="10%">3</td>
|
|
<td width="90%"> High logging</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
<p><strong>Number of functions to start.</strong> How many functions to start.</p>
|
|
|
|
<p><strong>Number of functions to stop.</strong> How many functions to stop.</p>
|
|
|
|
<p><strong>Number of system values changed.</strong> How many system values where changed.</p>
|
|
|
|
<p><strong>Policy data.</strong> The policy data. This data is in schema validated XML format. The location of the XSD file is imbedded within the XML.</p>
|
|
|
|
<p><strong>Service event data.</strong> Data about the service event being sent. This data is in schema validated XML format. The location of the XSD file is imbedded within the XML. This format can be generated using the <em><u>Convert Format of Service Information (QPDETCVT) API</u></em> with a format name of CVTS0100 or CVTS0200.</p>
|
|
|
|
<br>
|
|
<p><strong>System value names.</strong> An array containing the names of the system values that were changed. Supported values are:</p>
|
|
|
|
<table width="60%">
|
|
<tr>
|
|
<td width="25%">QSFWERRLOG</td>
|
|
<td width="75%">Software Error Logging</td>
|
|
</tr>
|
|
</table>
|
|
<br>
|
|
|
|
<p><strong>Type of policy data.</strong> The type of policy data provided. Supported values are:</p>
|
|
|
|
<table width="60%">
|
|
<tr>
|
|
<td width="10%">0</td>
|
|
<td width="90%">The policy data provided contains the path name to an IFS file containing policy data.</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="10%">1</td>
|
|
<td width="90%">The policy data provided contains the actual policy data.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
<br><br>
|
|
|
|
|
|
<h3><a name="errmsg">Error Messages</a></h3>
|
|
|
|
<p>The following messages may be sent from this function:</p>
|
|
|
|
<table width="100%">
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPF3CF1</td>
|
|
<td width="85%" valign="top">Error code parameter not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPF3CF2</td>
|
|
<td width="85%" valign="top">Error(s) occurred during running of * API.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPF3C1D</td>
|
|
<td width="85%" valign="top">Input variable length in parameter * not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPF3C1E</td>
|
|
<td width="85%" valign="top">Required parameter * omitted.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPF3C17</td>
|
|
<td width="85%" valign="top">Error occurred with input data parameter.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPF3C19</td>
|
|
<td width="85%" valign="top">Error occurred with receiver variable specified.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPF3C21</td>
|
|
<td width="85%" valign="top">Format name * is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPF3C24</td>
|
|
<td width="85%" valign="top">Length of receiver variable not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPF3C39</td>
|
|
<td width="85%" valign="top">Value for reserved field not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPF3C4A</td>
|
|
<td width="85%" valign="top">Value not valid for field *.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPF3C4B</td>
|
|
<td width="85%" valign="top">Value not valid for field *.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPF3C4C</td>
|
|
<td width="85%" valign="top">Value not valid for field *.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPFE083</td>
|
|
<td width="85%" valign="top">Service Monitor is not running.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPFE084</td>
|
|
<td width="85%" valign="top">Value Duplicated functions requested.</td>
|
|
</tr>
|
|
|
|
</table>
|
|
<br>
|
|
|
|
<img src="deltaend.gif" alt="End of change">
|
|
|
|
<hr>
|
|
API introduced: V5R4
|
|
|
|
<hr>
|
|
<center>
|
|
<table cellpadding="2" cellspacing="2">
|
|
<tr align="center">
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
|
"sec1.htm">Other APIs in this part</a> | <a href="aplist.htm">APIs by
|
|
category</a></td>
|
|
</tr>
|
|
</table>
|
|
</center>
|
|
|
|
</body>
|
|
</html>
|