Retrieve Configuration Status (QDCRCFGS) API
| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Format name | Input | Char(8) |
| 4 | Configuration description type | Input | Char(10) |
| 5 | Configuration description name | Input | Char(10) |
| 6 | Error Code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: Yes
The Retrieve Configuration Status (QDCRCFGS) API retrieves the current status of a line, controller, device, network interface, or network server description.
Authorities and Locks
- Configuration Description Authority
- *USE
- Configuration Description Lock
- *SHRRD
Required Parameter Group
- Receiver variable
- OUTPUT; CHAR(*)
The variable that is to receive the status information. Format CFGS0100 describes the layout of the status information returned in this variable.
- Length of receiver variable
- INPUT; BINARY(4)
The length of the area referenced by the receiver variable parameter. If the amount of information to be returned is greater than this value, the information is truncated to this length.
- Format name
- INPUT; CHAR(8)
The content and format of the status information returned for the specified configuration description. The format name is:
CFGS0100 Configuration description object status See Format of Status Information for a description of this format.
- Configuration description type
- INPUT; CHAR(10)
The type of configuration description object for which status is being retrieved. The possible values are:
*LIND The object is a line description. *CTLD The object is a controller description. *DEVD The object is a device description. *NWID The object is a network interface description. *NWSD The object is a network server description.
- Configuration description name
- INPUT; CHAR(10)
The name of the line, controller, device or network interface for which status is being retrieved.
- 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 Status Information
Following is the format of the status information returned. For detailed descriptions of the fields in the list, see Field Descriptions.
CFGS0100 Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | BINARY(4) | Current status: numeric code |
| 12 | C | CHAR(7) | Date information retrieved |
| 19 | 13 | CHAR(6) | Time information retrieved |
| 25 | 19 | CHAR(20) | Current Status: displayable text |
| 45 | 2D | CHAR(10) | Job name |
| 55 | 37 | CHAR(10) | User name |
| 65 | 41 | CHAR(6) | Job number |
| 71 | 47 | CHAR(10) | Pass-through device |
| 81 | 51 | CHAR(3) | Reserved |
| 84 | 54 | BINARY (4) | Offset to list of active conversations |
| 88 | 58 | BINARY(4) | Number of active conversations |
| 92 | 5C | BINARY(4) | Entry length for list of active conversations |
| 96 | 60 | BINARY(4) | Offset to list of multiple job information |
| 100 | 64 | BINARY(4) | Number of multiple jobs |
| 104 | 68 | BINARY(4) | Entry length for list of multiple jobs |
| These fields repeat for each active conversation | BINARY(4) | Conversation status numeric value | |
| CHAR(20) | Conversation status text value | ||
| CHAR(10) | Conversation mode name | ||
| CHAR(10) | Conversation job name | ||
| CHAR(10) | Conversation user name | ||
| CHAR(6) | Conversation job number | ||
| These fields repeat for each additional job | CHAR(10) | Multiple job name | |
| CHAR(10) | Multiple job user name | ||
| CHAR(6) | Multiple job number | ||
Field Descriptions
Bytes available. The number of bytes of data available to be returned. All available data is returned if enough space is provided.
Bytes returned. The number of bytes of data returned.
Conversation job name. The job name portion of the qualified job name for an active conversation on an APPC device.
Conversation job number. The job number portion of the qualified job name for an active conversation on an APPC device.
Conversation mode name. The mode name for an active conversation on an APPC device.
Conversation status numeric value. A numeric value that represents the current status of an active conversation on an APPC device. See the current status field for valid status values.
Conversation status text value. A text value that represents the current status of an active conversation on an APPC device. See the current status field for valid status values.
Conversation user name. The user name portion of the qualified job name for an active conversation on an APPC device.
Current status. The current status of the selected object using two fields:
- Current status: numeric code
- Current status: displayable text
Note: The displayable text is translated when it is returned. This text is retrieved from message CPX2651 in message file QCPFMSG in library *LIBL.
Possible values follow:
| Status Numeric Code (decimal) |
Status Displayable Text |
|---|---|
| 0 | VARIED OFF |
| 1 | OPERATIONAL |
| 2 | AS/36 DISABLED |
| 5 | DEALLOCATED |
| 6 | UNPROTECTED |
| 7 | ALLOCATED |
| 8 | STAND-ALONE |
| 10 | VARY OFF PENDING |
| 20 | VARY ON PENDING |
| 21 | VARY ON PENDING/DETACHED |
| 22 | VARY ON PENDING/ALLOCATE |
| 30 | VARIED ON |
| 31 | VARIED ON/ALLOCATE |
| 32 | VARYON/CNNPENDING |
| 33 | AS/36 ENABLED |
| 40 | CONNECT PENDING |
| 50 | SIGNON DISPLAY |
| 51 | ACTIVE/CNN PENDING |
| 60 | ACTIVE |
| 61 | ACTIVE/DETACHED |
| 62 | ACTIVE/SOURCE |
| 63 | ACTIVE READER |
| 64 | ACTIVE/TARGET |
| 65 | ACTIVE/ALLOCATE |
| 66 | ACTIVE WRITER |
| 67 | AVAILABLE |
| 68 | UNAVAILABLE |
| 70 | HELD |
| 71 | HELD/DETACHED |
| 72 | HELD/SOURCE |
| 73 | HELD/TARGET |
| 74 | HELD/ALLOCATE |
| 75 | POWERED OFF |
| 80 | RCYPND |
| 81 | RCYPND/DETACHED |
| 82 | RCYPND/SOURCE |
| 83 | RCYPND/TARGET |
| 84 | RCYPND/ALLOCATE |
| 90 | RCYCNL |
| 91 | RCYCNL/DETACHED |
| 92 | RCYCNL/SOURCE |
| 93 | RCYCNL/TARGET |
| 94 | RCYCNL/ALLOCATE |
| 95 | SYSTEM REQUEST |
| 96 | REBUILD |
| 100 | FAILED |
| 101 | FAILED/DETACHED |
| 102 | FAILED/SOURCE |
| 103 | FAILED READER |
| 104 | FAILED/TARGET |
| 105 | FAILED/ALLOCATE |
| 106 | FAILED WRITER |
| 107 | SHUTDOWN |
| 110 | DIAGNOSTIC MODE |
| 111 | *DAMAGED |
| 112 | *LOCKED |
| 113 | *UNKNOWN |
| 114 | DEGRADED |
| 200 | INVALID STATUS |
Date information retrieved. The date that the information was provided by the API. This is returned as 7 characters in the form CYYMMDD, where:
| C | Century, where 0 indicates years 19xx and 1 indicates years 20xx. |
| YY | Year |
| MM | Month |
| DD | Day |
Entry length for list of active conversations. The entry length, in bytes, of each element in the list of active conversations returned with this format. A value of zero is returned if the list is empty.
Entry length for list of multiple jobs. The entry length, in bytes, of each element in the list of multiple jobs returned with this format. A value of zero is returned if the list is empty.
Job name. The name of the job associated with an active device, if applicable.
Job number. The job number portion of a fully qualified job name.
Multiple job name. The job name portion of the qualified job name for optical, media library, or network (*TEL type only) devices that are being used by more than one job.
Multiple job number. The job number portion of the qualified job name for optical, media library, or network (*TEL type only) devices that are being used by more than one job.
Multiple job user name. The user name portion of the qualified job name for optical, media library, or network (*TEL type only) devices that are being used by more than one job.
Number of active conversations. The number of entries in the list of active conversations returned with this format. A value of zero is returned if the list is empty.
Number of multiple jobs. The number of entries in the list of multiple jobs returned with this format. A value of zero is returned if the list is empty.
Offset to list of active conversations. The offset, in bytes, to the list of active conversations returned with this format. A value of zero is returned if the list is empty.
Offset to list of multiple job information. The offset, in bytes, to the list of multiple jobs returned with this format. A value of zero is returned if the list is empty.
Pass-through device. The name of an upstream device used to complete a pass-through session, if applicable.
Reserved. An ignored field.
Time information retrieved. The time that the information was provided by the API. It is returned as 6 characters in the form HHMMSS, where:
| HH | Hour |
| MM | Minute |
| SS | Second |
User name. The user name portion of a fully qualified job name.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF2625 E | Not able to allocate object &1. |
| CPF2634 E | Not authorized to object &1. |
| CPF26A8 E | Configuration description type not valid for this API. |
| CPF26AE E | Network server description &1 not found. |
| CPF2702 E | Device description &1 not found. |
| CPF2703 E | Controller description &1 not found. |
| CPF2704 E | Line description &1 not found. |
| CPF27A4 E | Network interface description &1 not found. |
| 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. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF8104 E | Controller description &4 damaged. |
| CPF8105 E | Device description &4 damaged. |
| CPF811D E | Network interface description &4 damaged. |
| CPF8125 E | Line description &4 damaged. |
| CPF814C E | Network server description &4 damaged. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
API introduced: V2R3