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

1313 lines
39 KiB
HTML
Raw Blame History

<!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 Configuration (QFPRRNWS) 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">Retrieve Network Server Configuration (QFPRRNWS) 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="60%">Receiver variable
</td><td align="left" valign="top" width="15%">OUTPUT
</td><td align="left" valign="top" width="15%">CHAR(*)
</td></tr><tr>
<td align="center" valign="top" width="10%">2
</td><td align="left" valign="top" width="60%">Length of receiver variable
</td><td align="left" valign="top" width="15%">INPUT
</td><td align="left" valign="top" width="15%">BINARY(4)
</td></tr><tr>
<td align="center" valign="top" width="10%">3
</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%">4
</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%">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>
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: NO<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The <strong>Retrieve Network Server Configuration (QFPRRNWS) API</strong>
retrieves information about a network server configuration.
</p>
<br>
<h3><a name="Header_3">Authorities and Locks</a></h3>
<dl>
<dt>Network Server Configuration Authority</dt>
<dd>*USE</dd>
<dt>NWS Configuration Authority Attributes</dt>
<dd>Security administrator (*SECADM) special authorities
are needed to retrieve password, CHAP secret or pre-shared key values.</dd>
</dl>
<br>
<h3><a name="Header_3">Required Parameter Group</a></h3>
<dl>
<dt><strong>Receiver variable</strong></dt>
<dd>OUTPUT; CHAR(*)
<p>The variable that is to receive the network server configuration information.</p>
</dd>
<dt><strong>Length of receiver variable</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the area that is referred to by the receiver variable
parameter. If the amount of information to be returned is greater than this
value, the information will be truncated to this length. The minimum length is 8 bytes.</p>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>
The format of the returned network server configuration information.
You must use this format:</p>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em><a href="#FPRC0100">FPRC0100</a></em></td>
<td align="left" valign="top">Basic network server configuration information</td>
</tr>
<tr>
<td align="left" valign="top"><em><a href="#FPRC0200">FPRC0200</a></em></td>
<td align="left" valign="top">Detailed information for configuration type *CNNSEC</td>
</tr>
<tr>
<td align="left" valign="top"><em><a href="#FPRC0300">FPRC0300</a></em></td>
<td align="left" valign="top">Detailed information for configuration type *RMTSYS</td>
</tr>
<tr>
<td align="left" valign="top"><em><a href="#FPRC0400">FPRC0400</a></em></td>
<td align="left" valign="top">Detailed information for configuration type *SRVPRC</td>
</tr>
</table>
<p>See <a href="#HDRNWSDFMT">Format of Network Server Configuration</a> for a
description of these formats.</p>
</dd>
<dt><strong>Network server configuration name</strong></dt>
<dd>INPUT; CHAR(10)
<p>The name of the network server configuration to be retrieved.</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="HDRNWSDFMT">Format of Network Server Configuration</a></h3>
<p>When the network server configuration type is unknown, specify FPRC0100 and the basic
information (including network server configuration type) will be returned. When the
network server configuration type is known, specify one of the other category-specific
formats.</p>
<p>For detailed descriptions of the fields returned in these formats, see
<a href="#HDRNWSDFLD">Field Descriptions</a>.</p>
<br>
<h3><a name="FPRC0100">FPRC0100 Format</a></h3>
<p>Use this format to find out the network server configuration type, plus some basic
information about the network server configuration. Then you may use the returned network
server configuration type to select one of the other (category-specific) formats to call
the API again for detailed information about the network server configuration.
</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">Offset to higher-level format</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="center" valign="top">C</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Date information retrieved</td>
</tr>
<tr>
<td align="center" valign="top">19</td>
<td align="center" valign="top">13</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Time information retrieved</td>
</tr>
<tr>
<td align="center" valign="top">25</td>
<td align="center" valign="top">19</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Network server configuration name</td>
</tr>
<tr>
<td align="center" valign="top">35</td>
<td align="center" valign="top">23</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Network server configuration library</td>
</tr>
<tr>
<td align="center" valign="top">45</td>
<td align="center" valign="top">2D</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Validation list name</td>
</tr>
<tr>
<td align="center" valign="top">55</td>
<td align="center" valign="top">37</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Validation list library</td>
</tr>
<tr>
<td align="center" valign="top">65</td>
<td align="center" valign="top">41</td>
<td align="left" valign="top">CHAR(50)</td>
<td align="left" valign="top">Text description</td>
</tr>
<tr>
<td align="center" valign="top">115</td>
<td align="center" valign="top">73</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">116</td>
<td align="center" valign="top">74</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Configuration type</td>
</tr>
</table>
<br><br>
<h3><a name="FPRC0200">FPRC0200 Format</a></h3>
<p>This format returns detailed information about a network server configuration of type *CNNSEC.</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%">*</td>
<td align="center" valign="top" width="10%">*</td>
<td align="left" valign="top" width="20%">&nbsp;</td>
<td align="left" valign="top" width="60%">Returns everything from format FPRC0100</td>
</tr>
<tr>
<td align="center" valign="top">0</td>
<td align="center" valign="top">0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to list of IP security rules</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">Number of IP security rules</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">Entry length of IP security rules</td>
</tr>
<tr>
<td align="left" valign="top" colspan="2" rowspan="2">These fields repeat for each security rule</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">IP security rule length</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(64)</td>
<td align="left" valign="top">IP security rule</td>
</tr>
</table>
<br><br>
<h3><a name="FPRC0300">FPRC0300 Format</a></h3>
<p>This format returns detailed information about a network server configuration of type *RMTSYS.</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%">*</td>
<td align="center" valign="top" width="10%">*</td>
<td align="left" valign="top" width="20%">&nbsp;</td>
<td align="left" valign="top" width="60%">Returns everything from format FPRC0100</td>
</tr>
<tr>
<td align="center" valign="top">0</td>
<td align="center" valign="top">0</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Service processor configuration name</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Service processor configuration library</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(12)</td>
<td align="left" valign="top">Remote system serial number</td>
</tr>
<tr>
<td align="center" valign="top">32</td>
<td align="center" valign="top">20</td>
<td align="left" valign="top">CHAR(24)</td>
<td align="left" valign="top">Remote system type and model</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">Delivery method</td>
</tr>
<tr>
<td align="center" valign="top">60</td>
<td align="center" valign="top">3C</td>
<td align="left" valign="top">CHAR(16)</td>
<td align="left" valign="top">CHAP name</td>
</tr>
<tr>
<td align="center" valign="top">76</td>
<td align="center" valign="top">4C</td>
<td align="left" valign="top">CHAR(24)</td>
<td align="left" valign="top">CHAP secret</td>
</tr>
<tr>
<td align="center" valign="top">100</td>
<td align="center" valign="top">64</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Boot device ID - bus</td>
</tr>
<tr>
<td align="center" valign="top">104</td>
<td align="center" valign="top">68</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Boot device ID - device</td>
</tr>
<tr>
<td align="center" valign="top">108</td>
<td align="center" valign="top">6C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Boot device ID - function</td>
</tr>
<tr>
<td align="center" valign="top">112</td>
<td align="center" valign="top">70</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Dynamic boot vendor ID</td>
</tr>
<tr>
<td align="center" valign="top">120</td>
<td align="center" valign="top">78</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Dynamic boot alternate client ID</td>
</tr>
<tr>
<td align="center" valign="top">128</td>
<td align="center" valign="top">80</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to list of remote interfaces</td>
</tr>
<tr>
<td align="center" valign="top">132</td>
<td align="center" valign="top">84</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of remote interfaces</td>
</tr>
<tr>
<td align="center" valign="top">136</td>
<td align="center" valign="top">88</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Entry length of remote interfaces</td>
</tr>
<tr>
<td align="left" valign="top" colspan="2" rowspan="22">These fields repeat for each remote interface</td>
<td align="left" valign="top">CHAR(12)</td>
<td align="left" valign="top">SCSI adapter address</td>
</tr>
<tr>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">SCSI internet address version</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(15)</td>
<td align="left" valign="top">SCSI internet address</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">CHAR(15)</td>
<td align="left" valign="top">SCSI subnet mask</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">CHAR(15)</td>
<td align="left" valign="top">SCSI gateway address</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">BINARY(4)</td>
<td align="left" valign="top">iSCSI qualified name length</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(255)</td>
<td align="left" valign="top">iSCSI qualified name</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">CHAR(12)</td>
<td align="left" valign="top">LAN adapter address</td>
</tr>
<tr>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">LAN internet address version</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(15)</td>
<td align="left" valign="top">LAN internet address</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">CHAR(15)</td>
<td align="left" valign="top">LAN subnet mask</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">CHAR(15)</td>
<td align="left" valign="top">LAN gateway address</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(20)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br><br>
<h3><a name="FPRC0400">FPRC0400 Format</a></h3>
<p>This format returns detailed information about a network server configuration of type *SRVPRC.</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%">*</td>
<td align="center" valign="top" width="10%">*</td>
<td align="left" valign="top" width="20%">&nbsp;</td>
<td align="left" valign="top" width="60%">Returns everything from format FPRC0100</td>
</tr>
<tr>
<td align="center" valign="top">0</td>
<td align="center" valign="top">0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Initialize service processor</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">Enable unicast</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">Service processor name length</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="center" valign="top">C</td>
<td align="left" valign="top">CHAR(255)</td>
<td align="left" valign="top">Service processor name</td>
</tr>
<tr>
<td align="center" valign="top">267</td>
<td align="center" valign="top">10B</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">268</td>
<td align="center" valign="top">10C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Service processor address version</td>
</tr>
<tr>
<td align="center" valign="top">272</td>
<td align="center" valign="top">110</td>
<td align="left" valign="top">CHAR(15)</td>
<td align="left" valign="top">Service processor internet address</td>
</tr>
<tr>
<td align="center" valign="top">287</td>
<td align="center" valign="top">11F</td>
<td align="left" valign="top">CHAR(15)</td>
<td align="left" valign="top">Service processor user name</td>
</tr>
<tr>
<td align="center" valign="top">302</td>
<td align="center" valign="top">12E</td>
<td align="left" valign="top">CHAR(15)</td>
<td align="left" valign="top">Service processor password</td>
</tr>
<tr>
<td align="center" valign="top">317</td>
<td align="center" valign="top">13D</td>
<td align="left" valign="top">CHAR(3)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">320</td>
<td align="center" valign="top">140</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">SP certificate identifier component</td>
</tr>
<tr>
<td align="center" valign="top">324</td>
<td align="center" valign="top">144</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">SP certificate identifier compare length</td>
</tr>
<tr>
<td align="center" valign="top">328</td>
<td align="center" valign="top">148</td>
<td align="left" valign="top">CHAR(255)</td>
<td align="left" valign="top">SP certificate identifier compare value</td>
</tr>
<tr>
<td align="center" valign="top">583</td>
<td align="center" valign="top">247</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">584</td>
<td align="center" valign="top">248</td>
<td align="left" valign="top">CHAR(12)</td>
<td align="left" valign="top">Enclosure serial number</td>
</tr>
<tr>
<td align="center" valign="top">596</td>
<td align="center" valign="top">254</td>
<td align="left" valign="top">CHAR(24)</td>
<td align="left" valign="top">Enclosure type and model</td>
</tr>
</table>
<br><br>
<h3><a name="HDRNWSDFLD">Field Descriptions</a></h3>
The field descriptions are always in alphabetical order.
<p>
Some of the fields in the various formats returned by this API are described
in greater detail in the Control Language (CL) information for the
<a href= "../cl/crtnwscfg.htm">CRTNWSCFG</a> command that was used to create the network
server configuration object. They also are described in the online help for the
CRTNWSCFG command. For these fields, the CL parameter keyword is specified in
parentheses following the field name. The CL command name is specified in the
field description.</p>
<p>In certain cases, numeric values are assigned by this API to represent
character values for some of the returned fields. Where a numeric value is
assigned, the numeric value and the equivalent character value are listed as an
<em>Exception</em> in the following field descriptions.</p>
<p><strong>Boot device ID - bus.</strong>
The PCI device ID - bus number
for the remote system's iSCSI adapter that has been configured to boot.</p>
<p><em>Exception:</em></p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The single PCI device ID is used.</td>
</tr>
</table>
<p><strong>Boot device ID - device.</strong>
The PCI device ID - device number
for the remote system's iSCSI adapter that has been configured to boot.</p>
<p><em>Exception:</em></p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The single PCI device ID is used.</td>
</tr>
</table>
<p><strong>Boot device ID - function.</strong>
The PCI device ID - function number
for the remote system's iSCSI adapter that has been configured to boot.</p>
<p><em>Exception:</em></p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The single PCI device ID is used.</td>
</tr>
</table>
<p><strong>Bytes available.</strong>
The number of bytes of data available to be returned to the user.</p>
<p><strong>Bytes returned.</strong>
The number of bytes that were returned to the user.
This is the lesser of the number of bytes available to be returned or
the length of the receiver variable.</p>
<p><strong>CHAP name.</strong>
Specifies the Challenge Handshake Authentication Protocol (CHAP) name for the iSeries iSCSI target to authenticate the remote system's initiator node.</p>
<p><em>Exception:</em></p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">CHAP authentication is not enabled.</td>
</tr>
</table>
<p><strong>CHAP secret.</strong>
Specifies the Challenge Handshake Authentication Protocol (CHAP) secret for the iSeries iSCSI target to authenticate the remote system's initiator node.</p>
<p><em>Exception:</em></p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*NOTAVL</em></td>
<td align="left" valign="top">The CHAP secret is unavailable to the caller of the API.
The caller of the API must have *SECADM special authorities to retrieve this value.
</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">CHAP authentication is not enabled.</td>
</tr>
</table>
<p><strong>Configuration type (TYPE).</strong>
The type of the network server configuration.
</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Connection security </td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Remote system </td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Service processor </td>
</tr>
</table>
<p><strong>Date information retrieved.</strong>
The date that the information was provided by the API.
It is returned as 7 characters in the form CYYMMDD, as follows:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>C</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>YY</em></td>
<td align="left" valign="top">Year</td>
</tr>
<tr>
<td align="left" valign="top"><em>MM</em></td>
<td align="left" valign="top">Month</td>
</tr>
<tr>
<td align="left" valign="top"><em>DD</em></td>
<td align="left" valign="top">Day</td>
</tr>
</table>
<p><strong>Delivery method (DELIVERY).</strong>
The delivery method used to deploy security parameters.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Dynamic </td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Manual </td>
</tr>
</table>
<p><strong>Dynamic boot alternate client ID.</strong>
Alternate client ID of the remote system's iSCSI adapter.</p>
<p><em>Exception:</em></p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ADPT</em></td>
<td align="left" valign="top">The remote system's iSCSI adapter address is used the for the alternate client ID.</td>
</tr>
</table>
<p><strong>Dynamic boot vendor ID.</strong>
Vendor ID of the remote system's iSCSI adapter.</p>
<p><em>Exception:</em></p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*DFT</em></td>
<td align="left" valign="top">The default vendor ID will be used.</td>
</tr>
</table>
<p><strong>Enable unicast (ENBUCAST).</strong>
Enable unicast to discover the remote system.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">No </td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Yes </td>
</tr>
</table>
<p><strong>Enclosure serial number.</strong>
The enclosure's machine serial number.</p>
<p><em>Exception:</em></p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*AUTO</em></td>
<td align="left" valign="top">The enclosure's machine serial number
will be automatically determined once the system has been successfully contacted.
</td>
</tr>
</table>
<p><strong>Enclosure type and model.</strong>
The enclosure's manufacturer type and model number.</p>
<p><em>Exception:</em></p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*AUTO</em></td>
<td align="left" valign="top">The enclosure's machine serial number
will be automatically determined once the system has been successfully contacted.
</td>
</tr>
</table>
<p><strong>Entry length of IP security rule.</strong>
The entry length in bytes of each element in the list of security rules that are returned with this format.
A value of zero is returned if the list is empty.</p>
<p><strong>Entry length of remote interfaces.</strong>
The entry length in bytes of each element in the list of remote interfaces that are returned with this format.
A value of zero is returned if the list is empty.</p>
<p><strong>Initialize service processor (INZSP).</strong>
The method used to secure the remote system's service processor.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">None </td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Auto </td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Manual </td>
</tr>
</table>
<p><strong>IP security rule.</strong>
The shared secret key used as the Internet Key Exchange (IKE) authentication protocol for the connection.</p>
<p><em>Exception:</em></p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*NOTAVL</em></td>
<td align="left" valign="top">The IP security rule is unavailable to the caller of the API.
The caller of the API must have *SECADM special authorities to retrieve this value.
</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">IP Security (IPSec) protocol security settings are not configured.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*REGEN</em></td>
<td align="left" valign="top">A random pre-shared key is automatically generated every time the system is varied on.</td>
</tr>
</table>
<p><strong>IP security rule length.</strong>
Length in bytes of IP security rule.</p>
<p><strong>iSCSI qualified name.</strong>
The iSCSI qualified name associated with the remote system's SCSI interface.</p>
<p><em>Exception:</em></p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*GEN</em></td>
<td align="left" valign="top">The iSCSI qualified name associated with the remote system's SCSI interface will be generated once the remote systems serial number has been determined.</td>
</tr>
</table>
<p><strong>iSCSI qualified name length.</strong>
The length in bytes of the iSCSI qualified name.</p>
<p><strong>LAN adapter address.</strong>
The address used by the remote system's LAN interface.
This field will be blank if a value has not been specified.</p>
<p><strong>LAN gateway address.</strong>
The IPv4 gateway address of the remote system's LAN interface.
This field will be blank if a value has not been specified.</p>
<p><strong>LAN internet address.</strong>
The IPv4 address of the remote system's LAN interface.
This field will be blank if a value has not been specified.
An IPv4 address is expressed in standard dotted-decimal form www.xxx.yyy.zzz (for example, 130.99.128.1).</p>
<p><strong>LAN internet address version.</strong>
The version of the Internet Protocol (IP) that is currently in use with the remote system's LAN interface.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Not specified</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Internet Protocol version 4 (IPv4)</td>
</tr>
</table>
<p><strong>LAN subnet mask.</strong>
The IPv4 subnet mask of the remote system's LAN interface.
This field will be blank if a value has not been specified.</p>
<p><strong>Network server configuration library.</strong>
The library of the network server configuration.</p>
<p><strong>Network server configuration name.</strong>
The name of the network server configuration.</p>
<p><strong>Number of IP security rules.</strong>
The number of entries in the list of security rules returned with this format.
A value of zero is returned if the list is empty.</p>
<p><strong>Number of remote interfaces.</strong>
The number of entries in the list of remote interfaces returned with this format.
A value of zero is returned if the list is empty.</p>
<p><strong>Offset to higher-level format.</strong>
The offset in bytes to the network server configuration information.</p>
<p><strong>Offset to list of IP security rules.</strong>
The offset in bytes to the first element in the list of security rules that are
returned with this format. A value of zero is returned if the list is empty.</p>
<p><strong>Offset to list of remote interfaces.</strong>
The offset in bytes to the first element in the list of remote interfaces that are
returned with this format. A value of zero is returned if the list is empty.</p>
<p><strong>Remote system serial number.</strong>
The remote system's machine serial number.</p>
<p><em>Exception:</em></p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SPNWSCFG</em></td>
<td align="left" valign="top">The remote system's machine serial number
will use the service processor's managing system machine serial number.
</td>
</tr>
</table>
<p><strong>Remote system type and model.</strong>
The remote system's manufacturer type and model number.</p>
<p><em>Exception:</em></p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SPNWSCFG</em></td>
<td align="left" valign="top">The remote system's machine serial number
will use the service processor's managing system manufacturer type and model number.
</td>
</tr>
</table>
<p><strong>Reserved.</strong>
This is an ignored field.</p>
<p><strong>SCSI adapter address.</strong>
The address used by the remote system's SCSI interface.
This field will be blank if a value has not been specified.</p>
<p><strong>SCSI gateway address.</strong>
The IPv4 gateway address of the remote system's SCSI interface.
This field will be blank if a value has not been specified.</p>
<p><strong>SCSI internet address.</strong>
The IPv4 address of the remote system's SCSI interface.
An IPv4 address is expressed in standard dotted-decimal form www.xxx.yyy.zzz (for example, 130.99.128.1).
This field will be blank if a value has not been specified.</p>
<p><strong>SCSI internet address version.</strong>
The version of the Internet Protocol (IP) that is currently in use with the remote system's SCSI interface.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Not specified</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Internet Protocol version 4 (IPv4)</td>
</tr>
</table>
<p><strong>SCSI subnet mask.</strong>
The IPv4 subnet mask of the remote system's SCSI interface.
This field will be blank if a value has not been specified.</p>
<p><strong>Service processor address version.</strong>
The version of the Internet Protocol (IP) that is currently in use with the Remote SP Internet address.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Not specified</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Internet Protocol version 4 (IPv4)</td>
</tr>
</table>
<p><strong>Service processor configuration library.</strong>
The library of the service processor network server configuration.</p>
<p><strong>Service processor configuration name.</strong>
The name of the service processor network server configuration.</p>
<p><strong>Service processor internet address.</strong>
The IPv4 address of the remote service processor.
This field will be blank if a value has not been specified.
An IPv4 address is expressed in standard dotted-decimal form www.xxx.yyy.zzz (for example, 130.99.128.1).</p>
<p><strong>Service processor name (SPNAME).</strong>
Specifies the remote system's service processor host name.
The following special value also may be returned:</p>
<p><em>Exception:</em></p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SPINETADR</em></td>
<td align="left" valign="top">The remote system is identified by the value specified for
Service processor address.</td>
</tr>
</table>
<p><strong>Service processor name length.</strong>
Length in bytes of the remote system's service processor host name.</p>
<p><strong>Service processor password.</strong>
Specifies the remote system's service processor password.</p>
<p><em>Exception:</em></p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*NOTAVL</em></td>
<td align="left" valign="top">The service processor password is unavailable to the caller of the API.
The caller of the API must have *SECADM special authorities to retrieve this value.
</td>
</tr>
</table>
<p><strong>Service processor user name.</strong>
Specifies the remote system's service processor user name.</p>
<p><strong>SP certificate identifier compare length.</strong>
Specifies the length of the SP certificate compare value.</p>
<p><strong>SP certificate identifier compare value.</strong>
Specifies the certificates component compare value.</p>
<p><strong>SP certificate identifier component.</strong>
Specifies the component of the service processor's certificate that will be used to correlate the
certificate to this Network Server Configuration for a manually initialized service processor as follows:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Service processor certificate is not configured </td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Common name </td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">E-mail address </td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Organizational unit </td>
</tr>
</table>
<p><strong>Text description (TEXT).</strong>
A brief description of the network server configuration.</p>
<p><strong>Time information retrieved.</strong>
The time that the information was provided by the API.
It is returned as 6 characters in the form HHMMSS where:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>HH</em></td>
<td align="left" valign="top">Hour</td>
</tr>
<tr>
<td align="left" valign="top"><em>MM</em></td>
<td align="left" valign="top">Minute</td>
</tr>
<tr>
<td align="left" valign="top"><em>SS</em></td>
<td align="left" valign="top">Second</td>
</tr>
</table>
<p><strong>Validation list library.</strong>
Specifies the library of the validation list that is used to store authentication information.</p>
<p><strong>Validation list name.</strong>
Specifies the name of the validation list that is used to store authentication information.
Authentication information associated with the network server configuration is used to
securely interact with the remote system.</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 &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">CPF96CB E</td>
<td valign="top">Network server configuration &amp;1 not found.</td>
</tr>
<tr>
<td valign="top">CPFA31E E</td>
<td valign="top">Required parameter &amp;1 omitted.</td>
</tr>
<tr>
<td valign="top">CPFB752 E</td>
<td valign="top">Internal error in &amp;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>
Reference in New Issue View Git Blame Copy Permalink