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

1530 lines
44 KiB
HTML
Raw Permalink Normal View History

Add readme and dist folders
2024-04-02 14:02:31 +00:00
<!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>Open List Network Servers (QFPADOLS) 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. -->
<!-- QFPADOLS SCRIPT A converted by B2H R4.1 (346) (CMS) by V2DCIJB -->
<!-- at RCHVMW2 on 20 Aug 1999 at 12:37:54 -->
<!-- ==========CHANGE HISTORY======================================= -->
<!-- DCR/PTR Rel Date Person : Description of change -->
<!-- D16210 5D10 111799 KRYKA : Add threadsafe statement -->
<!-- D98885 5D20 041101 KRYKA : Add version, hdw, service packs -->
<!-- D98885 5D20 062701 KRYKA : CPF2625 -->
<!-- D99492 5D30 082302 MEADEN : Add Windows Ver, SP, & Build -->
<!-- D99710 5D40 080104 krisd : Add DOLS0200 Format -->
<!-- D93187 5D40 050305 KRYKA : Remove IOP processor -->
<!--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>Open List Network Servers (QFPADOLS) API</h2>
<div class="box" style="width: 80%;">
<br>
&nbsp;&nbsp;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">List information</td>
<td align="left" valign="top">Output</td>
<td align="left" valign="top">Char(80)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Number of records to return</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">5</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">6</td>
<td align="left" valign="top">Server name qualifier</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">7</td>
<td align="left" valign="top">Length of server name qualifier</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">8</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>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Open List Network Servers (QFPADOLS) API retrieves a list of servers.
The functions provided by this API are similar to the Work with Network Server
Status (WRKNWSSTS) command.</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 receiver variable that receives the information requested. You can
specify the size of the 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 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 provided. The length of the receiver
variable parameter may be specified up to the size of the receiver variable
specified in the user program. If the length of the receiver variable parameter
specified is larger than the allocated size of the receiver variable specified
in the user program, the results are not predictable. The minimum length is 0
bytes.</p>
</dd>
<dt><strong>List information</strong></dt>
<dd>OUTPUT; CHAR(80)
<p>Information about the list created by this program. For a description of the
layout of this parameter, see <a href="#HDRODOLSI">Format of List
Information</a>.</p>
</dd>
<dt><strong>Number of records to return</strong></dt>
<dd>INPUT; BINARY(4)
<p>The number of records in the list to put into the receiver variable. The
value must be 0 or greater.</p>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The format of the information returned. You must use one of the the following format
names:</p>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>DOLS0100</em></td>
<td align="left" valign="top">The output server list structure for Windows
servers only. For more information, see <a href="#HDRFPDOL1">DOLS0100
Format</a>.</td>
</tr>
<tr><td><img src="delta.gif" alt="Start of change"></td></tr>
<tr>
<td align="left" valign="top">
<em>DOLS0200</em></td>
<td align="left" valign="top">The output server list structure for *WINDOWS, *LINUX, and *AIX NWS server types (*NETWARE servers are excluded) in the hosting partition. For more information, see <a href="#HDRFPDOL2">DOLS0200
Format</a>.</td>
</tr>
<tr><td><img src="deltaend.gif" alt="End of change"></td></tr>
</table>
<br>
</dd>
<dt><strong>Server name qualifier</strong></dt>
<dd>INPUT; CHAR(*)
<p>A restriction on the information to be retrieved. This parameter allows the
caller to request a subset of the entries that normally would be returned on a
given format. If this parameter is *ALL, no information qualification is
performed. Allowable values are:</p>
<table cellpadding="3">
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">Information about all servers.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Server name</em></td>
<td align="left" valign="top">Information about the specified server name entry
only.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Generic server name*</em></td>
<td align="left" valign="top">Information about servers matching the generic
server name string.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Length of server name qualifier</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the server name qualifier.</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>. If this
parameter is omitted, diagnostic and escape messages are issued to the
application.</p>
</dd>
</dl>
<br>
<h3><a name="HDRFPDOL1">DOLS0100 Format</a></h3>
<p>Format DOLS0100 returns Windows server 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%">Displacement to next server
entry</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 server entry</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Network server description (NWSD) name</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Server status</td>
</tr>
<tr>
<td align="center" valign="top">17</td>
<td align="center" valign="top">11</td>
<td align="left" valign="top">CHAR(3)</td>
<td align="left" valign="top">Reserved</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">Displacement to server name</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">Length of server name</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">Displacement to domain name</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">Length of domain name</td>
</tr>
<tr>
<td align="center" valign="top">36</td>
<td align="center" valign="top">24</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Displacement to server description</td>
</tr>
<tr>
<td align="center" valign="top">40</td>
<td align="center" valign="top">28</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of server description</td>
</tr>
<tr>
<td align="center" valign="top">44</td>
<td align="center" valign="top">2C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Displacement to DNS domain name</td>
</tr>
<tr>
<td align="center" valign="top">48</td>
<td align="center" valign="top">30</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of DNS domain name</td>
</tr>
<tr>
<td align="center" valign="top">
52</td>
<td align="center" valign="top">34</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Hardware resource name</td>
</tr>
<tr>
<td align="center" valign="top">62</td>
<td align="center" valign="top">3E</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Hardware resource type</td>
</tr>
<tr>
<td align="center" valign="top">66</td>
<td align="center" valign="top">42</td>
<td align="left" valign="top">CHAR(3)</td>
<td align="left" valign="top">Hardware resource model</td>
</tr>
<tr>
<td align="center" valign="top">69</td>
<td align="center" valign="top">45</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">75</td>
<td align="center" valign="top">4B</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">
iSeries Integration service pack
</td>
</tr>
<tr>
<td align="center" valign="top">82</td>
<td align="center" valign="top">52</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">84</td>
<td align="center" valign="top">54</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">
Displacement to list of iSeries Integration hot fix entries
</td>
</tr>
<tr>
<td align="center" valign="top">88</td>
<td align="center" valign="top">58</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">92</td>
<td align="center" valign="top">5C</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="center" valign="top">96</td>
<td align="center" valign="top">60</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Windows version</td>
</tr>
<tr>
<td align="center" valign="top">106</td>
<td align="center" valign="top">6A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Windows build number</td>
</tr>
<tr>
<td align="center" valign="top">116</td>
<td align="center" valign="top">74</td>
<td align="left" valign="top">CHAR(128)</td>
<td align="left" valign="top">Windows service pack level
</td>
</tr>
<tr>
<td align="center" valign="top">See note</td>
<td align="center" valign="top">See note</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Server name</td>
</tr>
<tr>
<td align="center" valign="top">See note</td>
<td align="center" valign="top">See note</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Domain name</td>
</tr>
<tr>
<td align="center" valign="top">See note</td>
<td align="center" valign="top">See note</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Server description</td>
</tr>
<tr>
<td align="center" valign="top">See note</td>
<td align="center" valign="top">See note</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">DNS domain name</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>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> The
displacement to the server name, domain name, server description, and DNS domain
name and hot fix
are specified in the respective
displacement variables.</td>
</tr>
</table>
<br>
<br>
<img src="delta.gif" alt="Start of change">
<h3><a name="HDRFPDOL2">DOLS0200 Format</a></h3>
<p>Format DOLS0200 returns *WINDOWS, *LINUX, and *AIX Network Server 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%">Displacement to next server
entry</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 server entry</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Network server description (NWSD) name</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Server status</td>
</tr>
<tr>
<td align="center" valign="top">17</td>
<td align="center" valign="top">11</td>
<td align="left" valign="top">CHAR(3)</td>
<td align="left" valign="top">Reserved</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">Displacement to server name</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">Length of server name</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">Displacement to domain name</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">Length of domain name</td>
</tr>
<tr>
<td align="center" valign="top">36</td>
<td align="center" valign="top">24</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Displacement to server description</td>
</tr>
<tr>
<td align="center" valign="top">40</td>
<td align="center" valign="top">28</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of server description</td>
</tr>
<tr>
<td align="center" valign="top">44</td>
<td align="center" valign="top">2C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Displacement to DNS domain name</td>
</tr>
<tr>
<td align="center" valign="top">48</td>
<td align="center" valign="top">30</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of DNS domain name</td>
</tr>
<tr>
<td align="center" valign="top">52</td>
<td align="center" valign="top">34</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Displacement to server operating system description</td>
</tr>
<tr>
<td align="center" valign="top">56</td>
<td align="center" valign="top">38</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of server operating system description</td>
</tr>
<tr>
<td align="center" valign="top">60</td>
<td align="center" valign="top">3C</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Hardware name</td>
</tr>
<tr>
<td align="center" valign="top">70</td>
<td align="center" valign="top">46</td>
<td align="left" valign="top">CHAR(24)</td>
<td align="left" valign="top">Hardware type and model</td>
</tr>
<tr>
<td align="center" valign="top">94</td>
<td align="center" valign="top">5E</td>
<td align="left" valign="top">CHAR(12)</td>
<td align="left" valign="top">Hardware serial number</td>
</tr>
<tr>
<td align="center" valign="top">106</td>
<td align="center" valign="top">6A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Server operating system type</td>
</tr>
<tr>
<td align="center" valign="top">116</td>
<td align="center" valign="top">74</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">NWSD connection type</td>
</tr>
<tr>
<td align="center" valign="top">126</td>
<td align="center" valign="top">7E</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">NWSD operating system</td>
</tr>
<tr>
<td align="center" valign="top">136</td>
<td align="center" valign="top">88</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Operating system integration version</td>
</tr>
<tr>
<td align="center" valign="top">142</td>
<td align="center" valign="top">8E</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Operating system integration service level</td>
</tr>
<tr>
<td align="center" valign="top">149</td>
<td align="center" valign="top">95</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">159</td>
<td align="center" valign="top">9F</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">169</td>
<td align="center" valign="top">A9</td>
<td align="left" valign="top">CHAR(128)</td>
<td align="left" valign="top">Server operating system service level
</td>
</tr>
<tr>
<td align="center" valign="top">297</td>
<td align="center" valign="top">129</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Server enrollment enabled
</td>
</tr>
<tr>
<td align="center" valign="top">298</td>
<td align="center" valign="top">12A</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Domain enrollment enabled
</td>
</tr>
<tr>
<td align="center" valign="top">299</td>
<td align="center" valign="top">12B</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">SBMNWSCMD enabled
</td>
</tr>
<tr>
<td align="center" valign="top">300</td>
<td align="center" valign="top">12C</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Server statistics enabled
</td>
</tr>
<tr>
<td align="center" valign="top">301</td>
<td align="center" valign="top">12D</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Dynamic unlinking enabled
</td>
</tr>
<tr>
<td align="center" valign="top">302</td>
<td align="center" valign="top">12E</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Synchronize integration software enabled
</td>
</tr>
<tr>
<td align="center" valign="top">303</td>
<td align="center" valign="top">12F</td>
<td align="left" valign="top">CHAR(24)</td>
<td align="left" valign="top">Hardware type and model at install</td>
</tr>
<tr>
<td align="center" valign="top">See note</td>
<td align="center" valign="top">See note</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Server name</td>
</tr>
<tr>
<td align="center" valign="top">See note</td>
<td align="center" valign="top">See note</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Domain name</td>
</tr>
<tr>
<td align="center" valign="top">See note</td>
<td align="center" valign="top">See note</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Server description</td>
</tr>
<tr>
<td align="center" valign="top">See note</td>
<td align="center" valign="top">See note</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">DNS domain name</td>
</tr>
<tr>
<td align="center" valign="top">See note</td>
<td align="center" valign="top">See note</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Server operating system description</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> The
displacement to the server name, domain name, server description, DNS domain
name, and server operating system description are specified in the respective
displacement variables.</td>
</tr>
</table>
<img src="deltaend.gif" alt="End of change">
<br>
<br>
<h3><a name="HDRFPADOLD">Field Descriptions</a></h3>
<p><strong>Displacement to DNS domain name.</strong> The displacement in bytes
from the beginning of the record to the domain name of the Domain Name System
(DNS).</p>
<p><strong>Displacement to domain name.</strong> The displacement in bytes from
the beginning of the record to the domain name.</p>
<p><strong>Displacement to list
of iSeries Integration hot fix entries.</strong> The displacement to the first
entry in the iSeries Integration hot fix list.
</p>
<p><strong>Displacement to next server entry.</strong> The displacement in
bytes from the beginning of the record to the next server entry. If this is the
last entry, this value will be zero.</p>
<p><strong>Displacement to server description.</strong> The displacement in
bytes from the beginning of the record to the server description.</p>
<p><strong>Displacement to server name.</strong> The displacement in bytes from
the beginning of the record to the server name.</p>
<p><img src="delta.gif" alt="Start of change">
<strong>Displacement to server operating system description.</strong> The displacement in
bytes from the beginning of the record to the server operating system description.
<img src="deltaend.gif" alt="End of change"></p>
<p><strong>DNS domain name.</strong> The domain name system (DNS) domain name
of this server.</p>
<p><img src="delta.gif" alt="Start of change">
<strong>Domain enrollment enabled.</strong> Indicates if user profiles may be
enrolled to the Domain name.</p>
<table cellpadding="5">
<tr>
<td align="left" valign="top"><em>'0'</em></td>
<td align="left" valign="top">No, enrollment is not supported to this servers domain name.</td>
</tr>
<tr>
<td align="left" valign="top"><em>'1'</em></td>
<td align="left" valign="top">Yes, enrollment is supported to this servers domain name.</td>
</tr>
</table>
<img src="deltaend.gif" alt="End of change">
<p><strong>Domain name.</strong> The domain name of this server.</p>
<p><img src="delta.gif" alt="Start of change">
<strong>Dynamic unlinking enabled.</strong> Indicates if NWS Storage Space
dynamic unlinking operations are supported for this server.</p>
<table cellpadding="5">
<tr>
<td align="left" valign="top"><em>'0'</em></td>
<td align="left" valign="top">No, dynamic unlinking is not supported on this server.</td>
</tr>
<tr>
<td align="left" valign="top"><em>'1'</em></td>
<td align="left" valign="top">Yes, dynamic unlinking is support on this server.</td>
</tr>
</table>
<img src="deltaend.gif" alt="End of change">
<p><img src="delta.gif" alt="Start of change">
<strong>Hardware name.</strong>
The hardware resource name of the input/output
adapter (IOA), or the remote system NWSCFG name for iSCSI connected servers.
<img src="deltaend.gif" alt="End of change"></p>
<p><strong>Hardware resource model.</strong>
The hardware resource model of the input/output adapter (IOA) for the server.</p>
<p><strong>Hardware resource name.</strong> The hardware resource name of the
input/output adapter (IOA) for the server.</p>
<p><strong>Hardware resource type.</strong> The hardware resource type of the
input/output adapter (IOA) for the server.</p>
<p><img src="delta.gif" alt="Start of change">
<strong>Hardware serial number.</strong>
The serial number of the remote server hardware.
When not available the value will be *N.
<img src="deltaend.gif" alt="End of change"></p>
<p><img src="delta.gif" alt="Start of change">
<strong>Hardware type and model.</strong>
The remote server hardware type and model, or the hardware resource type
input/output adapter (IOA) for the server.
<strong>Hardware type and model at install.</strong>
The remote server hardware type and model, or the hardware resource type
input/output adapter (IOA) used when the server was originally installed.
When not available the value will be *N.
<img src="deltaend.gif" alt="End 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.
<img src="delta.gif" alt="Start of change">
When not available the value will be *N.
<img src="deltaend.gif" alt="End of change">
</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.
<img src="delta.gif" alt="Start of change">
When not available the value will be *N.
<img src="deltaend.gif" alt="End of change">
</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 DNS domain name.</strong> The length of this DNS domain
name.</p>
<p><strong>Length of domain name.</strong> The length of this domain name.</p>
<p><strong>Length of server description.</strong> The length of this server
description.</p>
<p><strong>Length of server entry.</strong> The length of this server
entry.</p>
<p><strong>Length of server name.</strong> The length of this server name.</p>
<p><img src="delta.gif" alt="Start of change">
<strong>Length of server operating system description.</strong> The length of this server
operating system description.
<img src="deltaend.gif" alt="End of change"></p>
<p><strong>Network server description (NWSD) name.</strong> The name of the
network server description.</p>
<p><strong>Number of iSeries
Integration hot fix entries.</strong> The number of times the iSeries
Integration hot fix entries are repeated.
<img src="delta.gif" alt="Start of change">
Hot fix entries are never used, so this field value will always be zero.
<img src="deltaend.gif" alt="End of change">
</p>
<p><img src="delta.gif" alt="Start of change">
<strong>NWSD connection type.</strong>
The NWSD Server connection value. The possible values are:</p>
<table cellpadding="5">
<tr>
<td align="left" valign="top"><em>*IXSVR</em></td>
<td align="left" valign="top">The NWSD uses an integrated network server connection.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*ISCSI</em></td>
<td align="left" valign="top">The NWSD uses an iSCSI connection.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*GUEST</em></td>
<td align="left" valign="top">The NWSD uses an operating system running in a logical partition.</td>
</tr>
</table>
<img src="deltaend.gif" alt="End of change">
<p><img src="delta.gif" alt="Start of change">
<strong>NWSD operating system.</strong>
The NWSD Server operating system value. The possible values are: </p>
<table cellpadding="5">
<tr>
<td align="left" valign="top"><em>*WIN32</em></td>
<td align="left" valign="top">The network server description is for a 32bit Windows operating system.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LINUX32</em></td>
<td align="left" valign="top">The network server description is for a 32bit Linux operating system.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LINUXPPC</em></td>
<td align="left" valign="top">The network server description is for a Linux Power PC operating system.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*AIXPPC</em></td>
<td align="left" valign="top">The network server description is for an AIX Power PC operating system.</td>
</tr>
</table>
<img src="deltaend.gif" alt="End of change">
<p><img src="delta.gif" alt="Start of change">
<strong>Operating system integration service level.</strong> The identifier for the
operating system integration service level that is installed on the server.
When not available the value will be *N.
<img src="deltaend.gif" alt="End of change">
</p>
<p><img src="delta.gif" alt="Start of change">
<strong>Operating system integration version.</strong> The version number of the
operating system 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.
When not available the value will be *N.
<img src="deltaend.gif" alt="End of change">
</p>
<p><strong>Reserved.</strong> Reserved space.</p>
<p><img src="delta.gif" alt="Start of change">
<strong>SBMNWSCMD enabled.</strong>
Indicates if the SBMNWSCMD CL command is supported to this server.</p>
<table cellpadding="5">
<tr>
<td align="left" valign="top"><em>'0'</em></td>
<td align="left" valign="top">No, SBMNWSCMD is not supported to this server.</td>
</tr>
<tr>
<td align="left" valign="top"><em>'1'</em></td>
<td align="left" valign="top">Yes, SBMNWSCMD is supported to this server.</td>
</tr>
</table>
<img src="deltaend.gif" alt="End of change">
<p><strong>Server description.</strong> The server description.</p>
<p><img src="delta.gif" alt="Start of change">
<strong>Server enrollment enabled.</strong> Indicates whether user profiles may be
enrolled to this server name.</p>
<table cellpadding="5">
<tr>
<td align="left" valign="top"><em>'0'</em></td>
<td align="left" valign="top">No, enrollment to the server name is not available.</td>
</tr>
<tr>
<td align="left" valign="top"><em>'1'</em></td>
<td align="left" valign="top">Yes, enrollment to the server name is available.</td>
</tr>
</table>
<img src="deltaend.gif" alt="End of change">
<p><strong>Server name.</strong> The name of this server. <img src="delta.gif" alt="Start of change"> The operating systems server name is retrieved for *IXSVR and *ISCSI connection types. The NWSD name is returned for *GUEST connection types.<img src="deltaend.gif" alt="End of change">
</p>
<img src="delta.gif" alt="Start of change">
<p><strong>Server operating system build ID.</strong> The current build identifier of the server
operating system.
When not available the value will be *N.
</p>
<p><strong>Server operating system description.</strong> A description of the operating
system on the server. The values is retreived from the remote server.
When not available, the value will be *N.</p>
<p><strong>Server operating system service level.</strong> The current service level
of the operating system on the server.
When not available the value will be *N.
</p>
<p><strong>Server operating system type.</strong>
The remote server operating system type. The possible values are:</p>
<table cellpadding="5">
<tr>
<td align="left" valign="top"><em>*WINDOWS</em></td>
<td align="left" valign="top">Windows operating system types.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LINUX</em></td>
<td align="left" valign="top">Linux operating system types.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*AIX</em></td>
<td align="left" valign="top">AIX operating system types.</td>
</tr>
</table>
<p><strong>Server operating system version.</strong> The current version of the
operating system on the server.
When not available the value will be *N.
</p>
<p><strong>Server statistics enabled.</strong> Indicates if server statistics are
supported for this server.</p>
<table cellpadding="5">
<tr>
<td align="left" valign="top"><em>'0'</em></td>
<td align="left" valign="top">No, server statistics are not supported.</td>
</tr>
<tr>
<td align="left" valign="top"><em>'1'</em></td>
<td align="left" valign="top">Yes, server statistics are supported.</td>
</tr>
</table>
<img src="deltaend.gif" alt="End of change">
<p><strong>Server status.</strong> The status of the server. The possible
values follow:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Active</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Inactive</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Restricted</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Pending</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">Unknown</td>
</tr>
<tr>
<td align="left" valign="top"><em>5</em></td>
<td align="left" valign="top">Ending</td>
</tr>
<tr>
<td align="left" valign="top"><em>6</em></td>
<td align="left" valign="top">Failed</td>
</tr>
<tr>
<td align="left" valign="top"><em>7</em></td>
<td align="left" valign="top">Partially shut down</td>
</tr>
<tr><td><img src="delta.gif" alt="Start of change"></td></tr>
<tr>
<td align="left" valign="top"><em>8</em></td>
<td align="left" valign="top">Degraded</td>
</tr>
<tr><td><img src="deltaend.gif" alt="End of change"></td></tr>
</table>
<p><img src="delta.gif" alt="Start of change">
<strong>Synchronize integration software enabled.</strong> Indicates if operating system
operations are supported to directly update integration software on this server.</p>
<table cellpadding="5">
<tr>
<td align="left" valign="top"><em>'0'</em></td>
<td align="left" valign="top">No, integration software synchronization is not supported.</td>
</tr>
<tr>
<td align="left" valign="top"><em>'1'</em></td>
<td align="left" valign="top">Yes, integration software synchronization is supported.</td>
</tr>
</table>
<img src="deltaend.gif" alt="End of change">
<p><strong>Windows build number.</strong> The current build number of the
Windows operating system on the server.</p>
<p><strong>Windows service pack level.</strong> The current service pack level
of the Windows operating system on the server.</p>
<p><strong>Windows version.</strong> The current version of the Windows
operating system on the server.</p>
<br>
<br>
<h3><a name="HDRODOLSI">Format of List Information</a></h3>
<p>The following table shows the format of the list information parameter. For
detailed descriptions of the field in the table, see <a href="#HDRFPADOLL">
Field Descriptions</a>.</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%">Total records</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">Records returned</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Request handle</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">Record length</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Information complete indicator</td>
</tr>
<tr>
<td align="center" valign="top">17</td>
<td align="center" valign="top">11</td>
<td align="left" valign="top">CHAR(13)</td>
<td align="left" valign="top">Date and time created</td>
</tr>
<tr>
<td align="center" valign="top">30</td>
<td align="center" valign="top">1E</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">List status indicator</td>
</tr>
<tr>
<td align="center" valign="top">31</td>
<td align="center" valign="top">1F</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Reserved</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">Length of information returned</td>
</tr>
<tr>
<td align="center" valign="top">36</td>
<td align="center" valign="top">24</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">First record in buffer</td>
</tr>
<tr>
<td align="center" valign="top">40</td>
<td align="center" valign="top">28</td>
<td align="left" valign="top">CHAR(40)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRFPADOLL">Field Descriptions</a></h3>
<p><strong>Date and time created.</strong> The date and time the list was
created. The 13 characters are:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Century, where 0 indicates years 19<em>xx</em>
and 1 indicates years 20<em>xx</em>.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2-7</em></td>
<td align="left" valign="top">The date, in YYMMDD (year, month, day)
format.</td>
</tr>
<tr>
<td align="left" valign="top"><em>8-13</em></td>
<td align="left" valign="top">The time of day, in HHMMSS (hours, minutes,
seconds) format.</td>
</tr>
</table>
<p><strong>First record in buffer.</strong> The number of the first record in
the receiver variable.</p>
<p><strong>Information complete indicator.</strong> Whether all information
requested has been supplied.</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>I</em></td>
<td align="left" valign="top">Incomplete information. An interruption caused
the list to contain incomplete information about a buffer or buffers.</td>
</tr>
<tr>
<td align="left" valign="top"><em>P</em></td>
<td align="left" valign="top">Partial and accurate information. Partial
information is returned when the maximum space was used and not all of the
buffers requested were read.</td>
</tr>
<tr>
<td align="left" valign="top"><em>C</em></td>
<td align="left" valign="top">Complete and accurate information. All the
buffers requested were read and returned.</td>
</tr>
</table>
<br>
<p><strong>Length of information returned.</strong> The size, in bytes, of the
information returned in the receiver variable.</p>
<p><strong>List status indicator.</strong> The status of the list building. The
indicators are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The list building is pending.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The list is in the process of being built.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">The list has been built completely.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">An error occurred while building the list. The
next call to QGYGTLE will cause the error to be signalled to the caller of
QGYGTLE.</td>
</tr>
</table>
<br>
<p><strong>Record length.</strong> The length of each record of information
returned. For variable length records, this value is set to 0. For variable
length records, you can obtain the length of individual records from the
records themselves.</p>
<p><strong>Records returned.</strong> The number of records returned in the
receiver variable. This is the smallest of the following values:</p>
<ul>
<li>The number of records that fit into the receiver variable.</li>
<li>The number of records in the list.</li>
<li>The number of records requested.</li>
</ul>
<p><strong>Request handle.</strong> The handle of the request that can be used
for subsequent requests of information from the list. The handle is valid until
the Close List (QGYCLST) API is called to close the list or until the job
ends.</p>
<p><strong>Note:</strong> This field should be treated as a hexadecimal field.
It should not be converted from one CCSID to another (for example, EBCDIC to
ASCII) because doing so could result in an unusable value.</p>
<p><strong>Reserved.</strong> Reserved field. Must be set to hexadecimal or
binary zero.</p>
<p><strong>Total records.</strong> The total number of records available in the
list.</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">CPF24B4 E</td>
<td width="85%" 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 &amp;1.</td>
</tr>
<tr>
<td valign="top">CPF2634 E</td>
<td valign="top">Not authorized to object &amp;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">CPF3C1D E</td>
<td valign="top">Length specified in parameter &amp;1 not valid.</td>
</tr>
<tr>
<td valign="top">CPF3C1E E</td>
<td valign="top">Required parameter &amp;1 omitted.</td>
</tr>
<tr>
<td valign="top">CPF3C1F E</td>
<td valign="top">Pointer is not on a 16 byte boundary.</td>
</tr>
<tr>
<td valign="top">CPF3C21 E</td>
<td valign="top">Format name &amp;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">CPF3CF2 E</td>
<td valign="top">Error(s) occurred during running of &amp;1 API.</td>
</tr>
<tr>
<td valign="top">CPF3C36 E</td>
<td valign="top">Number of parameters, &amp;1, entered for this API was not
valid.</td>
</tr>
<tr>
<td valign="top">CPF9806 E</td>
<td valign="top">Cannot perform function for object &amp;2 in library
&amp;3.</td>
</tr>
<tr>
<td valign="top">CPF9872 E</td>
<td valign="top">Program or service program &amp;1 in library &amp;2 ended.
Reason code &amp;3.</td>
</tr>
</table>
<p><strong>Note:</strong>
CPF2634 and CPF2625 messages are returned in the error code parameter, and are
not signaled.</p>
<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>
Reference in New Issue Copy Permalink