Change Server Information (QZLSCHSI) API
Required Parameter Group:
| 1 | Request variable | Input | Char(*) |
| 2 | Length of request variable | Input | Binary(4) |
| 3 | Format | Input | Char(8) |
| 4 | Error Code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: No
The Change Server Information (QZLSCHSI) API changes general configuration information for the IBM® i Support for Windows® Network Neighborhood (IBM i NetServer™) 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.
Authorities and Locks
To use this API, you must have *IOSYSCFG special authority. To use format ZLSS0200 to enable an IBM i NetServer user, you must have *SECADM special authority and *OBJMGT and *USE authority to the system user profile.
Required Parameter Group
- Request variable
- INPUT; CHAR(*)
A variable that is used to pass values for the information to be changed.
For more information, see Format of Information Changed.
- Length of request variable
- INPUT; BINARY(4)
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.
- Format
- INPUT; CHAR(8)
The content and format of the information to be changed by the simplified server. The following format names must be used:
ZLSS0100 Server information ZLSS0200 Enable user information For more information, see Format of Information Changed.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Format of Information Changed
The following table shows how the content of the request variable is organized. For descriptions of each field, see Field Descriptions.
Format ZLSS0100
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | CCSID |
| 4 | 4 | BINARY(4) | Idle time-out |
| 8 | 8 | BINARY(4) | Opportunistic lock time-out |
| 12 | C | BINARY(4) | Browsing interval |
| 16 | 10 | CHAR(15) | WINS primary address |
| 31 | 1F | CHAR(15) | WINS secondary address |
| 46 | 2E | CHAR(224) | Scope ID |
| 270 | 10E | CHAR(1) | WINS proxy |
| 271 | 10F | CHAR(5) | Reserved |
| 276 | 114 | BINARY(4) | Server role |
| 280 | 118 | CHAR(1) | Authentication method |
| 281 | 119 | CHAR(3) | Reserved |
| 284 | 11C | BINARY(4) | Message authentication |
| 288 | 120 | BINARY(4) | Minimum message severity |
| 292 | 124 | BINARY(4) | LAN Manager authentication |
Format ZLSS0200
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Number of IBM i NetServer users to enable |
| This field repeats for each user. | CHAR(10) | IBM i NetServer user name | |
Field Descriptions
Authentication method. The authentication method used to authenticate users. Valid values are:
| character 0 (X'F0') | The server authenticates with encrypted passwords only. |
| character 1 (X'F1') | The server authenticates with network authentication only. |
| character 2 (X'F2') | The server authenticates with network authentication when possible, but it allows clients to use encrypted passwords when needed. |
The default value for this field is character 0.
Note: Authentication method should only be set to character 1 in networks containing only Windows® 2000 and newer IBM i NetServer clients that are configured to participate in a network authentication realm. All other Windows clients will be unable to connect to IBM i NetServer when network authentication only support is enabled.
Browsing interval. 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.
The default value for this field is 720000 milliseconds.
CCSID. The coded character set ID (CCSID) that is used for all clients connected to the server.
The default value for this field is the associated ASCII CCSID for the CCSID of the job used to start the server. See Get Related Default CCSID (CDRGRDC) API for additional information on related CCSIDs.
Note: 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.
Idle time-out. 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.
The default value for this field is 6000 seconds.
IBM i NetServer user name. The IBM i NetServer user name to be enabled.
LAN Manager (LANMAN) authentication. The level of restriction on the use of the LANMAN password hash for authentication. Valid values are:
| 0 | LANMAN password hash is ignored if a stronger password hash is provided by the client. |
| 1 | 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. |
The default value for this field is 0.
Message authentication. The status of message authentication. Valid values are:
| 0 | Server does not support message authentication. |
| 1 | Server supports message authentication. Message authentication is negotiated between the client and the server. |
| 2 | Server requires message authentication for all connections. |
The default value for this field is 1.
Minimum message severity. The minimum message severity of administrative alerts to send to users of the server. Valid values are:
| -1 | Administrative alert messages are not sent. |
| 0-99 | Administrative alert messages with a severity greater than or equal to the value are sent. |
The default value for this field is -1.
Number of IBM i NetServer users to enable. The number of IBM i NetServer user names in the list to be enabled.
Opportunistic lock time-out. 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:
| -1 | Opportunistic locking is disabled. |
| 1-600 | The number of seconds to wait for a response to a break lock request. |
The default value for this field is 30.
Scope ID. A string that names the network scope to be used by the Windows Internet Name Service (WINS) server.
The default value is nothing.
Server role. The logon server role for the system. Valid values are:
| 0 | The system is not a server |
| 1 | The system is a server |
The default value for this field is 0.
The logon server
role has been deprecated. Regardless of the value specified, the logon
server role will always be set to 0 (The system is not a server.)
WINS primary address. The IP address of the primary Windows Internet Name Service (WINS) server.
If this field is empty, it indicates no WINS primary server. This is the default.
WINS proxy. 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:
| character 0 (X'F0') | Disable WINS proxy |
| character 1 (X'F1') | Enable WINS proxy |
The default value for this field is character 0.
WINS secondary address. The IP address of the secondary Windows Internet Name Service (WINS) server.
If this field is empty, it indicates no WINS secondary server. This is the default.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF3C1E E | Required parameter &1 omitted. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3CF2 E | Error(s) occurred during running of &1 API. |
| CPFA0D4 E | File system error occurred. |
| CPFB682 E | API &1 failed with reason code &2. |
| CPFB683 E | Data conversion failed for API &1. |
| CPFB684 E | User does not have the correct authority for API &1. |
| CPFB686 E | Error configuring IBM i Support for Windows Network Neighborhood (IBM i NetServer). |
| CPFB690 E | Error changing IBM i Support for Windows Network Neighborhood (IBM i NetServer) information. |
| CPFB694 E | When enabling users, &1 users were not enabled. |
| CPIB685 E | Error occurred on IBM i Support for Windows Network Neighborhood (IBM i NetServer) request. |
API introduced: V4R2