ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/qzlschsi.htm

628 lines
18 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>Change Server Information (QZLSCHSI) 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. -->
<!-- QZLSCHSI SCRIPT A converted by B2H R4.1 (346) (CMS) by KENTALA -->
<!-- at RCHVMW2 on 7 Oct 1998 at 21:33:08 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- 040902 EMIG New V5R4 config options -->
<!--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>Change Server Information (QZLSCHSI) API</h2>
<div class="box" style="width: 70%;">
<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%">Request variable</td>
<td align="left" valign="top" width="20%">Input</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 request variable</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Format</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(8)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">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 Change Server Information (QZLSCHSI) API changes general configuration
information for the iSeries Support for Windows Network Neighborhood <img src="delta.gif" alt="Start of change">(iSeries
NetServer)<img src="deltaend.gif" alt="End of change"> server. Changes made with this API using format ZLSS0200 take
effect immediately. All other changes made with this API using format ZLSS0100
do not take effect until the server is restarted.</p>
<br>
<h3>Authorities and Locks</h3>
<p>To use this API, you must have *IOSYSCFG special authority. To use format
ZLSS0200 to enable an iSeries NetServer user, you must have *SECADM special
authority and *OBJMGT and *USE authority to the system user profile.</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Request variable</strong></dt>
<dd>INPUT; CHAR(*)
<p>A variable that is used to pass values for the information to be
changed.</p>
<p>For more information, see <a href="#HDRZLSCIF">Format of Information
Changed</a>.</p>
</dd>
<dt><strong>Length of request variable</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the variable that is used to pass information to be changed.
For Format ZLSS0100, if this length is less than the total length of the
format, the fields not completely included by the length use their default
values. For Format ZLSS0200, if this length does not include all of the user
names to be enabled, only the user names completely included by the length are
enabled.</p>
</dd>
<dt><strong>Format</strong></dt>
<dd>INPUT; CHAR(8)
<p>The content and format of the information to be changed by the simplified
server. The following format names must be used:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>ZLSS0100</em></td>
<td align="left" valign="top">Server information</td>
</tr>
<tr>
<td align="left" valign="top"><em>ZLSS0200</em></td>
<td align="left" valign="top">Enable user information</td>
</tr>
</table>
<p>For more information, see <a href="#HDRZLSCIF">Format of Information
Changed</a>.</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="HDRZLSCIF">Format of Information Changed</a></h3>
<p>The following table shows how the content of the request variable is
organized. For descriptions of each field, see <a href="#HDRZLSCID">Field
Descriptions</a>.</p>
<h3><a name="HDRZLSCI10">Format ZLSS0100</a></h3>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="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%">CCSID</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">Idle time-out</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">Opportunistic lock time-out</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">Browsing interval</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">CHAR(15)</td>
<td align="left" valign="top">WINS primary address</td>
</tr>
<tr>
<td align="center" valign="top">31</td>
<td align="center" valign="top">1F</td>
<td align="left" valign="top">CHAR(15)</td>
<td align="left" valign="top">WINS secondary address</td>
</tr>
<tr>
<td align="center" valign="top">46</td>
<td align="center" valign="top">2E</td>
<td align="left" valign="top">CHAR(224)</td>
<td align="left" valign="top">Scope ID</td>
</tr>
<tr>
<td align="center" valign="top">270</td>
<td align="center" valign="top">10E</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">WINS proxy</td>
</tr>
<tr>
<td align="center" valign="top">271</td>
<td align="center" valign="top">10F</td>
<td align="left" valign="top">CHAR(5)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">276</td>
<td align="center" valign="top">114</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Server role</td>
</tr>
<tr>
<td align="center" valign="top">280</td>
<td align="center" valign="top">118</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Authentication method</td>
</tr>
<tr>
<td align="center" valign="top"><img src="delta.gif" alt="Start of change">281</td>
<td align="center" valign="top">119</td>
<td align="left" valign="top">CHAR(3)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">284</td>
<td align="center" valign="top">11C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Message authentication</td>
</tr>
<tr>
<td align="center" valign="top">288</td>
<td align="center" valign="top">120</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Minimum message severity</td>
</tr>
<tr>
<td align="center" valign="top">292</td>
<td align="center" valign="top">124</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">LAN Manager authentication<img src="deltaend.gif" alt="End of change"></td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRZLSCI20">Format ZLSS0200</a></h3>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="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%">Number of iSeries NetServer users to
enable</td>
</tr>
<tr>
<td align="left" valign="top" rowspan="1" colspan="2">This field repeats for
each user.</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">iSeries NetServer user name</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRZLSCID">Field Descriptions</a></h3>
<p><strong>Authentication
method.</strong> The authentication method used to authenticate users. Valid
values are:</p>
<br>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em>character 0 (X'F0')</em></td>
<td align="left" valign="top">The server authenticates with encrypted
passwords only.</td>
</tr>
<tr>
<td align="left" valign="top"><em>character 1 (X'F1')</em></td>
<td align="left" valign="top">The server authenticates with
<img src="delta.gif" alt="Start of change">network authentication
<img src="deltaend.gif" alt="End of change"> only.</td>
</tr>
<tr>
<td align="left" valign="top"><em>character 2 (X'F2')</em></td>
<td align="left" valign="top">The server authenticates with <img src="delta.gif" alt="Start of change">
network authentication<img src="deltaend.gif" alt="End of change">
when possible, but it allows clients to use encrypted passwords when needed.
</td>
</tr>
</table>
<p>The default value for this field is character 0.</p>
<p><strong>Note:</strong> Authentication method should only be set to character
1 in networks containing only Windows 2000 and newer iSeries NetServer
clients that are configured to participate in a <img src="delta.gif" alt="Start of change">
network authentication<img src="deltaend.gif" alt="End of change"> realm. All other
Windows clients will be unable to connect to iSeries NetServer when <img src="delta.gif" alt="Start of change">
network authentication<img src="deltaend.gif" alt="End of change"> only support is enabled.</p>
<br>
<p><strong>Browsing interval.</strong> The amount of time, in seconds, between
each server announcement that is used for browsing. The maximum allowable value
is 720000 milliseconds (or twelve minutes). The minimum allowable value is
zero, which means there will be no server announcements.</p>
<p>The default value for this field is 720000 milliseconds.</p>
<p><strong>CCSID.</strong> The coded character set ID (CCSID) that is used for
all clients connected to the server.</p>
<p>The default value for this field is the associated ASCII CCSID for the CCSID
of the job used to start the server. See the <a href="CDRGRDC.htm">Get Related
Default CCSID</a> (CDRGRDC) API for additional information on related
CCSIDs.</p>
<p><strong>Note:</strong> A value of 0 indicates that the user would like to
use the associated ASCII CCSID for the CCSID of the job used to start the
server. The field in the corresponding header file for this format may indicate
code page, but the value to be entered as input must be a CCSID.</p>
<p><strong>Idle time-out.</strong> The amount of time, in seconds, that a
connection to the simplified server will remain active once activity has ceased
on that connection. The idle time-out value must be greater than zero, or -1
(X'FFFFFFFF') for no autodisconnect.</p>
<p>The default value for this field is 6000 seconds.</p>
<p><strong>iSeries NetServer user name.</strong> The iSeries NetServer user
name to be enabled.</p>
<img src="delta.gif" alt="Start of change">
<p><strong>LAN Manager (LANMAN) authentication.</strong> The level of restriction
on the use of the LANMAN password hash for authentication. Valid values are:</p>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">LANMAN password hash is ignored if a stronger
password hash is provided by the client.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">LANMAN password hash is used only if a stronger
password hash provided by the client does not match or if a stronger password
hash is not provided.</td>
</tr>
</table>
<p>The default value for this field is 0.</p>
<p><strong>Message authentication.</strong> The status of message authentication.
Valid values are:</p>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Server does not support message authentication.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Server supports message authentication. Message
authentication is negotiated between the client and the server.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Server requires message authentication for all
connections.</td>
</tr>
</table>
<p>The default value for this field is 0.</p>
<p><strong>Minimum message severity.</strong> The minimum message severity of
administrative alerts to send to users of the server. Valid values are:</p>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">Administrative alert messages are not sent.</td>
</tr>
<tr>
<td align="left" valign="top"><em>0-99</em></td>
<td align="left" valign="top">Administrative alert messages with a severity
greater than or equal to the value are sent.</td>
</tr>
</table>
<p>The default value for this field is -1.</p>
<img src="deltaend.gif" alt="End of change">
<p><strong>Number of iSeries NetServer users to enable.</strong> The number of
iSeries user names in the list to be enabled.</p>
<img src="delta.gif" alt="Start of change">
<p><strong>Opportunistic lock time-out.</strong> The amount of time, in seconds,
that the server will wait for a response to a break lock request sent to a lock
holder before forcefully removing the lock. Valid values are:</p>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">Opportunistic locking is disabled.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1-600</em></td>
<td align="left" valign="top">The number of seconds to wait for a response to
a break lock request.</td>
</tr>
</table>
<p>The default value for this field is 30.</p>
<img src="deltaend.gif" alt="End of change">
<p><strong>Scope ID.</strong> A string that names the network scope to be used
by the Windows Internet Name Service (WINS) server.</p>
<p>The default value is nothing.</p>
<p><strong>Server role</strong> The logon server role for the system. Valid
values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The system is not a server</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The system is a server</td>
</tr>
</table>
<p>The default value for this field is 0.</p>
<p><strong>WINS primary address.</strong> The IP address of the primary Windows
Internet Name Service (WINS) server.</p>
<p>If this field is empty, it indicates no WINS primary server. This is the
default.</p>
<p><strong>WINS proxy.</strong> Enable or disable the system to act as a WINS
proxy. This enables non-WINS clients to obtain name resolution from WINS. WINS
is a dynamic naming service that resolves NetBIOS computer names to IP
addresses. Valid values are:</p>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em>character 0 (X'F0')</em></td>
<td align="left" valign="top">Disable WINS proxy</td>
</tr>
<tr>
<td align="left" valign="top"><em>character 1 (X'F1')</em></td>
<td align="left" valign="top">Enable WINS proxy</td>
</tr>
</table>
<p>The default value for this field is character 0.</p>
<p><strong>WINS secondary address.</strong> The IP address of the secondary
Windows Internet Name Service (WINS) server.</p>
<p>If this field is empty, it indicates no WINS secondary server. This is the
default.</p>
<br>
<h3>Error Messages</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">CPF3C1E E</td>
<td width="85%" valign="top">Required parameter &amp;1 omitted.</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">CPFA0D4 E</td>
<td valign="top">File system error occurred.</td>
</tr>
<tr>
<td valign="top">CPFB682 E</td>
<td valign="top">API &amp;1 failed with reason code &amp;2.</td>
</tr>
<tr>
<td valign="top">CPFB683 E</td>
<td valign="top">Data conversion failed for API &amp;1.</td>
</tr>
<tr>
<td valign="top">CPFB684 E</td>
<td valign="top">User does not have the correct authority for API &amp;1.</td>
</tr>
<tr>
<td valign="top">CPFB686 E</td>
<td valign="top">Error configuring iSeries Support for Windows Network
Neighborhood (iSeries NetServer).</td>
</tr>
<tr>
<td valign="top">CPFB690 E</td>
<td valign="top">Error changing iSeries Support for Windows Network
Neighborhood (iSeries NetServer) information.</td>
</tr>
<tr>
<td valign="top">CPFB694 E</td>
<td valign="top">When enabling users, &amp;1 users were not enabled.</td>
</tr>
<tr>
<td valign="top">CPIB685 E</td>
<td valign="top">Error occurred on iSeries Support for Windows Network
Neighborhood (iSeries NetServer) request.</td>
</tr>
</table>
<br>
<hr>
API introduced: V4R2
<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>