Retrieve Network Server Information (QFPADRNI) API
Required Parameter Group:
| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Format name | Input | Char(8) |
| 4 | NWSD server name | Input | Char(8) |
| 5 | Error Code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: No
The Retrieve Network Server Information (QFPADRNI) API retrieves information from a Windows® or Intel® Linux® server. The amount of information returned depends on the size of the variable. The information returned is similar to the information returned by the Work with Network Server Status (WRKNWSSTS) command's option 5, Display details.
Authorities and Locks
- Network Server Description Authority
- *USE
- Network Server Description Lock
- *EXCLRD
Required Parameter Group
- Receiver variable
- OUTPUT; CHAR(*)
The variable to receive the network server information. You can specify the size of this area to be smaller than the format requested as long as you specify the length parameter correctly. As a result, the API returns only the data that the area can hold.
- Length of receiver variable
- INPUT; BINARY(4)
The length of the receiver variable. If the length is larger than the size of the receiver variable, the results may not be predictable. The minimum length is 8 bytes.
- Format name
- INPUT; CHAR(8)
The format of the network server information to be returned. The valid format names are:
DRNI0100 Returns information about the Windows or Intel Linux server version and the Integrated Server Support product version that is installed on the server. DRNI0200 Returns information about the Windows or Intel Linux server's current status.
- NWSD server name
- INPUT; CHAR(8)
The name of the NWSD for which to retrieve information. The name must be specified in upper case characters and padded with blanks to a full 8 characters.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
DRNI0100 Format
The DRNI0100 format returns network server version information.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | CHAR(10) | Server operating system version |
| 18 | 12 | CHAR(10) | Server operating system build ID |
| 28 | 1C | CHAR(128) | Server operating system service level |
| 156 | 9C | CHAR(6) | Integrated Server Support version |
| 162 | A2 | CHAR(38) | Reserved |
| 200 | C8 | BINARY(4) | Offset to list of Integrated Server Support service pack entries |
| 204 | CC | BINARY(4) | Length of an Integrated Server Support service pack entry |
| 208 | D0 | BINARY(4) | Number of Integrated Server Support service pack entries |
| 212 | D4 | BINARY(4) | Offset to list of Integrated Server Support hot fix entries |
| 216 | D8 | BINARY(4) | Length of an Integrated Server Support hot fix entry |
| 220 | DC | BINARY(4) | Number of Integrated Server Support hot fix entries |
| These fields repeat for each Integrated Server Support service pack. | CHAR(7) | Integrated Server Support service pack | |
| CHAR(1) | Reserved | ||
| These fields repeat for each Integrated Server Support hot fix. | CHAR(7) | Integrated Server Support hot fix | |
| CHAR(1) | Reserved | ||
DRNI0200 Format
The DRNI0200 format returns network server status information.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | BINARY(4) | Connected users |
| 12 | C | BINARY(4) | Processor used |
| 16 | 10 | BINARY(4) | Paging file used |
| 20 | 14 | BINARY(4) | Registry quota used |
| 24 | 18 | BINARY(4) | Offset to list of multiple processor usage entries |
| 28 | 1C | BINARY(4) | Length of a multiple processor usage entry |
| 32 | 20 | BINARY(4) | Number of multiple processor usage entries |
| This field repeats for each multiple processor usage entry | BINARY(4) | Multiple processor usage | |
Field Descriptions
Bytes available. The length of all data available for the requested format. All available data is returned if enough space is provided.
Bytes returned. The length of all data actually returned. If the data is truncated because the receiver variable is not large enough to hold the data, this value is less than the bytes available.
Connected users. Number of user connections currently present on this server.
Integrated Server Support hot fix. The identifier for an Integrated Server Support hot fix that is installed on the server.
Integrated Server Support service pack. The identifier for an Integrated Server Support service pack that is installed on the server.
Integrated Server Support version. The version number of the Integrated Server Support product that is installed on the server. The value has the format VxRyMz, where x is the version, y is the release, and z is the modification.
Length of a multiple processor usage entry. The length of one multiple processor usage entry.
Length of an Integrated Server Support hot fix entry. The length of one Integrated Server Support hot fix entry.
Length of an Integrated Server Support service pack entry. The length of one Integrated Server Support service pack entry.
Multiple processor usage. The percent usage for servers that support multiple processors. This number is the processor usage value for an individual processor, represented as an integer value between 0 and 100. A usage value is returned for each processor, so the number of values returned depends on the number of processors on the server.
Number of Integrated Server Support hot fix entries. The number of times the Integrated Server Support hot fix entries are repeated.
Number of Integrated Server Support service pack entries. The number of times the Integrated Server Support service pack entries are repeated.
Number of multiple processor usage entries. The number of times the multiple processor usage entries are repeated.
Offset to list of Integrated Server Support hot fix entries. The offset to the first entry in the Integrated Server Support hot fix list.
Offset to list of Integrated Server Support service pack entries. The offset to the first entry in the Integrated Server Support service pack list.
Offset to list of multiple processor usage entries. The offset to the first entry in the multiple processor usage list.
Paging file used. The percentage of the server paging file used. This percentage is expressed as an integer value between 0 and 100.
Processor used. The percentage of the server's processor used. This percentage is expressed as an integer value between 0 and 100.
If the server supports a single processor, this number is the usage for the individual processor. If the server supports multiple processors, this number is the average processor usage for all of the processors.
Registry quota used. The percentage of the server's registry used. This percentage is expressed as an integer value between 0 and 100.
Reserved. Reserved space.
Server operating system build ID. The current build identifier of the server operating system.
Server operating system service level. The service level of the operating system that is installed on the server.
Server operating system version. The current version of the operating system on the server.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF0C4A E | Product record not found. |
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF2625 E | Not able to allocate object &1. |
| CPF2634 E | Not authorized to object &1. |
| CPF3C17 E | Error occurred with input data parameter. |
| CPF3C19 E | Error occurred with receiver variable specified. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C24 E | Length of the receiver variable is not valid. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF9806 E | Cannot perform function for object &2 in library &3. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
API introduced: V4R5