Retrieve Remote Network Server Status (QITDRSTS) API
Required Parameter Group:
| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Format name | Input | Char(8) |
| 4 | Remote system network server configuration name | Input | Char(10) |
| 5 | Timeout | Input | Binary(4) |
| 6 | Error Code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: No
Retrieve Remote Network Server Status (QITDRSTS) API retrieves status information about a remote network server.
Authorities and Locks
- Remote System Network Server Configuration Authority
- *USE
Required Parameter Group
- Receiver variable
- OUTPUT; CHAR(*)
The variable that is to receive the remote network server status information.
- Length of receiver variable
- INPUT; BINARY(4)
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.
- Format name
- INPUT; CHAR(8)
The content and format of the status information that is returned for the remote network server. The possible format name is:
RSTS0100 Basic network server information See Format of Remote Network Server Status Information for a description of these formats.
- Remote system network server configuration name
- INPUT; CHAR(10)
The name of the remote system network server configuration to retrieve status for.
- Timeout
- INPUT; BINARY(4)
The number of seconds to allow the remote system to respond to the status request. Allowed range is 30-300 seconds
- 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 Remote Network Server Status Information
Specifying RSTS0100 will return the basic status information.
For detailed descriptions of the fields returned in these formats, see Field Descriptions.
RSTS0100 Format
Use this format to find out basic status information about the remote network server.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | BINARY(4) | Remote network server status code |
Field Descriptions
Bytes available. The length of all data available to return. 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 was not sufficiently large to hold all the data available, this value will be less than the bytes available.
Remote network server status code. The status of the remote network server. The level of status that can be returned is dependent on the type of service processor. Some service processors only return power on (32)/power off (0) status while others return more granular information. Status codes include:
| 0 | System powered off or state unknown to service processor |
| 1 | In POST portion of boot process access. |
| 2 | Stopped in POST due to an error |
| 3 | Booted flash or a system partition |
| 4 | Booting operating system * (see note below) |
| 5 | In operating system * (see note below) |
| 6 | CPU held in reset |
| 7 | System Power On before POST |
| 32 | System powered on |
* Note: If the operating system or application code does not update the system state to 'In operating system', the system state will never change from 'Booting operating system' to 'In operating system' state.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF2114 E | Cannot allocate object &1 in &2 type *&3. |
| CPF2189 E | Not authorized to object &1 in &2 type *&3. |
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3C1D E | Length specified in parameter &1 not valid. |
| 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. |
| CPF3CF2 E | Error(s) occurred during running of &1 API. |
| CPF3CF4 E | Severe error occurred during API processing. Reason code &1. |
| CPF96CB E | Network server configuration &1 not found. |
| CPF96CD E | Network server configuration type &2 is not valid. |
| CPFA31E E | Required parameter &1 omitted. |
| CPFB752 E | Internal error in &2 API. |
| CPFC401 E | Remote server or enclosure not found. |
| CPFC402 E | Remote server or enclosure not found. |
| CPFC403 E | Remote server or enclosure not found. |
| CPFC404 E | More than one remote server or enclosure found for the serial number. |
| CPFC405 E | Remote server configuration error. |
| CPFC406 E | Program error has occurred. |
| CPFC408 E | Secure Socket Layer (SSL) connection to the service processor failed. |
| CPFC409 E | Not authorized to connect to the service processor on the remote server. |
| CPFC40B E | The certificate of the Service processor is expired. |
| CPFC40C E | Remote server configuration error. |
| CPFC40E E | Cannot access IBM Director Server. |
| CPFC40F E | Cannot connect to the service processor of the remote server or enclosure. |
 CPFC41B E |
Enable unicast of *NO is not supported. |
API introduced: V5R4