List Server Information (QZLSLSTI) API
Required Parameter Group:
| 1 | Qualified user space name | Input | Char(20) |
| 2 | Format | Input | Char(8) |
| 3 | Information qualifier | Input | Char(15) |
| 4 | Error code | I/O | Char(*) |
Optional Parameter 1:
| 5 | Session user | Input | Char(10) |
Optional Parameter 2:
| 6 | Expanded workstation name | Input | Char(*) |
Default Public Authority: *USE
Threadsafe: No
The List Server Information (QZLSLSTI) API lists share, configuration, session, statistics, and connection information for the server. You may use the information qualifier function to list just the information in which you are interested.
Authorities and Locks
To use the *RESET qualifier for the ZLSL0400 format, you must have *IOSYSCFG special authority.
- User Space Authority
- *CHANGE
- User Space Library Authority
- *EXECUTE
- User Space Lock
- *EXCLRD
Required Parameter Group
- Qualified user space name
- INPUT; CHAR(20)
The user space that is to receive the server information. The first 10 characters contain the user space name, and the second 10 characters contain the name of the library where the user space is located.
- Format
- INPUT; CHAR(8)
The content and format of the information to be returned about the IBM® i Support for Windows® Network Neighborhood (IBM i NetServer™) server. Possible format names follow:
ZLSL0100 Share information ZLSL0101 Same as ZLSL0100, plus extension information ZLSL0200 Configuration information ZLSL0201 Same as ZLSL0200, plus additional fields ZLSL0300 Session information ZLSL0400 Statistical information ZLSL0600 Session connection information ZLSL0700 Share connection information ZLSL0800 Share type information ZLSL0900 Disabled user profiles For more information, see Format of Information List.
- Information qualifier
- INPUT; CHAR(15)
A restriction on the information to be retrieved. This parameter allows the caller to request a subset of the entries that would normally be returned on a given format. Currently, this parameter applies only to the ZLSL0100 and ZLSL0101 (share information), ZLSL0300 (session information), ZLSL0400 (statistical information), ZLSL0600 (session connection information), ZLSL0700 (share connection information), and ZLSL0800 (share type information) formats.
For formats ZLSL0200 and ZLSL0201, this parameter is ignored.
For format ZLSL0300, a valid session name, *SESSID, or *EXPANDED is allowed.
For format ZLSL0400, only the *ALL and *RESET qualifiers are valid.
For format ZLSL0600, a valid session name, *SESSID, or *EXPANDED is required.
For format ZLSL0700, a valid share name is required.
For format ZLSL0800, only the *ALL qualifier is valid.
For format ZLSL0900 this parameter must be all blanks.If this parameter is all blanks or is *ALL, no information qualification is performed. Allowable values include:
Information name Information about the specified list entry only. Generic information name All information matching the generic string of the specified format. *ALL All information of the specified format. *RESET Statistical information is reset to zero. The information qualifier is valid for the ZLSL0400 format only. When the *RESET qualifier is specified, the values will be reset to zero before they are listed. *SESSID The information returned is for the session indicated by the session identifier specified on the expanded information qualifier parameter. When this value is specified for this parameter, *SESSID must be specified for the session user parameter. *EXPANDED The information returned is for the workstation name of IP address specified in the expanded information qualifier parameter. When this value is specified for this paramter, the session user and expanded information qualifier parameters must be specified.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Optional Parameter 1
- Session user
- INPUT; CHAR(10)
Allows the caller to restrict the session information to be retrieved. This parameter is ignored if a generic information name, or *ALL, is specified on the information qualifier parameter. Currently, this parameter applies only to the ZLSL0300 (session information) and ZLSL0600 (session connection information) formats. Allowable values include:
*ALL The information returned is for all users of a specific session. *SESSID The information returned is for the session indicated by the session identifier specified on the expanded information qualifier parameter. When this value is specified for this parameter, *SESSID must be specified for the information qualifier parameter. Session user name Information about the specified user only. If the session user parameter is omitted, the API assumes a value of *ALL.
Optional Parameter 2
- Expanded information qualifier
- INPUT; CHAR(*)
This parameter applies only to the ZLSL0300 (session information) and ZLSL0600 (session connection information) formats.
When *SESSID is specified for the information qualifier parameter, this parameter must be a BINARY(8) field. This allows the caller to restrict the session information to be retrieved to a single session. Allowable value are:
0 All information of the specified format. This is the default value when *SESSID is specified for the information qualifier and session user parameters Session identifier Information returned is for the specified session only When *EXPANDED is specified for the information qualifier parameter, this parameter must be a CHAR(50). The parameter can contain a workstation name, an IPv4 address, or an IPv6 address.
Format of Information List
The field list consists of:
- A user area
- A generic header section
- An input parameter section
- A data section
- ZLSL0100
- ZLSL0101
- ZLSL0200
- ZLSL0201
- ZLSL0300
- ZLSL0400
- ZLSL0600
- ZLSL0700
- ZLSL0800
- ZLSL0900
For information about the user area and generic header, see User spaces.
There are ten possible formats for the data section. The layout of the contents of the user space is determined by the format used. The following tables show how the contents of the input parameter section and the data format sections are organized. For descriptions of each field, see Field Descriptions.
When you retrieve list entry information from a user space, you must use the entry size returned in the generic header as a displacement to the next list entry for formats ZLSL0200, ZLSL0201, ZLSL0300, ZLSL0400, ZLSL0600, ZLSL0700, ZLSL0800, and ZLSL0900. For formats ZLSL0100 and ZLSL0101, use the length of this entry field at the start of each entry to calculate the displacement to the next list entry. The size of each entry may be padded at the end. If you do not use the entry size, the result may not be valid.
Input Parameter Section
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | User space name specified |
| 10 | A | CHAR(10) | User space library name specified |
| 20 | 14 | CHAR(8) | Format specified |
| 28 | 1C | CHAR(15) | Information qualifier specified |
ZLSL0100 Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Length of this entry |
| 4 | 4 | CHAR(12) | Share name |
| 16 | 10 | BINARY(4) | Device type |
| 20 | 14 | BINARY(4) | Permissions |
| 24 | 18 | BINARY(4) | Maximum users |
| 28 | 1C | BINARY(4) | Current users |
| 32 | 20 | BINARY(4) | Spooled file type |
| 36 | 24 | BINARY(4) | Offset to path name |
| 40 | 28 | BINARY(4) | Length of path name |
| 44 | 2C | CHAR(20) | Qualified output queue |
| 64 | 40 | CHAR(50) | Print driver type |
| 114 | 72 | CHAR(50) | Text description |
| 164 | A4 | CHAR(*) | Path name |
ZLSL0101 Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Length of this entry |
| 4 | 4 | CHAR(12) | Share name |
| 16 | 10 | BINARY(4) | Device type |
| 20 | 14 | BINARY(4) | Permissions |
| 24 | 18 | BINARY(4) | Maximum users |
| 28 | 1C | BINARY(4) | Current users |
| 32 | 20 | BINARY(4) | Spooled file type |
| 36 | 24 | BINARY(4) | Offset to path name |
| 40 | 28 | BINARY(4) | Length of path name |
| 44 | 2C | CHAR(20) | Qualified output queue |
| 64 | 40 | CHAR(50) | Print driver type |
| 114 | 72 | CHAR(50) | Text description |
| 164 | A4 | CHAR(20) | Qualified printer file |
| 184 | B8 | BINARY(4) | CCSID used for text conversion |
| 188 | BC | BINARY(4) | Offset to extension table |
| 192 | C0 | BINARY(4) | Number of table entries |
| 196 | C4 | CHAR(1) | Enable text conversion |
| 197 | C5 | CHAR(1) | Publish print share |
| * | * | CHAR(*) | Path name |
| These fields repeat for each file extension table entry. | BINARY(4) | Length of file extension | |
| CHAR(46) | File extension | ||
ZLSL0200 Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | CCSID |
| 4 | 4 | BINARY(4) | Pending CCSID |
| 8 | 8 | BINARY(4) | Idle time-out |
| 12 | C | BINARY(4) | Pending idle time-out |
| 16 | 10 | BINARY(4) | Opportunistic lock time-out |
| 20 | 14 | BINARY(4) | Pending opportunistic lock time-out |
| 24 | 18 | BINARY(4) | Browsing interval |
| 28 | 1C | BINARY(4) | Pending browsing interval |
| 32 | 20 | BINARY(4) | WINS enablement |
| 36 | 24 | BINARY(4) | Pending WINS enablement |
| 40 | 28 | BINARY(4) | Guest support |
| 44 | 2C | BINARY(4) | Pending guest support |
| 48 | 30 | CHAR(10) | Guest user profile |
| 58 | 3A | CHAR(10) | Pending guest user profile |
| 68 | 44 | CHAR(15) | Server name |
| 83 | 53 | CHAR(15) | Pending server name |
| 98 | 62 | CHAR(15) | Domain name |
| 113 | 71 | CHAR(15) | Pending domain name |
| 128 | 80 | CHAR(50) | Text description |
| 178 | B2 | CHAR(50) | Pending text description |
| 228 | E4 | CHAR(15) | WINS primary address |
| 243 | F3 | CHAR(15) | Pending WINS primary address |
| 258 | 102 | CHAR(15) | WINS secondary address |
| 273 | 111 | CHAR(15) | Pending WINS secondary address |
| 288 | 120 | CHAR(224) | Scope ID |
| 512 | 200 | CHAR(224) | Pending scope ID |
ZLSL0201 Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | CCSID |
| 4 | 4 | BINARY(4) | Pending CCSID |
| 8 | 8 | BINARY(4) | Idle time-out |
| 12 | C | BINARY(4) | Pending idle time-out |
| 16 | 10 | BINARY(4) | Opportunistic lock time-out |
| 20 | 14 | BINARY(4) | Pending opportunistic lock time-out |
| 24 | 18 | BINARY(4) | Browsing interval |
| 28 | 1C | BINARY(4) | Pending browsing interval |
| 32 | 20 | BINARY(4) | WINS enablement |
| 36 | 24 | BINARY(4) | Pending WINS enablement |
| 40 | 28 | BINARY(4) | Guest support |
| 44 | 2C | BINARY(4) | Pending guest support |
| 48 | 30 | CHAR(10) | Guest user profile |
| 58 | 3A | CHAR(10) | Pending guest user profile |
| 68 | 44 | CHAR(15) | Server name |
| 83 | 53 | CHAR(15) | Pending server name |
| 98 | 62 | CHAR(15) | Domain name |
| 113 | 71 | CHAR(15) | Pending domain name |
| 128 | 80 | CHAR(50) | Text description |
| 178 | B2 | CHAR(50) | Pending text description |
| 228 | E4 | CHAR(15) | WINS primary address |
| 243 | F3 | CHAR(15) | Pending WINS primary address |
| 258 | 102 | CHAR(15) | WINS secondary address |
| 273 | 111 | CHAR(15) | Pending WINS secondary address |
| 288 | 120 | CHAR(224) | Scope ID |
| 512 | 200 | CHAR(224) | Pending scope ID |
| 736 | 2E0 | CHAR(1) | Allow system name |
| 737 | 2E1 | CHAR(1) | Pending allow system name |
| 738 | 2E2 | CHAR(1) | Authentication method |
| 739 | 2E3 | CHAR(1) | Pending authentication method |
| 740 | 2E4 | BINARY(4) | Server role |
| 744 | 2E8 | BINARY(4) | Pending server role |
| 748 | 2EC | BINARY(4) | Message authentication |
| 752 | 2F0 | BINARY(4) | Pending message authentication |
| 756 | 2F4 | BINARY(4) | Minimum message severity |
| 760 | 2F8 | BINARY(4) | Pending minimum message severity |
| 764 | 2FC | BINARY(4) | LAN Manager authentication |
| 768 | 300 | BINARY(4) | Pending LAN Manager authentication |
ZLSL0300 Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(15) | Workstation name |
| 15 | F | CHAR(10) | User profile name |
| 25 | 19 | CHAR(3) | Reserved |
| 28 | 1C | BINARY(4) | Number of connections |
| 32 | 20 | BINARY(4) | Number of files open |
| 36 | 24 | BINARY(4) | Number of sessions |
| 40 | 28 | BINARY(4) | Session time |
| 44 | 2C | BINARY(4) | Session idle time |
| 48 | 30 | CHAR(1) | Logon type |
| 49 | 31 | CHAR(1) | Encrypted password |
| 50 | 32 | CHAR(6) | Reserved |
| 56 | 38 | BINARY(8) | Session identifier |
| 64 | 40 | BINARY(4) | Expanded workstation name type |
| 68 | 44 | CHAR(124) | Expanded workstation name |
ZLSL0400 Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | File opens |
| 4 | 4 | BINARY(4) | Print jobs queued |
| 8 | 8 | BINARY(4) | Session starts |
| 12 | C | BINARY(4) | Sessions disconnected automatically |
| 16 | 10 | BINARY(4) | Sessions disconnected |
| 20 | 14 | CHAR(8) | Reserved |
| 28 | 1C | BINARY(4) | Password violations |
| 32 | 20 | BINARY(4) | Guest support |
| 36 | 24 | BINARY(4) | Unknown users |
| 40 | 28 | BINARY(4) | Number of bytes sent (low) |
| 44 | 2C | BINARY(4) | Number of bytes sent (high) |
| 48 | 30 | BINARY(4) | Number of bytes received (low) |
| 52 | 34 | BINARY(4) | Number of bytes received (high) |
| 56 | 38 | BINARY(4) | Average response time |
| 60 | 3C | CHAR(13) | Date and time started |
| 73 | 49 | CHAR(13) | Date and time reset |
| 86 | 56 | CHAR(2) | Reserved |
ZLSL0600 Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Connection ID |
| 4 | 4 | BINARY(4) | Connection type |
| 8 | 8 | BINARY(4) | Number of files open |
| 12 | C | BINARY(4) | Number of connection users |
| 16 | 10 | BINARY(4) | Connection time |
| 20 | 14 | CHAR(10) | User name |
| 30 | 1E | CHAR(12) | Share name |
| 42 | 2A | CHAR(6) | Reserved |
| 48 | 30 | BINARY(8) | Session identifier |
| 56 | 38 | CHAR(8) | Reserved |
ZLSL0700 Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Connection ID |
| 4 | 4 | BINARY(4) | Connection type |
| 8 | 8 | BINARY(4) | Number of files open |
| 12 | C | BINARY(4) | Number of connection users |
| 16 | 10 | BINARY(4) | Connection time |
| 20 | 14 | CHAR(10) | User name |
| 30 | 1E | CHAR(15) | Workstation name |
| 45 | 2D | CHAR(3) | Reserved |
| 48 | 30 | BINARY(8) | Session identifier |
| 56 | 38 | CHAR(8) | Reserved |
| 64 | 40 | BINARY(4) | Expanded workstation name type |
| 68 | 44 | CHAR(124) | Expanded workstation name |
ZLSL0800 Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(12) | Share name |
| 12 | C | BINARY(4) | Device type |
ZLSL0900 Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| This field repeats for each user. | CHAR(10) | IBM i NetServer user name | |
Field Descriptions
Allow system name. Whether the server allows clients to connect using the system name found in the System i™ network attributes. Possible values are:
| character 0 (0xF0) | Do not allow access to the server using the system name. |
| character 1 (0xF1) | Allow access to the server using the system name. |
Authentication method. The method used to authenticate users. Possible values are:
| character 0 (0xF0) | The server authenticates with encrypted passwords only. |
| character 1 (0xF1) | The server authenticates with network authentication only. |
| character 2 (0xF2) | The server authenticates with network authentication when possible, but it allows clients to use encrypted passwords. |
Average response time. The average server response time in milliseconds.
Browsing interval. The amount of time, in milliseconds, between each browsing server announcement.
CCSID. The coded character set ID (CCSID) that is used by all clients connected to the server.
Note: The field in the corresponding header file for this format may indicate code page, but the value returned will be the CCSID.
CCSID used for text conversion. The CCSID that is used for text file data conversion.
Note: The field in the corresponding header file for this format may indicate code page, but the value returned will be the CCSID.
Connection ID. The number that identifies the connection.
Connection time. The number of seconds since the connection was established.
Connection type. The type of the connection made from the workstation to the shared resource. Possible values are:
| 0 | Disk drive |
| 1 | Spooled output queue |
Current users. The number of connections that are currently made to the resource. A value of -1 (X'FFFFFFFF') means that the server was unable to retrieve the actual value.
Date and time reset. The date and time when the server statistics were reset.
The 13 characters are:
| 1 | Century, where 0 indicates years 19xx and 1 indicates years 20xx. |
| 2-7 | Date, in YYMMDD (year, month, and day) format. |
| 8-13 | Time of day, in HHMMSS (hours, minutes, and seconds) format. |
Date and time started. The date and time when the server was started. The 13 characters are:
| 1 | Century, where 0 indicates years 19xx and 1 indicates years 20xx. |
| 2-7 | Date, in YYMMDD (year, month, and day) format. |
| 8-13 | Time of day, in HHMMSS (hours, minutes, and seconds) format. |
Device type. One of the following values:
| 0 | Disk drive |
| 1 | Spooled output queue |
Domain name. The name of the domain in which the IBM i Support for Windows Network Neighborhood server is a member.
Enable text conversion. Whether the server enables text conversion for this share. Possible values are:
| 0 | Text conversion not enabled |
| 1 | Text conversion enabled |
| 2 | Text conversion enabled and mixed data is allowed |
Encrypted password. Whether the the encrypted password was used to establish the session to the server. Possible values are:
| 0 | An encrypted password was not used to establish the session |
| 1 | An encrypted password was used to establish the session |
Expanded workstation name. The name of the workstation or IP address from which the session to the server was established.
Expanded workstation name type. Indicates the type of information returned in the expanded workstation name field. Possible values are:
| 0 | Workstation name. The workstation name will be filled in the expanded workstation name field and the workstation field |
| 1 | IPv4 address. The IPv4 address will be filled in the expanded workstation name field and the workstation field |
| 2 | IPv6 address. The IPv6 address will be filled in the expanded workstation name field and the workstation field will be blank filled |
File extension. A file extension string that is null-terminated. Possible values include:
| * | The server will convert all files. |
| . | The server will convert all files without an extension. |
| TXT, .TXT | The server will convert all files ending with .TXT (that is, a.TXT, a.b.c.TXT). |
| ..TXT, ...TXT, ......TXT | Extensions with more than one leading period will have no effect on the server. No translation will be done. |
| T*T | The server will convert all files ending with an extension that substitutes any number of characters for the * wild card (that is, a.T123T, b.TXT, c.TEST). |
| T?T | The server will convert all files ending with an extension that substitutes any one character for the ? wild card (that is, a.T1T, b.TXT). |
File opens. The number of file opens for the whole server.
Format specified. The content and format of the information to be returned about the IBM i Support for Windows Network Neighborhood server. Possible format names follow:
- ZLSL0100
- ZLSL0101
- ZLSL0200
- ZLSL0201
- ZLSL0300
- ZLSL0400
- ZLSL0600
- ZLSL0700
- ZLSL0800
- ZLSL0900
Guest support. A guest user profile may be used in the event an unknown user attempts to access resources on the system. Possible values are as follows:
| 0 | Use of guest user profile not supported |
| 1 | Use of guest user profile supported |
Guest user profile. The user profile to be used in the event an unknown user attempts to access resources on the system.
Idle time-out. The amount of time, in seconds, a connection to the simplified server remains active once activity has ceased on that connection.
Information qualifier specified. A restriction on the information to be retrieved. If a qualifier is specified that is inconsistent with the format requested, an error message is returned. A null list is returned if no information meets the qualifications. If this parameter is all blanks, no information qualification is performed. Allowable values include:
| Information name | Information about this specified format only |
| Generic information name | All information that matches the generic string of the specified format |
| *ALL | All information |
| *RESET | Statistical information is reset to zero. The information qualifier is valid for the ZLSL0400 format only. |
IBM i NetServer user name. The name of an IBM i NetServer user.
LAN Manager (LANMAN) authentication. The level of restriction on the use of the LANMAN password hash for authentication. Possible values for the field follow:
| 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 |
Length of file extension. The size in bytes of the file extension. The length does not include the byte used for null-termination.
Length of path name. The length of the local path name of the shared resource in bytes.
Length of this entry. The total length of the list entry in bytes.
Logon type. The type of authentication used to connect to the server. Possible values for the flag follow:
| 0 | Authentication using the defined guest user profile |
| 1 | Regular user authentication |
Maximum users. The maximum number of concurrent connections that the shared resource can accommodate. This number is unlimited if the value is -1.
Message authentication. The status of message authentication. Possible values for the field follow:
| 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 |
Minimum message severity. The minimum message severity of administrative alerts to send to users of the server. Administrative alert messages are not sent if the value is -1.
Number of bytes received (high). The number of server bytes received from the network (high-order bits of 8-byte combinations of both number of bytes received fields).
Number of bytes received (low). The number of server bytes received from the network (low-order bits of 8-byte combinations of both number of bytes received fields).
Number of bytes sent (high). The number of server bytes sent to the network (high-order bits of 8-byte combinations of both number of bytes sent fields).
Number of bytes sent (low). The number of server bytes sent to the network (low-order bits of 8-byte combinations of both number of bytes sent fields).
Number of connections. The number of connections made during the session.
Number of connection users. The number of users on the connection.
Number of files open. The number of files that are open currently.
Number of sessions. The number of sessions that are established between the server and the requester.
Number of table entries. The number of file extension entries in the file extension table.
Offset to extension table. The offset from the start of user space where the file extension table starts.
Offset to path name. The offset from the start of user space where the path name of the shared resource starts.
Opportunistic lock (oplock) 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.
Password violations. The number of server password violations.
Path name. A path in the integrated file system. The path name is stored internally in unicode format; when listed, it is converted into the CCSID of the current job.
Pending allow system name. Whether the server allows clients to connect using the system name found in the network attributes the next time the server is started. Possible values are:
| character 0 (0xF0) | Do not allow access to the server using the system name |
| character 1 (0xF1) | Allow access to the server using the system name. |
Pending authentication method. The method that will be used to authenticate users the next time the server is started. Possible values are:
| character 0 (0xF0) | The server will authenticate with encrypted passwords only. |
| character 1 (0xF1) | The server will authenticate with network authentication only. |
| character 2 (0xF2) | The server will authenticate with network authentication when possible, but it will allow clients to use encrypted passwords when needed. |
Pending browsing interval. The amount of time, in seconds, to be used the next time the server is started, between each browsing server announcement.
Pending CCSID. The CCSID that is used by all clients connected to the server the next time the server is started.
Note: The field in the corresponding header file for this format may indicate code page, but the value returned will be the CCSID.
Pending domain name. The name of the domain in which the server will be a member the next time the server is started.
Pending guest support. A guest user profile may be used the next time the server is started in the event an unknown user attempts to access resources on the system. Possible values are:
| 0 | Use of guest user profile not supported |
| 1 | Use of guest user profile supported |
Pending guest user profile. The user profile to be used the next the time the server is started in the event that an unknown user attempts to access resources on the system.
Pending idle time-out. The amount of time (in seconds) to be used the next time the server is started so that a connection to the server will remain active once activity has ceased on that connection.
Pending LAN Manager (LANMAN) authentication. The level of restriction on the use of the LANMAN password hash to be used the next time the server is started. Possible values for the field follow:
| 0 | LANMAN password hash will be ignored if a stronger password hash is provided by the client |
| 1 | LANMAN password hash will be used only if a stronger password hash provided by the client does not match or if a stronger password hash is not provided |
Pending message authentication. The status of message authentication to be used the next time the server is started. Possible values are:
| 0 | Server will not support message authentication |
| 1 | Server will support message authentication. Message authentication will be negotiated between the client and the server. |
| 2 | Server will require message authentication for all connections |
Pending minimum message severity. The minimum message severity to be used the next time the server is started when sending administrative alerts to users of the server.
Pending opportunistic lock time-out. The amount of time, to be used the next time the server is started, that the server will wait for a response to a break lock request sent to a lock holder before forcefully removing the lock.
Pending scope ID. A string that names the network scope to be used by the Windows Internet Name Service (WINS) server the next time the server is started.
Pending server name. The name the server will be known as on the system the next time the server is started.
Pending server role. The value that determines the logon server role for this system the next time the server is started. Possible values are:
| 0 | System will not be a server. |
| 1 | System will be a server. |
Pending text description. An optional comment about the shared resource to be used the next time the server is started.
Pending WINS enablement. Whether this system uses the services of a Windows Internet Name Service (WINS) server the next time the server is started. Possible values are:
| 0 | Do not use WINS server |
| 1 | Use WINS server |
Pending WINS primary address. The IP address of the primary Windows Internet Name Service (WINS) server to be used the next time the server is started.
Pending WINS secondary address. The IP address of the secondary Windows Internet Name Service (WINS) server to be used the next time the server is started.
Permissions. Permissions to be applied against the disk for sharing. Possible values are:
| 1 | Read only |
| 2 | Read/write |
Print driver type. The text string that identifies the print driver appropriate for this share. When personal computers connect to this shared printer, this identifies the print driver they should use. This text should match the name of a print driver known to the personal computer operating system.
Print jobs queued. The number of server print jobs spooled.
Publish print share. Whether the print share is to be published. Possible values are:
| 0 | Print share is not published |
| 1 | Print share is published |
Qualified output queue. The name and library of the output queue. The first 10 characters identify the name of the output queue. The second 10 characters contain the library that contains the output queue.
Qualified printer file. The name and library of the printer file. The first 10 characters identify the name of the printer file. The second 10 characters contain the library that contains the printer file.
Reserved. Field not used currently.
Scope ID. A string that names the network scope to be used by the Windows Internet Name Service (WINS) server.
Server name. The name by which the server is known on the system.
Server role. The value that determines the logon server role for this system. Possible values are:
| 0 | System is not a server. |
| 1 | System is a server. |
Sessions disconnected. The number of server sessions disconnected normally or ended in error.
Sessions disconnected automatically. The number of server sessions disconnected automatically.
Session identifier. Unique identifier for the server session.
Session idle time. The number of seconds a session has been idle.
Session starts. The number of server session starts.
Session time. The number of seconds since the session was established.
Share name. The network name of the resource.
Spooled file type. The type of spooled files that will be created using this share. Values can be:
| 1 | User ASCII (*USERASCII) |
| 2 | Advanced Function Presentation™ (*AFP) |
| 3 | Simplified Character Set (*SCS) |
| 4 | Automatic type sensing |
Text description. An optional comment about the shared resource or computer.
Unknown users. The number of unknown users that have requested sessions to the server.
User name. The name of the user that is associated with the connection.
User profile name. The name of the user that is associated with the resource.
User space library name specified. The user space library name that was passed to this API on the call in the qualified user space name parameter.
User space name specified. The user space name that was passed to this API on the call in the qualified user space name parameter.
WINS enablement. This system may use the services of a Windows Internet Name Service (WINS) server. Possible values are:
| 0 | Do NOT use WINS server. |
| 1 | Use WINS server. |
WINS primary address. The IP address of the primary Windows Internet Name Service (WINS) server.
WINS secondary address. The IP address of the secondary Windows Internet Name Service (WINS) server.
Workstation name. The name of the workstation from which the session to the server was established.
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). |
| CPFB68F E | Error listing IBM i Support for Windows Network Neighborhood (IBM i NetServer) information. |
| CPFB693 E | Data conversion failed for &5 API. |
| CPIB685 E | Error occurred on IBM i Support for Windows Network Neighborhood (IBM i NetServer) request. |
API introduced: V4R2