600 lines
17 KiB
HTML
600 lines
17 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
|
|
<title>Retrieve Network Server Information (QFPADRNI) API</title>
|
|
<!-- Begin Header Records ========================================= -->
|
|
<!-- 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. -->
|
|
<!-- QFPADRNI SCR450 A converted by B2H R4.1 (346) (CMS) by V2DCIJB -->
|
|
<!-- at RCHVMW2 on 20 Aug 1999 at 12:52:46 -->
|
|
<!-- Change History: -->
|
|
<!-- YYMMDD USERID Change description -->
|
|
<!-- rev1 NTAP D16210 5D10 11/05/99 Nancy Kryka -->
|
|
<!-- Nancy Kryka 12196.1 server rebranding 10/30/00 V5R1 -->
|
|
<!-- Nancy Kryka 12406 missing CPF0C4A 10/11/01 V5R2 -->
|
|
<!--File edited Oct 2001 by Janet Brauckman -->
|
|
<!--End Header Records -->
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
|
</head>
|
|
<body>
|
|
<a name="Top_Of_Page"></a>
|
|
<!-- Java sync-link -->
|
|
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
|
|
</script>
|
|
|
|
<h2>Retrieve Network Server Information (QFPADRNI) 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" width="10%">1</td>
|
|
<td align="left" valign="top" width="50%">Receiver variable</td>
|
|
<td align="left" valign="top" width="20%">Output</td>
|
|
<td align="left" valign="top" width="20%">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">2</td>
|
|
<td align="left" valign="top">Length of receiver variable</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">3</td>
|
|
<td align="left" valign="top">Format name</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(8)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">NWSD server name</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(8)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">5</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>
|
|
|
|
<br>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: No<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
|
|
|
|
<p><img src="delta.gif" alt="Start of change">The Retrieve Network Server Information (QFPADRNI) API retrieves information
|
|
from a Windows or Intel Linux server. The amount of information returned depends on the size
|
|
of the variable. The information returned is similar to the information
|
|
returned by the Work with Network Server Status (WRKNWSSTS) command's option 5,
|
|
Display details.<img src="deltaend.gif" alt="End of change"></p>
|
|
|
|
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<dl>
|
|
<dt><em>Network Server Description Authority</em></dt>
|
|
|
|
<dd>*USE</dd>
|
|
|
|
<dt><em>Network Server Description Lock</em></dt>
|
|
|
|
<dd>*EXCLRD</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Receiver variable</strong></dt>
|
|
|
|
<dd>OUTPUT; CHAR(*)
|
|
|
|
<p>The variable to receive the network server information. You can specify the
|
|
size of this area to be smaller than the format requested as long as you
|
|
specify the length parameter correctly. As a result, the API returns only the
|
|
data that the area can hold.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Length of receiver variable</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The length of the receiver variable. If the length is larger than the size
|
|
of the receiver variable, the results may not be predictable. The minimum
|
|
length is 8 bytes.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Format name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>The format of the network server information to be returned. The valid
|
|
format names are:</p>
|
|
|
|
<p><img src="delta.gif" alt="Start of change"></p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>DRNI0100</em></td>
|
|
<td align="left" valign="top">Returns information about the Windows or Intel Linux server
|
|
version and the iSeries Integration product version that is installed on the server.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>DRNI0200</em></td>
|
|
<td align="left" valign="top">Returns information about the Windows or Intel Linux server's
|
|
current status.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><img src="deltaend.gif" alt="End of change"></p>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>NWSD server name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>The name of the NWSD for which to retrieve information. The name must be
|
|
specified in upper case characters and padded with blanks to a full 8
|
|
characters.</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>
|
|
|
|
|
|
<h3><a name="HDRFPARNS1">DRNI0100 Format</a></h3>
|
|
|
|
<p>The DRNI0100 format returns network server version information.</p>
|
|
|
|
<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="center" valign="bottom">Dec</th>
|
|
<th align="center" 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%">Bytes returned</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">Bytes available</td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
<td align="center" valign="top"><img src="delta.gif" alt="Start of change">8</td>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Server operating system version</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">18</td>
|
|
<td align="center" valign="top">12</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Server operating system build ID</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="center" valign="top">1C</td>
|
|
<td align="left" valign="top">CHAR(128)</td>
|
|
<td align="left" valign="top">Server operating system service level<img src="deltaend.gif" alt="End of change"></td>
|
|
</tr>
|
|
|
|
|
|
|
|
<tr>
|
|
<td align="center" valign="top">156</td>
|
|
<td align="center" valign="top">9C</td>
|
|
<td align="left" valign="top">CHAR(6)</td>
|
|
<td align="left" valign="top">iSeries Integration version</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">162</td>
|
|
<td align="center" valign="top">A2</td>
|
|
<td align="left" valign="top">CHAR(38)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">200</td>
|
|
<td align="center" valign="top">C8</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to list of iSeries Integration service
|
|
pack entries</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">204</td>
|
|
<td align="center" valign="top">CC</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Length of an iSeries Integration service pack
|
|
entry</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">208</td>
|
|
<td align="center" valign="top">D0</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Number of iSeries Integration service pack
|
|
entries</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">212</td>
|
|
<td align="center" valign="top">D4</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to list of iSeries Integration hot fix
|
|
entries</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">216</td>
|
|
<td align="center" valign="top">D8</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Length of an iSeries Integration hot fix
|
|
entry</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">220</td>
|
|
<td align="center" valign="top">DC</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Number of iSeries Integration hot fix entries
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" rowspan="2" colspan="2">These fields repeat for
|
|
each iSeries Integration service pack.</td>
|
|
<td align="left" valign="top">CHAR(7)</td>
|
|
<td align="left" valign="top">iSeries Integration service pack</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" rowspan="2" colspan="2">These fields repeat for each iSeries Integration hot
|
|
fix.</td>
|
|
<td align="left" valign="top">CHAR(7)</td>
|
|
<td align="left" valign="top">iSeries Integration hot fix</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRFPARNS2">DRNI0200 Format</a></h3>
|
|
|
|
<p>The DRNI0200 format returns network server status information.</p>
|
|
|
|
<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="center" valign="bottom">Dec</th>
|
|
<th align="center" 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%">Bytes returned</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">Bytes available</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Connected users</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">12</td>
|
|
<td align="center" valign="top">C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Processor used</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">16</td>
|
|
<td align="center" valign="top">10</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Paging file used</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="center" valign="top">14</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Registry quota used</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">24</td>
|
|
<td align="center" valign="top">18</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to list of multiple processor usage
|
|
entries</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="center" valign="top">1C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Length of a multiple processor usage entry</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">32</td>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Number of multiple processor usage entries</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" rowspan="2" colspan="2">This field repeats for
|
|
each multiple processor usage entry</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Multiple processor usage</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRFPARNSD">Field Descriptions</a></h3>
|
|
|
|
<p><strong>Bytes available.</strong> The length of all data available for the
|
|
requested format. All available data is returned if enough space is
|
|
provided.</p>
|
|
|
|
<p><strong>Bytes returned.</strong> The length of all data actually returned.
|
|
If the data is truncated because the receiver variable is not large enough to
|
|
hold the data, this value is less than the bytes available.</p>
|
|
|
|
<p><strong>Connected users.</strong> Number of user connections currently
|
|
present on this server.</p>
|
|
|
|
<p><img src="delta.gif" alt="Start of change"></p>
|
|
|
|
<p><strong>iSeries Integration
|
|
hot fix.</strong> The identifier for an iSeries Integration
|
|
hot fix that is installed on the server.</p>
|
|
|
|
<p><strong>iSeries Integration service pack.</strong> The identifier for an
|
|
iSeries Integration service pack that is installed on the
|
|
server.</p>
|
|
|
|
<p><strong>iSeries Integration version.</strong> The version number of the
|
|
iSeries Integration product that is installed on the server.
|
|
The value has the format VxRyMz, where x is the version, y is the release, and
|
|
z is the modification.</p>
|
|
|
|
<p><img src="deltaend.gif" alt="End of change"></p>
|
|
|
|
<p><strong>Length of a multiple processor usage entry.</strong> The length of
|
|
one multiple processor usage entry.</p>
|
|
|
|
<p><strong>Length of an iSeries
|
|
Integration hot fix entry.</strong> The length of one iSeries Integration hot
|
|
fix entry.</p>
|
|
|
|
<p><strong>Length of an iSeries Integration service pack entry.</strong> The
|
|
length of one iSeries Integration service pack entry.</p>
|
|
|
|
<p><strong>Multiple processor usage.</strong> The percent usage for servers
|
|
that support multiple processors. This number is the processor usage value for
|
|
an individual processor, represented as an integer value between 0 and 100. A
|
|
usage value is returned for each processor, so the number of values returned
|
|
depends on the number of processors on the server.</p>
|
|
|
|
<p><strong>Number of iSeries
|
|
Integration hot fix entries.</strong> The number of times the iSeries
|
|
Integration hot fix entries are repeated.</p>
|
|
|
|
<p><strong>Number of iSeries Integration service pack entries.</strong> The
|
|
number of times the iSeries Integration service pack entries are repeated.</p>
|
|
|
|
<p><strong>Number of multiple processor usage entries.</strong> The number of
|
|
times the multiple processor usage entries are repeated.</p>
|
|
|
|
<p><strong>Offset to list of
|
|
iSeries Integration hot fix entries.</strong> The offset to the first entry in
|
|
the iSeries Integration hot fix list.</p>
|
|
|
|
<p><strong>Offset to list of iSeries Integration service pack entries.</strong>
|
|
The offset to the first entry in the iSeries Integration service pack list.</p>
|
|
|
|
<p><strong>Offset to list of multiple processor usage entries.</strong> The
|
|
offset to the first entry in the multiple processor usage list.</p>
|
|
|
|
<p><strong>Paging file used.</strong> The percentage of the server paging file
|
|
used. This percentage is expressed as an integer value between 0 and 100.</p>
|
|
|
|
<p><strong>Processor used.</strong> The percentage of the server's processor
|
|
used. This percentage is expressed as an integer value between 0 and 100.</p>
|
|
|
|
<p>If the server supports a single processor, this number is the usage for the
|
|
individual processor. If the server supports multiple processors, this number
|
|
is the average processor usage for all of the processors.</p>
|
|
|
|
<p><strong>Registry quota used.</strong> The percentage of the server's
|
|
registry used. This percentage is expressed as an integer value between 0 and
|
|
100.</p>
|
|
|
|
<p><strong>Reserved.</strong> Reserved space.</p>
|
|
|
|
<p><img src="delta.gif" alt="Start of change"></p>
|
|
|
|
<p><strong>Server operating system build ID.</strong> The current build identifier of the server operating system.</p>
|
|
|
|
<p><strong>Server operating system service level.</strong> The service level of the operating system that is installed on the server.</p>
|
|
|
|
<p><strong>Server operating system version.</strong> The current version of the operating system on the server.</p>
|
|
|
|
<p><img src="deltaend.gif" alt="End of change"></p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Messages</h3>
|
|
|
|
<table width="100%">
|
|
<tr>
|
|
<th align="left" valign="top">Message ID</th>
|
|
<th align="left" valign="top">Error Message Text</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPF0C4A E</td>
|
|
<td width="85%" valign="top">Product record not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF24B4 E</td>
|
|
<td valign="top">Severe error while addressing parameter list.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF2625 E</td>
|
|
<td valign="top">Not able to allocate object &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF2634 E</td>
|
|
<td valign="top">Not authorized to object &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3C17 E</td>
|
|
<td valign="top">Error occurred with input data parameter.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3C19 E</td>
|
|
<td valign="top">Error occurred with receiver variable specified.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3C21 E</td>
|
|
<td valign="top">Format name &1 is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3C24 E</td>
|
|
<td valign="top">Length of the receiver variable is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3CF1 E</td>
|
|
<td valign="top">Error code parameter not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF9806 E</td>
|
|
<td valign="top">Cannot perform function for object &2 in library
|
|
&3.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF9872 E</td>
|
|
<td valign="top">Program or service program &1 in library &2 ended.
|
|
Reason code &3.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
|
|
|
|
<hr>
|
|
API introduced: V4R5
|
|
|
|
<hr>
|
|
<center>
|
|
<table cellpadding="2" cellspacing="2">
|
|
<tr align="center">
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
|
"ss1.htm">Server Support APIs</a> | <a href="aplist.htm">APIs by
|
|
category</a></td>
|
|
</tr>
|
|
</table>
|
|
</center>
|
|
</body>
|
|
</html>
|
|
|