391 lines
12 KiB
HTML
391 lines
12 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>List Network Server Configuration (QFPRLNWS) 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. -->
|
|
<!-- Created for V5R4 on 040629 -->
|
|
<!-- Change history: -->
|
|
<!-- 040629 ROCH: New API D99890.x -->
|
|
<!-- 040813 ROCH: SP support D93227 -->
|
|
<!-- 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><img src="delta.gif" alt="Start of change">List Network Server Configuration (QFPRLNWS) API</h2>
|
|
|
|
<div class="box" style="width: 80%;">
|
|
<br>
|
|
Required Parameter Group:<br>
|
|
<br>
|
|
<table width="100%">
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">1</td>
|
|
<td align="left" valign="top" width="60%">Qualified user space name</td>
|
|
<td align="left" valign="top" width="15%">Input</td>
|
|
<td align="left" valign="top" width="15%">Char(20)</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">2</td>
|
|
<td align="left" valign="top" width="60%">Format name</td>
|
|
<td align="left" valign="top" width="15%">Input</td>
|
|
<td align="left" valign="top" width="15%">Char(8)</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">3</td>
|
|
<td align="left" valign="top" width="60%">Network server configuration name</td>
|
|
<td align="left" valign="top" width="15%">Input</td>
|
|
<td align="left" valign="top" width="15%">Char(10)</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">4</td>
|
|
<td align="left" valign="top" width="60%">Configuration type</td>
|
|
<td align="left" valign="top" width="15%">Input</td>
|
|
<td align="left" valign="top" width="15%">Char(10)</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">5</td>
|
|
<td align="left" valign="top" width="60%">Error Code</td>
|
|
<td align="left" valign="top" width="15%">I/O</td>
|
|
<td align="left" valign="top" width="15%">Char(*)</td>
|
|
</tr>
|
|
</table>
|
|
Default Public Authority: *USE<br>
|
|
<br>
|
|
Threadsafe: NO<br>
|
|
<br>
|
|
</div>
|
|
|
|
<p>The <strong>List Network Server Configuration (QFPRLNWS) API</strong>
|
|
returns a list of network server configurations.</p>
|
|
<br>
|
|
<h3><a name="Header_3">Authorities and Locks</a></h3>
|
|
<dl>
|
|
<dt><strong>User space</strong></dt>
|
|
<dd>*CHANGE</dd>
|
|
<dt><strong>User space library</strong></dt>
|
|
<dd>*EXECUTE</dd>
|
|
<dt><strong>User space lock</strong></dt>
|
|
<dd>*EXCLRD</dd>
|
|
</dl>
|
|
<br>
|
|
<h3><a name="Header_3">Required Parameter Group</a></h3>
|
|
<dl>
|
|
<dt><strong>Qualified user space name</strong></dt>
|
|
<dd>INPUT; CHAR(20)
|
|
<p>
|
|
The user space that receives the generated list, and the library in which it is located.
|
|
The first 10 characters contain the user space name, and the second
|
|
10 characters contain the user space library.</p>
|
|
<p>You can use these special values for the library name:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*CURLIB</em></td>
|
|
<td align="left" valign="top">The job's current library</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*LIBL</em></td>
|
|
<td align="left" valign="top">The library list</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Format name</strong></dt>
|
|
<dd>INPUT; CHAR(8)
|
|
<p>
|
|
The format of the returned network server configuration information.
|
|
Supported format names are:</p>
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em><a href="#FPRL0100">FPRL0100</a></em></td>
|
|
<td align="left" valign="top">Returns information about a specific network server configuration
|
|
or all network server configuration.</td>
|
|
</tr>
|
|
</table>
|
|
</dd>
|
|
<dt><strong>Network server configuration name</strong></dt>
|
|
<dd>INPUT; CHAR(10)
|
|
<p>The name of the network server configuration for which information is retrieved.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>Object name</em></td>
|
|
<td align="left" valign="top">Object of this name only, of the specified configuration type</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Generic object name</em></td>
|
|
<td align="left" valign="top">All objects that have names matching the generic
|
|
string, of the specified configuration type</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">All objects of the specified configuration type</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</dd>
|
|
|
|
<dt><strong>Configuration type</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p>Type of configuration to list.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">All objects of the specified configuration description type</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="left" valign="top"><em>*CNNSEC</em></td>
|
|
<td align="left" valign="top">Connection security network server configurations only</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="left" valign="top"><em>*RMTSYS</em></td>
|
|
<td align="left" valign="top">Remote system network server configurations only</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="left" valign="top"><em>*SRVPRC</em></td>
|
|
<td align="left" valign="top">Service processor network server configurations only</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</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="Header_5">Format of the Generated List</a></h3>
|
|
The list consists of:
|
|
<ul>
|
|
<li>A user area<br><br></li>
|
|
|
|
<li>A generic header<br><br></li>
|
|
|
|
<li>An input parameter section<br><br></li>
|
|
|
|
<li>A list data section
|
|
|
|
<ul>
|
|
<li><a href="#FPRL0100">FPRL0100 format</a><br><br></li>
|
|
</ul>
|
|
|
|
</ul>
|
|
|
|
<p>For details about the user area and generic header, see <a href="../apiref/usf.htm">
|
|
User Space Format for List APIs</a>.
|
|
The remaining items are described in the following sections.
|
|
For detailed descriptions of the fields in the tables,
|
|
see <a href="#field_descriptions">Field Descriptions</a>.</p>
|
|
|
|
<br>
|
|
<h3><a name="Header_6">Input Parameter Section</a></h3>
|
|
The following information is returned in the input parameter section.
|
|
For detailed descriptions of the fields in this table,
|
|
see <a href="#Header_8">Field Descriptions</a>.
|
|
<p></p>
|
|
|
|
<table border width="70%">
|
|
<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="9%">0</td>
|
|
<td align="center" valign="top" width="9%">0</td>
|
|
<td align="left" valign="top" width="16%">Char(10)</td>
|
|
<td align="left" valign="top" width="66%">User space name specified</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center" valign="top" width="9%">10</td>
|
|
<td align="center" valign="top" width="9%">A</td>
|
|
<td align="left" valign="top" width="16%">Char(10)</td>
|
|
<td align="left" valign="top" width="66%">User space library specified</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center" valign="top" width="9%">20</td>
|
|
<td align="center" valign="top" width="9%">14</td>
|
|
<td align="left" valign="top" width="16%">Char(8)</td>
|
|
<td align="left" valign="top" width="66%">Format name specified</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center" valign="top" width="9%">28</td>
|
|
<td align="center" valign="top" width="9%">1C</td>
|
|
<td align="left" valign="top" width="16%">Char(10)</td>
|
|
<td align="left" valign="top" width="66%">Network server configuration name specified</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center" valign="top" width="9%">38</td>
|
|
<td align="center" valign="top" width="9%">26</td>
|
|
<td align="left" valign="top" width="16%">Char(10)</td>
|
|
<td align="left" valign="top" width="66%">Configuration type specified</td>
|
|
</tr>
|
|
</table>
|
|
<br><br>
|
|
<h3><a name="FPRL0100">FPRL0100 Format</a></h3>
|
|
<p>The following table shows the information returned in the
|
|
list data section of the user space for the FPRL0100 format.
|
|
The offsets listed are from the beginning of the user space.
|
|
For a detailed description of each field,
|
|
see <a href="#Header_8">Field Descriptions</a>.</p>
|
|
|
|
<table border width="70%">
|
|
<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="9%">0</td>
|
|
<td align="center" valign="top" width="9%">0</td>
|
|
<td align="left" valign="top" width="16%">Char(10)</td>
|
|
<td align="left" valign="top" width="66%">Network server configuration name</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center" valign="top" width="9%">10</td>
|
|
<td align="center" valign="top" width="9%">A</td>
|
|
<td align="left" valign="top" width="16%">Char(10)</td>
|
|
<td align="left" valign="top" width="66%">Configuration type</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center" valign="top" width="9%">20</td>
|
|
<td align="center" valign="top" width="9%">14</td>
|
|
<td align="left" valign="top" width="16%">Char(50)</td>
|
|
<td align="left" valign="top" width="66%">Text description</td>
|
|
</tr>
|
|
</table>
|
|
<br><br>
|
|
<h3><a name="Header_8">Field Descriptions</a></h3>
|
|
|
|
The field descriptions are always in alphabetical order.
|
|
|
|
<P><strong>Configuration type specified.</strong>
|
|
The configuration type, as specified on the call to the API.</p>
|
|
|
|
<ul>
|
|
<li>*ALL</li>
|
|
<li>*CNNSEC</li>
|
|
<li>*RMTSYS</li>
|
|
<li>*SRVPRC</li>
|
|
</ul>
|
|
|
|
<P><strong>Configuration type.</strong>
|
|
The configuration type.</p>
|
|
|
|
<ul>
|
|
<li>*CNNSEC</li>
|
|
<li>*RMTSYS</li>
|
|
<li>*SRVPRC</li>
|
|
</ul>
|
|
|
|
<P><strong>Format name specified.</strong>
|
|
The format name as specified on the call to the API.</p>
|
|
|
|
<p><strong>Network server configuration name specified.</strong>
|
|
The name of the network server configuration, as specified in the call to the API.</p>
|
|
|
|
<p><strong>Network server configuration name.</strong>
|
|
The name of the network server configuration.</p>
|
|
|
|
<p><strong>Text description.</strong>
|
|
A brief description of the network server configuration.</p>
|
|
|
|
<p><strong>User space library specified.</strong>
|
|
The name of the user space library as specified on the call to the API.</p>
|
|
|
|
<p><strong>User space name specified.</strong>
|
|
The name of the user space as specified on the call to the API.</p>
|
|
<br>
|
|
<h3><a name="header_9">Error Messages</a></h3>
|
|
|
|
<table width="100%" cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<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">CPF3C21 E</td>
|
|
<td valign="top">Format name &1 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 &1 API.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPFA31E E</td>
|
|
<td valign="top">Required parameter &1 omitted.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPFB752 E</td>
|
|
<td valign="top">Internal error in &2 API.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<hr>
|
|
API introduced: V5R4
|
|
|
|
<hr>
|
|
<img src="deltaend.gif" alt="End of change"><br>
|
|
<center>
|
|
<table cellpadding="2" cellspacing="2">
|
|
<tr align="center">
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
|
"config.htm">Configuration APIs</a> | <a href="aplist.htm">APIs by category</a></td>
|
|
</tr>
|
|
</table>
|
|
</center>
|
|
</body>
|
|
</html>
|
|
|