Retrieve Device Description (QDCRDEVD) API


  Required Parameter Group:

1 Receiver variable Output Char(*)
2 Length of receiver variable Input Binary(4)
3 Format name Input Char(8)
4 Device name Input Char(10)
5 Error Code I/O Char(*)

  Default Public Authority: *USE

  Threadsafe: Yes

The Retrieve Device Description (QDCRDEVD) API retrieves information about a device description.


Authorities and Locks

Device Description Authority
*USE
Device Description Lock
*EXCLRD

Required Parameter Group

Receiver variable
OUTPUT; CHAR(*)

The variable that is to receive the device information.

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 will be truncated to this length.

Format name
INPUT; CHAR(8)

The content and format of the information returned for each device description. The possible format names are:

DEVD0100 Basic device information.
DEVD0200 Detailed information for device category *APPC
DEVD0300 Detailed information for device category *ASC
DEVD0400 Detailed information for device category *BSC
DEVD0500 Detailed information for device category *DKT
DEVD0600 Detailed information for device category *DSP
DEVD0700 Detailed information for device category *FNC
DEVD0800 Detailed information for device category *HOST
DEVD0900 Detailed information for device category *INTR
DEVD1000 Detailed information for device category *NET
DEVD1100 Detailed information for device category *PRT
DEVD1200 Detailed information for device category *RTL
DEVD1300 Detailed information for device category *SNPT
DEVD1400 Detailed information for device category *SNUF
DEVD1500 Detailed information for device category *TAP
DEVD1600 Detailed information for device category *OPT
DEVD1700 Detailed information for device category *MLB
DEVD1800 Detailed information for device category *CRP
DEVD1900 Detailed information for device category *ASP
Start of changeDEVD2000 Detailed information for device category *NWSHEnd of change

See Format of Device Information for a description of these formats.

Device name
INPUT; CHAR(10)

The name of the device description to be 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 Device Information

When the device category is unknown, specify DEVD0100 and the basic information (including device category) will be returned. When the device category is known, specify one of the other category-specific formats.

For detailed descriptions of the fields returned in these formats, see Field Descriptions.


DEVD0100 Format

Use this format to find out the device category, plus some basic information about the device. Then you may use the returned device category to select one of the other (category-specific) formats to call the API again for detailed information about the device description.

Offset Type Field
Dec Hex
0 0 BINARY(4) Bytes returned
4 4 BINARY(4) Bytes available
8 8 CHAR(7) Date information retrieved
15 F CHAR(6) Time information retrieved
21 15 CHAR(10) Device name
31 1F CHAR(10) Device category
41 29 CHAR(10) Online at IPL
51 33 CHAR(50) Text description
101 65 CHAR(3) Reserved


DEVD0200 Format

This format returns detailed information about a device of category *APPC.

Offset Type Field
Dec Hex
0 0   Returns everything from format DEVD0100
104 68 BINARY(4) Offset to list of mode names
108 6C BINARY(4) Number of mode names
112 70 BINARY(4) Entry length for list of mode names
116 74 CHAR(10) Remote location name
126 7E CHAR(10) Local location name
136 88 CHAR(10) Remote network identifier
146 92 CHAR(10) Attached nonswitched controller name
156 9C CHAR(10) Message queue: name
166 A6 CHAR(10) Message queue: library
176 B0 CHAR(10) Local location address
186 BA CHAR(10) APPN capable
196 C4 CHAR(10) Single session: indication
206 CE CHAR(10) Single session: number of conversations
216 D8 CHAR(10) Locally controlled session
226 E2 CHAR(10) Pre-established session
236 EC CHAR(10) Secure location
246 F6 CHAR(10) Automatically configured
256 100 BINARY(4) Offset to list of active modes
260 104 BINARY(4) Number of active modes
264 108 BINARY(4) Entry length for list of active modes
268 10C CHAR(10) Current message queue: name
278 116 CHAR(10) Current message queue: library
These fields repeat for each mode name CHAR(10) Mode name
CHAR(2) Reserved
These fields repeat for each active mode CHAR(10) Mode name
CHAR(10) Allocated by job name
CHAR(10) Allocated by user name
CHAR(6) Allocated by job number


DEVD0300 Format

This format returns detailed information about a device of category *ASC.

Offset Type Field
Dec Hex
0 0   Returns everything from format DEVD0100
104 68 CHAR(10) Remote location name
114 72 CHAR(10) Attached nonswitched controller name
124 7C CHAR(10) Allocated by job name
134 86 CHAR(10) Allocated by user name
144 90 CHAR(6) Allocated by job number
150 96 CHAR(10) Current message queue: name
160 A0 CHAR(10) Current message queue: library


DEVD0400 Format

This format returns detailed information about a device of category *BSC.

Offset Type Field
Dec Hex
0 0   Returns everything from format DEVD0100
104 68 BINARY(4) Record length
108 6C BINARY(4) Block length
112 70 CHAR(10) Local location address
122 7A CHAR(10) Remote location name
132 84 CHAR(10) Attached nonswitched controller name
142 8E CHAR(10) Connection type
152 98 CHAR(10) Application type
162 A2 CHAR(10) Contention resolution winner
172 AC CHAR(10) Blocking type
182 B6 CHAR(10) Separator character
192 C0 CHAR(10) Remote BSCEL
202 CA CHAR(10) Transmit in transparent mode
212 D4 CHAR(10) Compress and decompress data
222 DE CHAR(10) Truncate trailing blanks
232 E8 CHAR(10) Group separator type
242 F2 CHAR(10) Emulated device
252 FC CHAR(10) Emulated keyboard
262 106 CHAR(10) Emulated numeric lock
272 110 CHAR(10) Emulated work station
282 11A CHAR(10) Allocated by job name
292 124 CHAR(10) Allocated by user name
302 12E CHAR(6) Allocated by job number
308 134 CHAR(10) Current message queue: name
318 13E CHAR(10) Current message queue: library


DEVD0500 Format

This format returns detailed information about a device of category *DKT.

Offset Type Field
Dec Hex
0 0   Returns everything from format DEVD0100
104 68 CHAR(10) Device type
114 72 CHAR(10) Device model
124 7C CHAR(10) Resource name


DEVD0600 Format

This format returns detailed information about a device of category *DSP.

Offset Type Field
Dec Hex
0 0   Returns everything from format DEVD0100
104 68 BINARY(4) Character identifier: graphic character set
108 6C BINARY(4) Character identifier: code page
112 70 BINARY(4) Maximum length of request unit
116 74 BINARY(4) Inactivity timer
120 78 BINARY(4) DBCS feature: RAM size
124 7C BINARY(4) Activation timer
128 80 BINARY(4) Switch setting
132 84 BINARY(4) Device port
136 88 BINARY(4) Maximum outstanding frames
140 8C BINARY(4) Idle timer
144 90 BINARY(4) NRM poll timer
148 94 BINARY(4) Frame retry
152 98 BINARY(4) Offset to list of auxiliary devices
156 9C BINARY(4) Number of auxiliary devices
160 A0 BINARY(4) Entry length for list of auxiliary devices
164 A4 CHAR(10) Device class
174 AE CHAR(10) Device type
184 B8 CHAR(10) Device model
194 C2 CHAR(10) Local location address
204 CC CHAR(10) Attached nonswitched controller name
214 D6 CHAR(10) Keyboard language type
224 E0 CHAR(10) Drop line at signoff
234 EA CHAR(10) Allow blinking cursor
244 F4 CHAR(10) Print device
254 FE CHAR(10) Remote location name
264 108 CHAR(10) Local location name
274 112 CHAR(10) Remote network identifier
284 11C CHAR(10) Control session device description
294 126 CHAR(10) Associated printer: name
304 130 CHAR(10) Associated printer: remote network identifier
314 13A CHAR(10) Alternate printer: name
324 144 CHAR(10) Alternate printer: remote network identifier
334 14E CHAR(10) Output queue: name
344 158 CHAR(10) Output queue: library
354 162 CHAR(10) Printer
364 16C CHAR(10) Print file: name
374 176 CHAR(10) Print file: library
384 180 CHAR(10) Work station customizing object: name
394 18A CHAR(10) Work station customizing object: library
404 194 CHAR(10) Application type
414 19E CHAR(10) DBCS feature: matrix size
424 1A8 CHAR(10) DBCS feature: language ID
434 1B2 CHAR(10) DBCS feature: last code point
444 1BC CHAR(10) SNA pass-through device
454 1C6 CHAR(10) SNA pass-through group name
464 1D0 CHAR(10) Emulated device
474 1DA CHAR(10) Emulated device model
484 1E4 CHAR(10) Emulating ASCII device
494 1EE CHAR(10) Physical attachment
504 1F8 CHAR(10) Line speed
514 202 CHAR(10) Word length
524 20C CHAR(10) Parity type
534 216 CHAR(10) Stop bits
544 220 CHAR(20) ASCII terminal identifier
564 234 CHAR(10) Associated APPC device
574 23E CHAR(256) Host signon/logon command
830 33E CHAR(1) Pass-through indicator
831 33F CHAR(10) Automatically configured
841 349 CHAR(3) Reserved
844 34C BINARY(4) Shared session number
848 350 CHAR(10) Dependent location name
858 35A CHAR(1) Network protocol
859 35B CHAR(18) Network protocol address
877 36D CHAR(15) Internet Protocol (IP) internet address in dotted decimal form
892 37C CHAR(10) Allocated by job name
902 386 CHAR(10) Allocated by user name
912 390 CHAR(6) Allocated by job number
918 396 CHAR(10) Current message queue: name
928 3A0 CHAR(10) Current message queue: library
938 3AA CHAR(1) Server network protocol
939 3AB CHAR(18) Server network protocol address
957 3BD CHAR(15) Server Internet Protocol (IP) internet address in dotted decimal form
These fields repeat for each auxiliary device BINARY(4) Auxiliary device address
CHAR(10) Auxiliary device type
CHAR(2) Reserved


DEVD0700 Format

This format returns detailed information about a device of category *FNC.

Offset Type Field
Dec Hex
0 0   Returns everything from format DEVD0100
104 68 BINARY(4) Maximum length of request unit
108 6C BINARY(4) Inactivity timer
112 70 BINARY(4) Activation timer
116 74 CHAR(10) Device type
126 7E CHAR(10) Local location address
136 88 CHAR(10) Remote location name
146 92 CHAR(10) Attached nonswitched controller name
156 9C CHAR(10) Device class
166 A6 CHAR(10) SNA pass-through device
176 B0 CHAR(10) SNA pass-through group name
186 BA CHAR(10) Allocated by job name
196 C4 CHAR(10) Allocated by user name
206 CE CHAR(6) Allocated by job number
212 D4 CHAR(10) Current message queue: name
222 DE CHAR(10) Current message queue: library


DEVD0800 Format

This format returns detailed information about a device of category *HOST.

Offset Type Field
Dec Hex
0 0   Returns everything from format DEVD0100
104 68 BINARY(4) Maximum length of request unit
108 6C CHAR(10) Local location address
118 76 CHAR(10) Remote location name
128 80 CHAR(10) Attached nonswitched controller name
138 8A CHAR(10) Application type
148 94 CHAR(10) Emulated device
158 9E CHAR(10) Emulated device model
168 A8 CHAR(10) Emulated keyboard
178 B2 CHAR(10) Emulated numeric lock
188 BC CHAR(10) Emulated work station
198 C6 CHAR(10) End session with host
208 D0 CHAR(10) Dependent location name
218 DA CHAR(10) Allocated by job name
228 E4 CHAR(10) Allocated by user name
238 EE CHAR(6) Allocated by job number
244 F4 CHAR(10) Current message queue: name
254 FE CHAR(10) Current message queue: library


DEVD0900 Format

This format returns detailed information about a device of category *INTR.

Offset Type Field
Dec Hex
0 0   Returns everything from format DEVD0100
104 68 CHAR(10) Remote location name
114 72 CHAR(10) Allocated by job name
124 7C CHAR(10) Allocated by user name
134 86 CHAR(6) Allocated by job number


DEVD1000 Format

This format returns detailed information about a device of category *NET.

Offset Type Field
Dec Hex
0 0   Returns everything from format DEVD0100
104 68 CHAR(10) Network type
114 72 CHAR(10) Attached nonswitched controller name
124 7C CHAR(10) Allocated by job name
134 86 CHAR(10) Allocated by user name
144 90 CHAR(6) Allocated by job number
150 96 CHAR(10) Current message queue: name
160 A0 CHAR(10) Current message queue: library


DEVD1100 Format

This format returns detailed information about a device of category *PRT.

Offset Type Field
Dec Hex
0 0   Returns everything from format DEVD0100
104 68 BINARY(4) Font identifier: integer value of point size
108 6C BINARY(4) Maximum length of request unit
112 70 BINARY(4) Pacing
116 74 BINARY(4) Maximum pending requests
120 78 BINARY(4) Print request timer
124 7C BINARY(4) Character identifier: graphic character set
128 80 BINARY(4) Character identifier: code page
132 84 BINARY(4) DBCS feature: RAM size
136 88 BINARY(4) Inactivity timer
140 8C BINARY(4) Activation timer
144 90 BINARY(4) Switch setting
148 94 BINARY(4) Device port
152 98 CHAR(10) Device class
162 A2 CHAR(10) Device type
172 AC CHAR(10) Device model
182 B6 CHAR(10) Advanced Function Printing
192 C0 CHAR(10) AFP attachment
202 CA CHAR(10) Local location address
212 D4 CHAR(10) Attached nonswitched controller name
222 DE CHAR(10) Font identifier: identifier
232 E8 CHAR(10) Form feed
242 F2 CHAR(10) Separator drawer
252 FC CHAR(10) Printer error message
262 106 CHAR(10) Message queue: name
272 110 CHAR(10) Message queue: library
282 11A CHAR(10) Application type
292 124 CHAR(10) Print while converting
302 12E CHAR(10) Form definition: name
312 138 CHAR(10) Form definition: library
322 142 CHAR(10) Work station customizing object: name
332 14C CHAR(10) Work station customizing object: library
342 156 CHAR(10) SNA remote location name
352 160 CHAR(10) Local location name
362 16A CHAR(10) Remote network identifier
372 174 CHAR(10) Control session device description
382 17E CHAR(10) Mode name
392 188 CHAR(10) DBCS feature: matrix size
402 192 CHAR(10) DBCS feature: language ID
412 19C CHAR(10) DBCS feature: last code point
422 1A6 CHAR(10) SNA pass-through device
432 1B0 CHAR(10) SNA pass-through group name
442 1BA CHAR(10) Emulated device
452 1C4 CHAR(10) Emulated device model
462 1CE CHAR(10) Emulating ASCII device
472 1D8 CHAR(10) Physical attachment
482 1E2 CHAR(10) Auxiliary printer
492 1EC CHAR(10) Language type
502 1F6 CHAR(10) Line speed
512 200 CHAR(10) Word length
522 20A CHAR(10) Parity type
532 214 CHAR(10) Stop bits
542 21E CHAR(10) Number of drawers
552 228 CHAR(10) Print quality
562 232 CHAR(10) Transform enabled
572 23C CHAR(20) Manufacturer type and model
592 250 CHAR(10) Paper source 1
602 25A CHAR(10) Paper source 2
612 264 CHAR(10) Envelope source
622 26E CHAR(10) ASCII code page 899 support
632 278 CHAR(10) Separator exit program: name
642 282 CHAR(10) Separator exit program: library
652 28C CHAR(256) Host signon/logon command
908 38C CHAR(10) Automatically configured
918 396 CHAR(2) Reserved
920 398 BINARY(4) Offset to list of switched lines
924 39C BINARY(4) Number of switched lines
928 3A0 BINARY(4) Entry length for list of switched lines
932 3A4 CHAR(12) Adapter address
944 3B0 CHAR(10) Adapter type
954 3BA CHAR(10) Adapter connection type
964 3C4 BINARY(4) Offset to list of user-defined options
968 3C8 BINARY(4) Number of user-defined options
972 3CC BINARY(4) Entry length for list of user-defined options
976 3D0 BINARY(4) Offset to user-defined data
980 3D4 BINARY(4) Length of user-defined data
984 3D8 CHAR(10) LAN attachment
994 3E2 CHAR(10) User-defined object name
1004 3EC CHAR(10) User-defined object library
1014 3F6 CHAR(10) User-defined object type
1024 400 CHAR(10) User driver program name
1034 40A CHAR(10) User driver program library
1044 414 CHAR(10) User-defined data transform program name
1054 41E CHAR(10) User-defined data transform program library
1064 428 CHAR(255) Remote location name
1319 527 CHAR(1) Reserved
1320 528 CHAR(10) Font identifier: real value of point size
1330 532 CHAR(10) Remote location name type
1340 53C CHAR(15) System driver program name
1355 54B CHAR(10) Reserved
1365 555 CHAR(10) Image configuration
1375 55F CHAR(10) Reserved
1385 569 CHAR(1) Network protocol
1386 56A CHAR(18) Network protocol address
1404 57C CHAR(15) Internet Protocol (IP) internet address in dotted decimal form
1419 58B CHAR(10) Dependent location name
1429 595 CHAR(10) Allocated by job name
1439 59F CHAR(10) Allocated by user name
1449 5A9 CHAR(6) Allocated by job number
1455 5AF CHAR(10) Current message queue: name
1465 5B9 CHAR(10) Current message queue: library
1475 5C3 CHAR(1) Server network protocol
1476 5C4 CHAR(18) Server network protocol address
1494 5D6 CHAR(15) Server Internet Protocol (IP) internet address in dotted decimal form
1509 5E5 CHAR(1) Reserved
1510 5E6 CHAR(10) Published printer
1520 5F0 BINARY(4) Offset to list of publishing information
1524 5F4 BINARY(4) Number of publishing list entries
1528 5F8 BINARY(4) Entry length for list of publishing information
1532 5FC CHAR(10) Use secure connection
1542 606 CHAR(10) Validation list: name
1552 610 CHAR(10) Validation list: library
1562 61A CHAR(2) Reserved
These fields repeat for each switched line CHAR(10) Switched line name
CHAR(2) Reserved
These fields repeat for each user-defined option CHAR(10) User-defined option
CHAR(2) Reserved
Variable- length string containing user-defined data CHAR(*) User-defined data
These fields repeat for each publishing list entry CHAR(10) Duplex supported
CHAR(10) Color supported
BINARY(4) Pages per minute black
BINARY(4) Pages per minute color
CHAR(30) Location
CHAR(2) Reserved
BINARY(4) Offset to list of data stream formats supported
BINARY(4) Number of data stream formats supported
BINARY(4) Entry length for data stream format supported
These fields repeat for each data stream format supported CHAR(10) Data stream supported
CHAR(2) Reserved


DEVD1200 Format

This format returns detailed information about a device of category *RTL.

Offset Type Field
Dec Hex
0 0   Returns everything from format DEVD0100
104 68 BINARY(4) Pacing
108 6C BINARY(4) Maximum length of request unit
112 70 BINARY(4) Inactivity timer
116 74 BINARY(4) Activation timer
120 78 CHAR(10) Local location address
130 82 CHAR(10) Remote location name
140 8C CHAR(10) Attached nonswitched controller name
150 96 CHAR(10) Application type
160 A0 CHAR(10) Device class
170 AA CHAR(10) SNA pass-through device
180 B4 CHAR(10) SNA pass-through group name
190 BE CHAR(10) Allocated by job name
200 C8 CHAR(10) Allocated by user name
210 D2 CHAR(6) Allocated by job number
216 D8 CHAR(10) Current message queue: name
226 E2 CHAR(10) Current message queue: library


DEVD1300 Format

This format returns detailed information about a device of category *SNPT.

Offset Type Field
Dec Hex
0 0   Returns everything from format DEVD0100
104 68 BINARY(4) Activation timer
108 6C CHAR(10) Local location address
118 76 CHAR(10) SNA pass-through class
128 80 CHAR(10) Attached nonswitched controller name
138 8A CHAR(10) SNA pass-through device
148 94 CHAR(10) SNA pass-through group name
158 9E CHAR(10) Dependent location name
168 A8 CHAR(10) Allocated by job name
178 B2 CHAR(10) Allocated by user name
188 BC CHAR(6) Allocated by job number
194 C2 CHAR(10) Current message queue: name
204 CC CHAR(10) Current message queue: library


DEVD1400 Format

This format returns detailed information about a device of category *SNUF.

Offset Type Field
Dec Hex
0 0   Returns everything from format DEVD0100
104 68 BINARY(4) Record length
108 6C BINARY(4) Block length
112 70 CHAR(10) Local location address
122 7A CHAR(10) Remote location name
132 84 CHAR(10) Attached nonswitched controller name
142 8E CHAR(10) Program start request capable
152 98 CHAR(10) Special host application
162 A2 CHAR(10) Application identifier
172 AC CHAR(10) Host type
182 B6 CHAR(10) Default program: name
192 C0 CHAR(10) Default program: library
202 CA CHAR(10) HCP emulation
212 D4 CHAR(10) Dependent location name
222 DE CHAR(10) Allocated by job name
232 E8 CHAR(10) Allocated by user name
242 F2 CHAR(6) Allocated by job number
248 F8 CHAR(10) Current message queue: name
258 102 CHAR(10) Current message queue: library


DEVD1500 Format

This format returns detailed information about a device of category *TAP.

Offset Type Field
Dec Hex
0 0   Returns everything from format DEVD0100
104 68 BINARY(4) Reserved
108 6C CHAR(10) Device type
118 76 CHAR(10) Device model
128 80 CHAR(10) Resource name
138 8A CHAR(10) Message queue: name
148 94 CHAR(10) Message queue: library
158 9E CHAR(10) Attached nonswitched controller name
168 A8 CHAR(10) Assign device at vary on
178 B2 CHAR(10) Unload device at vary off
188 BC CHAR(10) Allocated by job name
198 C6 CHAR(10) Allocated by user name
208 D0 CHAR(6) Allocated by job number


DEVD1600 Format

This format returns detailed information about a device of category *OPT.

Offset Type Field
Dec Hex
0 0   Returns everything from format DEVD0100
104 68 CHAR(10) Device type
114 72 CHAR(10) Device model
124 7C CHAR(10) Resource name
134 86 CHAR(10) Message queue: name
144 90 CHAR(10) Message queue: library


DEVD1700 Format

This format returns detailed information about a device of category *MLB.

Offset Type Field
Dec Hex
0 0   Returns everything from format DEVD0100
104 68 BINARY(4) Offset to list of drive resources
108 6C BINARY(4) Number of drive resources
112 70 BINARY(4) Entry length for list of drive resources
116 74 BINARY(4) Unload wait time
120 78 BINARY(4) Maximum device time
124 7C CHAR(10) Device class
134 86 CHAR(10) Device type
144 90 CHAR(10) Device model
154 9A CHAR(10) Resource name
164 A4 CHAR(10) Message queue: name
174 AE CHAR(10) Message queue: library
184 B8 CHAR(10) Generate cartridge identifiers
194 C2 CHAR(10) First robot device description
204 CC BINARY(4) Resource allocation priority
208 D0 BINARY(4) Initial mount wait time
212 D4 BINARY(4) End of volume mount wait time
216 D8 BINARY(4) Offset to list of robot device descriptions
220 DC BINARY(4) Number of robot device descriptions
224 E0 BINARY(4) Entry length for list of robot device descriptions
228 E4 BINARY(4) Offset to list of robot hosts
232 E8 BINARY(4) Number of robot hosts
236 EC BINARY(4) Entry length for list of robot hosts
240 F0 CHAR(45) Internet address
285 11D CHAR(3) Reserved
These fields repeat for each drive resource CHAR(10) Drive resource name
CHAR(20) Drive resource text allocation
CHAR(2) Reserved
BINARY(4) Drive resource numeric allocation
CHAR(20) Drive resource text status
BINARY(4) Drive resource numeric status
These fields repeat for each robot device description CHAR(10) Robot device description
These fields repeat for each robot host CHAR(255) Robot host
CHAR(1) Reserved


DEVD1800 Format

This format returns detailed information about a device of category *CRP.

Offset Type Field
Dec Hex
0 0   Returns everything from format DEVD0100
104 68 CHAR(10) Device type
114 72 CHAR(10) Resource name
124 7C CHAR(10) Message queue: name
134 86 CHAR(10) Message queue: library
144 90 CHAR(10) PKA key store file: name
154 9A CHAR(10) PKA key store file: library
164 A4 CHAR(10) DES key store file: name
174 AE CHAR(10) DES key store file: library
184 B8 CHAR(10) Allocated by job name
194 C2 CHAR(10) Allocated by user name
204 CC CHAR(6) Allocated by job number
210 D2 CHAR(10) Current message queue: name
220 DC CHAR(10) Current message queue: library
230 E6 CHAR(10) Device model
240 FA CHAR(10) Application type


DEVD1900 Format

This format returns detailed information about a device of category *ASP.

Offset Type Field
Dec Hex
0 0   Returns everything from format DEVD0100
104 68 CHAR(10) Resource name
114 72 CHAR(10) Message queue: name
124 7C CHAR(10) Message queue: library
134 86 CHAR(10) Current message queue: name
144 90 CHAR(10) Current message queue: library
154 9A CHAR(18) Relational database name


Start of change DEVD2000 Format

This format returns detailed information about a device of category *NWSH.

Offset Type Field
Dec Hex
0 0   Returns everything from format DEVD0100
104 68 CHAR(10) Resource name
114 72 CHAR(2) Reserved
116 74 BINARY(4) Offset to list of local interfaces
120 78 BINARY(4) Number of local interfaces
124 7C BINARY(4) Length of local interface entries
128 80 CHAR(10) Message queue: name
138 8A CHAR(10) Message queue: library
148 94 CHAR(10) Current message queue: name
158 9E CHAR(10) Current message queue: library
168 A8 BINARY(4) Recovery limits: count limit
172 AC BINARY(4) Recovery limits: time interval
176 B0 BINARY(4) Offset to list of file server storage entries
180 B4 BINARY(4) Number of file server storage entries
184 B8 BINARY(4) Length of file server storage entries
188 BC BINARY(4) Offset to list of virtual Ethernet entries
192 C0 BINARY(4) Number of virtual Ethernet entries
196 C4 BINARY(4) Length of virtual Ethernet entries
200 C8 BINARY(4) Number of file server storage resources supported
204 CC BINARY(4) Number of virtual Ethernet resources supported
These fields repeat for each local interface CHAR(15) Subnet mask
CHAR(1) Reserved
BINARY(4) Port speed
BINARY(4) Current port speed
CHAR(10) Duplex
CHAR(10) Current duplex
CHAR(15) Local SCSI internet address
CHAR(15) Local SCSI gateway address
CHAR(6) Reserved
BINARY(4) SCSI TCP port
CHAR(12) Local SCSI adapter address
CHAR(15) Local LAN internet address
CHAR(15) Local LAN gateway address
CHAR(2) Reserved
BINARY(4) Virtual Ethernet base UDP port
BINARY(4) Virtual Ethernet upper UDP port
CHAR(12) Local LAN adapter address
These fields repeat for each file server storage entry CHAR(8) Network server name
CHAR(10) Active file server storage resource
These fields repeat for each virtual Ethernet entry CHAR(10) Line name
CHAR(10) Active virtual Ethernet resource
CHAR(8) Associated network server name
End of change

Field Descriptions

Some of the fields in the various formats returned by this API are described in greater detail in the Control Language (CL) information for the particular command that was used to create the device description object. They are also described in the online help for the particular command. For these fields, the CL parameter keyword is specified in parentheses following the field name. The CL command name is specified in the field description.

In certain cases, numeric values are assigned by this API to represent character values for some of the returned fields. Where a numeric value is assigned, the numeric value and the equivalent character value are listed as an Exception in the following field descriptions.

Activation timer (ACTTMR). The number of seconds that the system should wait for the device to respond to an activation request from the host. (See the ACTTMR parameter in the Control Language (CL) information for the CRTDEVDSP, CRTDEVFNC, CRTDEVPRT, or CRTDEVRTL command.)

Start of changeActive file server storage resource. The name of a file server storage resource that is in use by a network server (NWSD).

Active virtual Ethernet resource. The name of a virtual Ethernet resource that is in use by an Ethernet line. End of change

Adapter address. The remote adapter address for an ASCII printer directly attached to the LAN.

Adapter connection type. The adapter connection type for an ASCII printer directly attached to the LAN.

Adapter type. The adapter type for an ASCII printer directly attached to the LAN.

Advanced Function Printing (AFP). Whether this printer is used for Advanced Function Printing(TM) support. (See the AFP(TM) parameter in the Control Language (CL) information for the CRTDEVPRT command.)

AFP attachment (AFPATTACH). The type of attachment that is used for printers that are configured for Advanced Function Printing support. (See the AFPATTACH parameter in the Control Language (CL) information for the CRTDEVPRT command.)

Allocated by job name. The name portion of the qualified job name of the job that has allocated this device description. The value *NONE indicates that this device is not allocated by a job.

Allocated by job number. The number portion of the qualified job name of the job that has allocated this device description.

Allocated by user name. The user name portion of the qualified job name of the job that has allocated this device description.

Allow blinking cursor (ALWBLN). Whether or not the cursor will blink for display devices. (See the ALWBLN parameter in the Control Language (CL) information for the CRTDEVDSP command.)

Alternate printer name. The name of the secondary printer that is specified for a session.

Alternate printer remote network identifier (RMTNETID). The name of the remote network identifier that is specified for the alternate printer. (See the RMTNETID parameter in the Control Language (CL) information for the CRTDEVAPPC, CRTDEVDSP, or CRTDEVPRT command.)

Application identifier (APPID). The VTAM(R) application identifier of the CICS/VS or IMS/VS host subsystem with which the iSeries server communicates. (See the APPID parameter in the Control Language (CL) information for the CRTDEVSNUF command.)

Application type (APPTYPE). The application type this device uses. (See the APPTYPE parameter in the Control Language (CL) information for the CRTDEVBSC, CRTDEVCRP, CRTDEVDSP, CRTDEVHOST, CRTDEVPRT, or CRTDEVRTL command.)

APPN capable (APPN). Whether or not networking is used. (See the APPN parameter in the Control Language (CL) information for the CRTDEVAPPC command.)

ASCII code page 899 support. Whether this printer has ASCII code page 899 installed.

ASCII terminal identifier. A user-specified terminal identifier for the physical device.

Assign device at vary on (ASSIGN). Whether the tape device is assigned to the system when it is varied on. (See the ASSIGN parameter in the Control Language (CL) information for the CRTDEVTAP command.)

Associated APPC device. The name of an APPC device associated with a display station.

Start of changeAssociated network server name (NWSD). The name of a network server description associated with an Ethernet line that is actively using a virtual Ethernet resource.End of change

Associated printer name. The name of the primary printer that is specified for a session.

Associated printer remote network identifier (RMTNETID). The name of the remote network identifier that is specified for the associated printer. (See the RMTNETID parameter in the Control Language (CL) information for the CRTDEVAPPC, CRTDEVDSP, or CRTDEVPRT command.)

Attached nonswitched controller name (CTL). The name of the controller description to which this device is attached. (See the CTL parameter in the Control Language (CL) information for the CRTDEVAPPC, CRTDEVASC, CRTDEVBSC, CRTDEVDSP, CRTDEVFNC, CRTDEVHOST, CRTDEVNET, CRTDEVPRT, CRTDEVRTL, CRTDEVSNPT, CRTDEVSNUF, or CRTDEVTAP command.)

Automatically configured. Whether this device has been configured automatically.

Auxiliary device address (AUXDEV). The address of an additional device attached to an IEEE-48 port on this device. (See the AUXDEV parameter in the Control Language (CL) information for the CRTDEVDSP command.)

Auxiliary device type (AUXDEV). The type of additional device attached to an IEEE-48 port on this device. (See the AUXDEV parameter in the Control Language (CL) information for the CRTDEVDSP command.)

Auxiliary printer. For ASCII printers, whether the printer is attached to a display station.

Block length (BLKLEN). The maximum block length (in bytes) for data to be transmitted when communicating with this device. (See the BLKLEN parameter in the Control Language (CL) information for the CRTDEVBSC or CRTDEVSNUF command.)

Blocking type (BLOCK). Whether you or the iSeries server will block and deblock transmitted records. (See the BLOCK parameter in the Control Language (CL) information for the CRTDEVBSC command.)

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.

Character identifier (CHRID). The character identifier that this display station supports. This identifier has two parts, which are returned in separate fields:

(See the CHRID parameter in the Control Language (CL) information for the CRTDEVDSP or CRTDEVPRT command.)

Exceptions:

Color supported (PUBLISHINF). Whether the printer device supports color ink printing. (See the PUBLISHINF parameter in the Control Language (CL) information for the CRTDEVPRT command.)

Compress and decompress data (DTACPR). Whether or not to have blanks in BSC data compressed for output and decompressed for input. (See the DTACPR parameter in the Control Language (CL) information for the CRTDEVBSC command.)

Connection type (CNN). The connection type. (See the CNN parameter in the Control Language (CL) information for the CRTDEVBSC command.)

Contention resolution winner (CTNWIN). Which BSC system is to be the primary unit and which is to be the secondary unit for contention resolution on a BSC line. (See the CTNWIN parameter in the Control Language (CL) information for the CRTDEVBSC command.)

Control session device description. Which control session device description created or selected a specific device description that is being used in a session.

Start of change Current duplex. The actual duplex mode being used by the physical port described by a network server host adapter local interface (LCLIFC). In half duplex, communication flow must alternate between sending and receiving. With full duplex, simultaneous send and receive operations may occur. A value of *AUTO is returned if the network server host adapter device is varied off. (See the LCLIFC parameter in the Control Language (CL) information for the CRTDEVNWSH command.)

Note: The value *AUTO is valid until the device is varied on. After the device is varied on, *AUTO is resolved to either *HALF or *FULL. End of change

Current message queue (MSGQ). The message queue to which messages are currently being sent using this device description. This field is valid only for devices that are varied on. Note that the value of the current message queue may be different from the message queue field (MSGQ parameter) under certain error conditions. (See the MSGQ parameter in the Control Language (CL) information for the CRTDEVAPPC, CRTDEVASP, CRTDEVCRP, CRTDEVMLB, Start of change CRTDEVNWSH, End of change CRTDEVOPT, CRTDEVPRT, or CRTDEVTAP command.) This information is returned in two separate fields:

Start of changeCurrent port speed. The actual speed of the physical port described by a network server host adapter local interface (LCLIFC). This value is determined by the hardware. (See the LCLIFC parameter in the Control Language (CL) information for the CRTDEVNWSH command.)

Exceptions:

Note: The value *AUTO is valid until the network server host adapter device is varied on. After the device is varied on, *AUTO is resolved to a discrete port speed.

End of change

Data stream supported. A data stream format supported by this printer device. (See the PUBLISHINF parameter in the Control Language (CL) information for the CRTDEVPRT command.)

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

DBCS feature (IGCFEAT). The values that should be specified for DBCS display stations and printers. This information is returned in four separate fields:

(See the IGCFEAT parameter in the Control Language (CL) information for the CRTDEVDSP or CRTDEVPRT command.)

Default program (DFTPGM). The program to be called if a program start request is received from a host system that is not using an *EXEC/*EXEX/*TXTC/*TXTX format. This information is returned in two separate fields:

(See the DFTPGM parameter in the Control Language (CL) information for the CRTDEVSNUF command.)

DES key store file (DESKEYFILE). The name of the key store file containing the data encryption standard (DES) keys to be used with this cryptographic device. (See the DESKEYFILE parameter in the Control Language (CL) information for the CRTDEVCRP command.) This information is returned in two separate fields:

Dependent location name (DEPLOCNAME). The dependent logical location name that is used for the dependent-logical-unit requester (DLUR), which provides additional security for the connection. (See the DEPLOCNAME parameter in the Control Language (CL) information for the CRTDEVDSP, CRTDEVHOST, CRTDEVPRT, CRTDEVSNPT, or CRTDEVSNUF command.)

Device category. This value will be one of the following:

*APPC
*ASC
*ASP
*BSC
*CRP
*DKT
*DSP
*FNC
*HOST
*INTR
*MLB
*NET
Start of change*NWSHEnd of change
*OPT
*PRT
*RTL
*SNPT
*SNUF
*TAP

The category value is derived from the command used to create the device description.

Device class (DEVCLS). The class of the device. (See the DEVCLS parameter in the Control Language (CL) information for the CRTDEVDSP, CRTDEVFNC, CRTDEVMLB, CRTDEVPRT, or CRTDEVRTL command.)

Device model (MODEL). The model number of the device. (See the MODEL parameter in the Control Language (CL) information for the CRTDEVDSP, CRTDEVPRT, or CRTDEVTAP command.)

Device name (DEVD). The name of the device description. (See the DEVD parameter in the Control Language (CL) information for the CRTDEVAPPC, CRTDEVASC, CRTDEVASP, CRTDEVBSC, CRTDEVCRP, CRTDEVDSP, CRTDEVFNC, CRTDEVHOST, CRTDEVINTR, CRTDEVMLB, CRTDEVNET, Start of change CRTDEVNWSH, End of change CRTDEVOPT, CRTDEVPRT, CRTDEVRTL, CRTDEVSNPT, CRTDEVSNUF, or CRTDEVTAP command.)

Device port (PORT). The identification of the port to which this device is currently attached. (See the PORT parameter in the Control Language (CL) information for the CRTDEVDSP or CRTDEVPRT command.)

Device type (TYPE). The type of device this description represents.

Exception:

(See the TYPE parameter in the Control Language (CL) information for the CRTDEVDSP, CRTDEVFNC, CRTDEVMLB, CRTDEVNET, CRTDEVOPT, CRTDEVPRT, or CRTDEVTAP command.)

Drive resource name (RSRCNAME). The resource name of a drive within this library. (See the RSRCNAME parameter in the Control Language (CL) information for the CRTDEVMLB command.)

Drive resource numeric allocation. A numeric value that represents the drive's current allocation.

Numeric Allocation (Decimal) Text Allocation
1 OPERATIONAL
5 DEALLOCATED
6 UNPROTECTED
7 ALLOCATED
100 FAILED

Drive resource text allocation. A text value that represents the current allocation of the drive within this library. Possible values are allocated, deallocated, unprotected, operational, and failed.

Note: The displayable text is translated when it is returned. This text is retrieved from message CPX2651 in message file QCPFMSG in library *LIBL.

Drive resource numeric status. A numeric value that represents the drive's current status.

Numeric Status (Decimal) Text Status
1 OPERATIONAL
60 ACTIVE
68 UNAVAILABLE
100 FAILED

Drive resource text status. A text value that represents the current status of the drive within this library. Possible values are operational, active, unavailable and failed.

Note: The displayable text is translated when it is returned. This text is retrieved from message CPX2651 in message file QCPFMSG in library *LIBL.

Drop line at signoff (DROP). Whether display stations attached to controllers on switched lines will be disconnected by the system when all work stations on the line are no longer being used. (See the DROP parameter in the Control Language (CL) information for the CRTDEVDSP command.)

Start of change Duplex. Whether the physical port described by a network server host adapter local interface (LCLIFC) is able to send and receive data simultaneously. With *AUTO, the duplex value will be determined by the hardware. (See the LCLIFC parameter in the Control Language (CL) information for the CRTDEVNWSH command.) End of change

Duplex supported (PUBLISHINF). Whether the printer device supports duplex printing. (See the PUBLISHINF parameter in the Control Language (CL) information for the CRTDEVPRT command.)

Emulated device (EMLDEV). The type of device that is to be emulated. For devices of category *DSP and *PRT, this is a twinaxial device. For devices of category *HOST, this is a 3270 device. (See the EMLDEV parameter in the Control Language (CL) information for the CRTDEVBSC, CRTDEVDSP, CRTDEVHOST, or CRTDEVPRT command.)

Emulated device model. The model of the device type that is to be emulated.

Emulated keyboard (EMLKBD). The type of 3278 display keyboard that is to be emulated. (See the EMLKBD parameter in the Control Language (CL) information for the CRTDEVBSC or CRTDEVHOST command.)

Emulated numeric lock (EMLNUMLCK). Whether numeric input fields allow only numeric data on a 5250 keyboard. (See the EMLNUMLCK parameter in the Control Language (CL) information for the CRTDEVBSC or CRTDEVHOST command.)

Emulated work station (EMLWRKSTN). The name of an emulated device associated with a real display station or printer device. (See the EMLWRKSTN parameter in the Control Language (CL) information for the CRTDEVBSC or CRTDEVHOST command.)

Emulating ASCII device (EMLASCII). Whether this device emulates a supported ASCII device type. (See the EMLASCII parameter in the Control Language (CL) information for the CRTDEVDSP or CRTDEVPRT command.)

End of volume mount wait time (EOVMNTWAIT). The maximum amount of time a request will wait for allocation of a tape resource for the end of volume mount. (See the EOVMNTWAIT parameter in the Control Language (CL) information for the CRTDEVMLB command.)

Exceptions:

End session with host. Whether a request-shutdown or unbind will be used to end a session.

Entry length for list of active modes. The entry length in bytes of each element in the list of active modes that are returned with this format. A value of zero is returned if the list is empty.

Entry length for list of auxiliary devices. The entry length in bytes of each element in the list of auxiliary devices returned with this format. A value of zero is returned if the list is empty.

Entry length for data stream format supported. The entry length in bytes of each element in the list of data streams supported.

Entry length for list of drive resources. The entry length in bytes of each element in the list of drive resources.

Entry length for list of mode names. The entry length in bytes of each element in the list of mode names returned with this format. A value of zero is returned if the list is empty.

Entry length for list of publishing information. The entry length in bytes of each element in the list of publishing information. A value of zero is returned if the list is empty.

Entry length for list of robot device descriptions. The entry length in bytes of each element in the list of robot device descriptions.

Entry length for list of robot hosts. The entry length in bytes of each element in the list of robot hosts.

Entry length for list of switched lines. The entry length in bytes of each element in the list of switched lines returned with this format. A value of zero is returned if the list is empty.

Entry length for list of user-defined options. The entry length in bytes of each element in the list of user-defined options returned with this format.

Envelope source (ENVELOPE). The type of envelope to be used in paper source three. (See the ENVELOPE parameter in the Control Language (CL) information for the CRTDEVPRT command.)

First robot device description (ROBOTDEV). For a library device with a robot, the name of the device description used to communicate with the robot. This field always contains the first robot device. For a list of the robot device description, see the robot device description field for this format. For an explanation of robots in library devices, see the Local Device Configuration Link to PDF book. (See the ROBOTDEV parameter in the Control Language (CL) information for the CRTDEVMLB command.)

Font identifier (FONT). The font identifier and point size that are used by *IPDS, 3812, and 5219 printers. This information is returned in separate fields:

(See the FONT parameter in the Control Language (CL) information for the CRTDEVPRT command.)

Exception:

Form definition (FORMDF). The form definition to be used for print requests that do not specify a form definition. This information is returned in two separate fields:

(See the FORMDF parameter in the Control Language (CL) information for the CRTDEVPRT command.)

Form feed (FORMFEED). The mode in which forms are fed into the *IPDS, 4212, or 5219 printers. (See the FORMFEED parameter in the Control Language (CL) information for the CRTDEVPRT command.)

Frame retry (FRAMERTY). The number of retries for an unanswered command frame or an unacknowledged information frame. (See the FRAMERTY parameter in the Control Language (CL) information for the CRTDEVDSP command.)

Generate cartridge IDs (GENCTGID). For tape library devices without bar-code readers, indicates how cartridge identifiers are generated. Possible values are as follows:

(See the GENCTGID parameter in the Control Language (CL) information for the CRTDEVMLB command.) For an explanation of cartridge identifiers, see the Local Device Configuration Link to PDF book.

Group separator type (GRPSEP). The separator for groups of data (data sets, documents, and so forth). (See the GRPSEP parameter in the Control Language (CL) information for the CRTDEVBSC command.)

HCP emulation (HCPEML). The type of host command processor emulated session that this device description will be used for. (See the HCPEML parameter in the Control Language (CL) information for the CRTDEVSNUF command.)

Host signon/logon command (LOGON). The logon string that is sent to the host network when the file is opened. (See the LOGON parameter in the Control Language (CL) information for the CRTDEVDSP or CRTDEVPRT command.)

Host type (HOST). The type of host system with which the device will communicate. (See the HOST parameter in the Control Language (CL) information for the CRTDEVSNUF command.)

Idle timer (IDLTMR). The time that the system waits for a response. (See the IDLTMR parameter in the Control Language (CL) information for the CRTDEVDSP command.)

Image configuration (IMGCFG). The transform services for a variety of image and print data-stream formats. (See the IMGCFG parameter in the Control Language (CL) information for the CRTDEVPRT command.)

Inactivity timer (INACTTMR). The amount of time the device can be inactive before the session is ended. (See the INACTTMR parameter in the Control Language (CL) information for the CRTDEVDSP, CRTDEVFNC, CRTDEVPRT, or CRTDEVRTL command.)

Exceptions:

Initial mount wait time (INLMNTWAIT). The maximum amount of time a request will wait for allocation of a tape resource for the initial mount. (See the INLMNTWAIT parameter in the Control Language (CL) information for the CRTDEVMLB command.)

Exceptions:

Internet address (INTNETADR). Specifies the address of the TCP/IP interface that is used when starting TCP/IP support. (See the INTNETADR parameter in the Control Language (CL) information for the CRTDEVMLB command.)

Internet Protocol (IP) internet address in dotted decimal form. A 32-bit address usually written as 4 decimal numbers, each representing 8 bits of the address. An example internet address is 128.12.28.43.

Each system on the TCP/IP network is assigned a unique internet address that is used in all communications with the system.

Note: This field applies only to display or printer devices that are used by TELNET or TCP/IP over Twinax.

Keyboard language type (KBDTYPE). The 3-character keyboard type identified for type 3277, 3278, or 3279 display stations. (See the KBDTYPE parameter in the Control Language (CL) information for the CRTDEVDSP command.)

LAN attachment. The type of LAN attachment that is used when *LAN is specified for the device class (DEVCLS) parameter.

Language type. The keyboard language type for an ASCII printer.

Start of changeLength of file server storage entries. The length in bytes of each element in the list of file server storage entries. A value of zero is returned if the list of file server storage entries is empty.

Length of local interface entries. The length in bytes of each element in the list of local interface entries. End of change

Length of user-defined data. The length, in bytes, of the user-defined data that is returned with this format. A value of zero is returned if no data exists.

Start of changeLength of virtual Ethernet entries. The length in bytes of each element in the list of virtual Ethernet entries. A value of zero is returned if the list of virtual Ethernet entries is empty.

Line name. The name of an Ethernet line description that is actively using a virtual Ethernet resource. End of change

Line speed (LINESPEED). A line speed for use with this device. (See the LINESPEED parameter in the Control Language (CL) information for the CRTDEVDSP or CRTDEVPRT command.)

Start of changeLocal interface (LCLIFC). The local interface values specific to a network server host adapter. The information includes a subnet mask, configured port speed, current port speed, duplex, current duplex, a local internet address associated with the adapter's Small Computer System Interface (SCSI), the default gateway address for the adapter's SCSI interface, a SCSI TCP port, a local SCSI adapter address, a local internet address associated with the adapter's LAN interface, the default gateway address for the adapter's LAN interface, a virtual Ethernet base UDP port, a virtual Ethernet upper UDP port and a local LAN adapter address. (See the LCLIFC parameter in the Control Language (CL) information for the CRTDEVNWSH command.)

Local LAN adapter address. The Ethernet adapter address of a network server host adapter local LAN interface. A value of *UNKNOWN is returned if the network server host adapter device is varied off. (See the LCLIFC parameter in the Control Language (CL) information for the CRTDEVNWSH command.)

Local LAN gateway address. The internet address of the gateway associated with a network server host adapter local LAN interface.(See the LCLIFC parameter in the Control Language (CL)information for the CRTDEVNWSH command.)

Local LAN internet address. The internet address of a network server host adapter local LAN interface.(See the LCLIFC parameter in the Control Language (CL) information for the CRTDEVNWSH command.) End of change

Local location address (LOCADR). The local location address. (See the LOCADR parameter in the Control Language (CL) information for the CRTDEVAPPC, CRTDEVBSC, CRTDEVDSP, CRTDEVFNC, CRTDEVHOST,CRTDEVPRT, CRTDEVRTL, CRTDEVSNPT, or CRTDEVSNUFcommand.)

Local location name (LCLLOCNAME). The name by which the local iSeries server is known to other devices in the network. (See the LCLLOCNAME parameter in the Control Language (CL) information for the CRTDEVAPPC, CRTDEVDSP, or CRTDEVPRT command.)

Start of changeLocal SCSI adapter address. The Ethernet adapter address of a network server host adapter local SCSI interface. A value of *UNKNOWN is returned if the network server host adapter device is varied off.(See the LCLIFC parameter in the Control Language (CL) information for the CRTDEVNWSH command.)

Local SCSI gateway address. The internet address of the gateway associated with a network server host adapter local SCSI interface.(See the LCLIFC parameter in the Control Language (CL) information for the CRTDEVNWSH command.)

Local SCSI internet address. The internet address of a network server host adapter local SCSI interface.(See the LCLIFC parameter in the Control Language (CL) information for the CRTDEVNWSH command.) End of change

Locally controlled session (LCLCTLSSN). Whether the single session is locally or remotely controlled. (See the LCLCTLSSN parameter in the Control Language (CL) information for the CRTDEVAPPC command.)

Location (PUBLISHINF). The location of the printer device. (See the PUBLISHINF parameter in the Control Language (CL) information for the CRTDEVPRT command.)

Manufacturer type and model (MFRTYPMDL). The manufacturer, type, and model for a printer using transform support. (See the MFRTYPMDL parameter in the Control Language (CL) information for the CRTDEVPRT command.)

Maximum device time (MAXDEVTIME). The maximum amount of time a volume can remain mounted in an internal device if there are requests for other volumes. (See the MAXDEVTIME parameter in the Control Language (CL) information for the CRTDEVMLB command.)

Exception:

Maximum length of request unit (MAXLENRU). The default maximum size of the request/response unit (RU) that can be sent or received by the local system if the maximum size is not specified in the bind command received from the host system. (See the MAXLENRU parameter in the Control Language (CL) information for the CRTDEVDSP, CRTDEVFNC, CRTDEVHOST, CRTDEVPRT, or CRTDEVRTL command.)

Exception:

Maximum outstanding frames (MAXOUT). The maximum number of frames that are sent to a remote system before it must respond. (See the MAXOUT parameter in the Control Language (CL) information for the CRTDEVDSP command.)

Maximum pending requests (MAXPNDRQS). The maximum number of print requests that can be queued for printers configured for Advanced Function Printing support. (See the MAXPNDRQS parameter in the Control Language (CL) information for the CRTDEVPRT command.)

Message queue (MSGQ). The message queue to which operational messages for this device should normally be sent. Note that this is the value entered on the MSGQ parameter of the CL command, but under error conditions for certain types of devices (APPC and Printer), it may not be the message queue currently in use. See the current message queue field to determine what message queue is actually being used at a given time. (See the MSGQ parameter in the Control Language (CL) information for the CRTDEVAPPC, CRTDEVASP, CRTDEVCRP, CRTDEVMLB, Start of change CRTDEVNWSH, End of change CRTDEVOPT, CRTDEVPRT, or CRTDEVTAP command.) This information is returned in two separate fields:

Mode name (MODE). The names used by the local iSeries server and the remote system to refer to the group of sessions between the local and remote locations with the same characteristics. (See the MODE parameter in the Control Language (CL) information for the CRTDEVAPPC or CRTDEVPRT command.)

Network protocol. The following defines the network protocol:

Note: This field applies only to display and printer devices that are used by TELNET.

Network protocol address. The network address is uniquely assigned to each system and is used in all communications with the system.

The following format defines the network address based on the network protocol:

Note: This field applies only to display and printer devices that are used by TELNET.

Start of changeNetwork server name (NWSD). The name of a network server description that is actively using a file server storage resource. End of change

Network type. The type of network the device represents.

NRM poll timer (NRMPOLLTMR). The time interval for polling this device in normal response mode. (See the NRMPOLLTMR parameter in the Control Language (CL) information for the CRTDEVDSP command.)

Number of active modes. The number of elements in the list of active modes that are returned with this format. A value of zero is returned if the list is empty.

Number of auxiliary devices. The number of elements in the list of auxiliary devices returned with this format. A value of zero is returned if the list is empty.

Number of data stream formats supported. The number of data stream formats supported by this printer device. A value of zero is returned if the list is empty.

Number of drawers. The number of drawers the printer physically supports, not which drawer the paper is selected from. The individual print files sent to the printer determine which drawer is selected.

Number of drive resources. The number of elements in the list of drive resources. A value of zero is returned if the list is empty.

Start of changeNumber of file server storage entries. The number of elements in the list of file server storage entries. A value of zero is returned if the list is empty.

Number of file server storage resources supported. The number of file server storage resources supported by the network server host adapter (NWSH).

Number of local interfaces. The number of elements in the list of local interfaces.End of change

Number of mode names. The number of elements in the list of mode names returned with this format. A value of zero is returned if the list is empty.

Number of publishing entries. The number of elements in the list of publishing entries. A value of zero is returned if the list is empty.

Number of robot device descriptions. The number of elements in the list of robot device descriptions. A value of zero is returned if the list is empty.

Number of robot hosts. The number of elements in the list of robot hosts. A value of zero is returned if the list is empty.

Number of switched lines. The number of entries in the list of switched lines returned with this format. A value of zero is returned if the list is empty.

Number of user-defined options. The number of elements in the list of user-defined options that is returned with this format. A value of zero is returned if the list is empty.

Start of changeNumber of virtual Ethernet entries. The number of elements in the list of virtual Ethernet entries. A value of zero is returned if the list is empty.

Number of virtual Ethernet resources supported. The number of virtual Ethernet resources supported by the network server host adapter (NWSH). End of change

Offset to list of active modes. The offset in bytes to the first element in the list of active modes that are returned with this format. A value of zero is returned if the list is empty.

Offset to list of auxiliary devices. The offset in bytes to the first element in the list of auxiliary devices returned with this format. A value of zero is returned if the list is empty.

Offset to list of data stream formats supported. The offset in bytes to the first element in the list of data stream formats supported by the printer device. A value of zero is returned if the list has a value of *UNKNOWN.

Note: The offset of the data stream formats supported is the offset from the begining of the DEVD1100 format.

Offset to list of drive resources. The offset in bytes to the first element in the list of drive resources. A value of zero is returned if the list is empty.

Start of changeOffset to list of file server storage entries. The offset in bytes to the first element in the list of file server storage entries. A value of zero is returned if the list is empty.

Offset to list of local interfaces. The offset in bytes to the first element in the list of local interfaces.End of change

Offset to list of mode names. The offset in bytes to the first element in the list of mode names returned with this format. A value of zero is returned if the list is empty.

Offset to list of publishing information. The offset in bytes to the first element in the list of publishing information returned with this format. A value of zero is returned if the list is empty.

Offset to list of robot device descriptions. The offset in bytes to the first element in the list of robot device descriptions. A value of zero is returned if the list is empty.

Offset to list of robot hosts. The offset in bytes to the first element in the list of robot hosts. A value of zero is returned if the list is empty.

Offset to list of switched lines. The offset in bytes to the list of switched lines returned with this format. A value of zero is returned if the list is empty.

Offset to list of user-defined options. The offset in bytes to the first element in the list of user-defined options that are returned with this format. A value of zero is returned if the list is empty.

Start of changeOffset to list of virtual Ethernet entries.The offset in bytes to the first element in the list of virtual Ethernet entries. A value of zero is returned if the list is empty.End of change

Offset to user-defined data. The offset in bytes to the user-defined data that is returned with this format. A value of zero is returned if no data exists.

Online at IPL (ONLINE). Whether the device is varied on automatically when the system is turned on or you want to vary it on manually by using the Vary Configuration (VRYCFG) command. (See the ONLINE parameter in the Control Language (CL) information for the CRTDEVAPPC, CRTDEVASC, CRTDEVBSC, CRTDEVCRP, CRTDEVDSP, CRTDEVFNC, CRTDEVHOST, CRTDEVINTR, CRTDEVMLB, CRTDEVNET, Start of change CRTDEVNWSH, End of change CRTDEVOPT, CRTDEVPRT, CRTDEVRTL, CRTDEVSNPT, CRTDEVSNUF, or CRTDEVTAP command.)

Output queue (OUTQ). The output queue to be used for printed output associated with this display station. This information is returned in two separate fields:

(See the OUTQ parameter in the Control Language (CL) information for the CRTDEVDSP command.)

Pacing (PACING). The number of request units (RUs) that can be sent or received before a pacing response must be sent or received. (See the PACING parameter in the Control Language (CL) information for the CRTDEVPRT or CRTDEVRTL command.)

Pages per minute black (PUBLISHINF). The number of black ink pages per minute the printer device can produce. A value of negative one is returned if the pages per minute is *UNKNOWN. (See the PUBLISHINF parameter in the Control Language (CL) information for the CRTDEVPRT command.)

Pages per minute color (PUBLISHINF). The number of color ink pages per minute the printer device can produce. A value of negative one is returned if the pages per minute is *UNKNOWN. (See the PUBLISHINF parameter in the Control Language (CL) information for the CRTDEVPRT command.)

Paper source 1 (PPRSRC1). The type of paper to be used in paper source one. (See the PPRSRC1 parameter in the Control Language (CL) information for the CRTDEVPRT command.)

Paper source 2 (PPRSRC2). The type of paper to be used in paper source two. (See the PPRSRC2 parameter in the Control Language (CL) information for the CRTDEVPRT command.)

Parity type (PARITY). For ASCII devices, the parity used to communicate over the attachment between the controller and the device. (See the PARITY parameter in the Control Language (CL) information for the CRTDEVDSP or CRTDEVPRT command.)

Pass-through indicator. Whether the current session is a pass-through session on a device. Possible values follow:

0 Not pass-through
1 5250 emulation type display
2 Virtual display using Virtual Terminal APIs (not TELNET)
3 Virtual display (TELNET)
4 Pass-through device (Start Pass-Through (STRPASTHR) command used)

PKA key store file (PKAKEYFILE). The name of the key store file containing the public key algorithm (PKA) keys to be used with this cryptographic device. This information is returned in two separate fields:

(See the PKAKEYFILE parameter in the Control Language (CL) information for the CRTDEVCRP command.)

Physical attachment (ATTACH). The attachment of a display station to the ASCII workstation controller. (See the ATTACH parameter in the Control Language (CL) information for the CRTDEVDSP or CRTDEVPRT command.)

Start of change Port speed. The port speed, in bits per second (bps), of a network server host adapter local interface. (See the LCLIFC parameter in the Control Language (CL) information for the CRTDEVNWSH command.)

Exceptions:

End of change

Pre-established session (PREESTSSN). Whether the single session is to be established when connection with the remote system is established. (See the PREESTSSN parameter in the Control Language (CL) information for the CRTDEVAPPC command.)

Print device (PRTDEV). The name of the printer to be used for printed output from this display device. (See the PRTDEV parameter in the Control Language (CL) information for the CRTDEVDSP command.)

Print file (PRTFILE). The alternative printer device file to be used when no associated work station printer exists or when an error occurs during an attempt to use the work station printer. This information is returned in two separate fields:

(See the PRTFILE parameter in the Control Language (CL) information for the CRTDEVDSP command.)

Print quality (PRTQLTY). For printers, the quality of print to be produced. (See the PRTQLTY parameter in the Control Language (CL) information for the CRTDEVPRT command.)

Print request timer (PRTRQSTMR). The number of seconds to wait after a print request has been sent to a continuous forms printer before the last printed output is forced into the output hopper. (See the PRTRQSTMR parameter in the Control Language (CL) information for the CRTDEVPRT command.)

Exception:

Print while converting (PRTCVT). Allows printers configured as AFP(*YES) to begin printing a spooled file while that file is being converted to an Advanced Function Printing data stream (AFPDS). (See the PRTCVT parameter in the Control Language (CL) information for the CRTDEVPRT command.)

Printer (PRINTER). The device name of the printer to be associated with the display device. (See the PRINTER parameter in the Control Language (CL) information for the CRTDEVDSP command.)

Printer error message (PRTERRMSG). Whether to have the printer send inquiry messages or informational messages for recoverable errors. (See the PRTERRMSG parameter in the Control Language (CL) information for the CRTDEVPRT command.)

Program start request capable (PGMSTRRQS). Whether or not to have the device reserved for program start requests. (See the PGMSTRRQS parameter in the Control Language (CL) information for the CRTDEVSNUF command.)

Published printer (PUBLISHINF). Whether the printer information is published in the LDAP directory. Valid values are *YES and *NO. (See the PUBLISHINF parameter in the Control Language (CL) information for the CRTDEVPRT command.)

Record length (RCDLEN). The maximum record length allowed when communicating with this device. (See the RCDLEN parameter in the Control Language (CL) information for the CRTDEVBSC or CRTDEVSNUF command.)

Start of changeRecovery limits (CMNRCYLMT). The second-level communications recovery limit for each device description. These limits are returned in two separate fields:

(See the CMNRCYLMT parameter in the Control Language (CL) information for the CRTDEVNWSH command.)

Exception:

Relational database name (RDB). The name of the relational database associated with the auxiliary storage pool (ASP). (See the RDB parameter in the Control Language (CL) information for the CRTDEVASP command.)

Remote BSCEL (RMTBSCEL). Whether this device will communicate with a remote system that can recognize BSCEL commands and messages. (See the RMTBSCEL parameter in the Control Language (CL) information for the CRTDEVBSC command.)

Remote location name (RMTLOCNAME). The SNA network ID and control point name, an internet protocol (IP) host name, or an internet address of the printer device. (See the RMTLOCNAME parameter in the Control Language (CL) information for the CRTDEVAPPC, CRTDEVASC, CRTDEVBSC, CRTDEVDSP, CRTDEVFNC, CRTDEVHOST, CRTDEVINTR, CRTDEVPRT, CRTDEVRTL, or CRTDEVSNUF command.)

Exception:

Remote location name type. The remote location name type is *SNA or *IP.

Remote network identifier (RMTNETID). The 8-character name of the remote network in which the location resides. (See the RMTNETID parameter in the Control Language (CL) information for the CRTDEVAPPC, CRTDEVDSP, or CRTDEVPRT command.)

Reserved. Space included for alignment.

Resource allocation priority (RSCALCPTY). The priority of a job when requesting a resource. (See the RSCALCPTY parameter in the Control Language (CL) information for the CRTDEVMLB command.)

Exception:

Resource name (RSRCNAME). The unique name that is assigned by the system to the physical equipment attached to the system. For an explanation of resource names for devices, see the Local Device ConfigurationLink to PDF book. (See the RSRCNAME parameter in the Control Language (CL) information for the CRTDEVASP, CRTDEVCRP, CRTDEVMLB, Start of change CRTDEVNWSH, End of change CRTDEVOPT, or CRTDEVTAP command.)

Robot device description (ROBOTDEV). For library devices with separate robots, the name of the device description used to communicate with the robot. For an explanation of robots in library devices, see the Local Device Configuration Link to PDF book. (See the ROBOTDEV parameter in the Control Language (CL) information for the CRTDEVMLB command.)

Robot host (ROBOTHOST). Specifies the TCP/IP host name or Internet address of the robotic library manager. For an explanation of robots in library devices, see the Local Device Configuration Link to PDF book. (See the ROBOTHOST parameter in the Control Language (CL) information for the CRTDEVMLB command.)

Start of changeSCSI TCP port. The TCP port that the given local SCSI interface will listen on for SCSI traffic. The local SCSI internet address and SCSI TCP port together define an iSCSI target portal. (See the LCLIFC parameter in the Control Language (CL) information for the CRTDEVNWSH command.) End of change

Secure location (SECURELOC). Whether or not the remote location is secure. If the remote location is secure, then an already verified indicator is allowed to be sent with program start requests. If it is not secure, then either no security information is allowed or the User ID with encrypted password is retrieved. (See the SECURELOC parameter in the Control Language (CL) information for the CRTDEVAPPC command.)

Separator character (SEPCHAR). The separator character to be used (if you specified *SEP for the blocking type). (See the SEPCHAR parameter in the Control Language (CL) information for the CRTDEVBSC command.)

Separator drawer (SEPDRAWER). The sheet feeding drawer for file and job separators. (See the SEPDRAWER parameter in the Control Language (CL) information for the CRTDEVPRT command.)

Separator exit program (SEPPGM). A user exit program to be called when printing the job and file separators. This information is returned in two separate fields:

(See the SEPPGM parameter in the Control Language (CL) information for the CRTDEVPRT command.)

Server network protocol. The following defines the server network protocol:

Note: This field applies only to display and printer devices that are used by TELNET.

Server network protocol address. The server network address is uniquely assigned to each system and is used in all communications with the system.

The following format defines the server network address based on the server network protocol:

Note: This field applies only to display and printer devices that are used by TELNET.

Server Internet Protocol (IP) internet address in dotted decimal form. A 32-bit address usually written as 4 decimal numbers, each representing 8 bits of the address. An example internet address is 128.12.28.43.

Each system on the TCP/IP network is assigned a unique internet address that is used in all communications with the system.

Note: This field applies only to display or printer devices that are used by TELNET or TCP/IP over Twinax.

Shared session number. The shared session number that is associated with this device.

Single session (SNGSSN). Whether communications with the remote location is limited to one session. If communications is limited to one session, a maximum number of conversations may also be specified. This information is returned in two separate fields:

(See the SNGSSN parameter in the Control Language (CL) information for the CRTDEVAPPC command.)

SNA pass-through class (SNPTCLS). Whether this device is to be used as an upstream or downstream pass-through device. (See the SNPTCLS parameter in the Control Language (CL) information for the CRTDEVSNPT command.)

SNA pass-through device (SNPTDEV). The name of the pass-through device with which this device is associated. (See the SNPTDEV parameter in the Control Language (CL) information for the CRTDEVDSP, CRTDEVFNC, CRTDEVPRT, CRTDEVRTL, or CRTDEVSNPT command.)

SNA pass-through group name (SNPTGRP). The name of a group of upstream SNA pass-through devices with which this device can be associated. (See the SNPTGRP parameter in the Control Language (CL) information for the CRTDEVDSP, CRTDEVFNC, CRTDEVPRT, CRTDEVRTL, or CRTDEVSNPT command.)

SNA remote location name (RMTLOCNAME). The name of the remote location with which your system will be communicating. (See the RMTLOCNAME parameter in the Control Language (CL) information for the CRTDEVAPPC, CRTDEVASC, CRTDEVBSC, CRTDEVDSP, CRTDEVFNC, CRTDEVHOST, CRTDEVINTR, CRTDEVPRT, CRTDEVRTL, or CRTDEVSNUF command.)

Special host application (SPCHOSTAPP). Whether this device is used to communicate with a special host application. (See the SPCHOSTAPP parameter in the Control Language (CL) information for the CRTDEVSNUF command.)

Stop bits (STOPBITS). For ASCII devices, the number of stop bits used to communicate over the attachment between the controller and the device. (See the STOPBITS parameter in the Control Language (CL) information for the CRTDEVDSP or CRTDEVPRT command.)

Start of change Subnet mask. The subnet mask that is assigned to each internet address. The mask is in the form, nnn.nnn.nnn.nnn, where nnn is a decimal number that ranges from 0 through 255. (See the LCLIFC parameter in the Control Language (CL) information for the CRTDEVNWSH command.) End of change

Switch setting. The value of the current switch settings at the actual device, equivalent to the current device address.

Switched line name. The name of a switched line associated with an ASCII printer directly attached to the LAN.

System driver program name (SYSDRVPGM). The name of a system-defined driver program. It is used to provide the capability for sending Start of change i5/OS End of change print output to a printer attached over a TCP/IP network. (See the SYSDRVPGM parameter in the Control Language (CL) information for the CRTDEVPRT command.)

Text description (TEXT). A brief description of the device and its location. (See the TEXT parameter in the Control Language (CL) information for the CRTDEVAPPC, CRTDEVASC, CRTDEVASP, CRTDEVBSC, CRTDEVCRP, CRTDEVDSP, CRTDEVFNC, CRTDEVHOST, CRTDEVINTR, CRTDEVMLB, CRTDEVNET, Start of change CRTDEVNWSH, End of change CRTDEVOPT, CRTDEVPRT, CRTDEVRTL, CRTDEVSNPT, CRTDEVSNUF, or CRTDEVTAP command.)

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

Transform enabled. Whether this printer will use the host-based transform support to convert SCS to ASCII.

Transmit in transparent mode (TRNSPY). Whether transparency is to be used by this device. (See the TRNSPY parameter in the Control Language (CL) information for the CRTDEVBSC command.)

Truncate trailing blanks (TRUNC). Whether trailing blanks are to be removed from the output records. (See the TRUNC parameter in the Control Language (CL) information for the CRTDEVBSC command.)

Unload device at vary off. Whether the tape device will be unloaded when the device is varied off.

Unload wait time (UNLOADWAIT). The amount of time the system waits for another request to a mounted volume before unloading the volume if there are outstanding requests for an available device. (See the UNLOADWAIT parameter in the Control Language (CL) information for the CRTDEVMLB command.)

Use secure connection (SECURECNN). Specifies whether a secure connection is established with the printer. A secure connection provides an encrypted communications session to ensure print data that passes over the connection remains private. (See the SECURECNN parameter in the Control Language (CL) information for the CRTDEVPRT command.)

More information about the secure connection can be found in the Printing topic.

User-defined data. A string of data that is associated with the printer device description and specified by the user. See the Change Configuration Description API for information on how to set this data.

User-defined data transform program library. The name of the library that contains the data transform program.

User-defined data transform program name (USRDTATFM). The name of the user-defined data transform program to be used by the user driver program. See the user driver program name field. (See the USRDTATFM parameter in the Control Language (CL) information for the CRTDEVPRT command.)

User-defined object library. The name of the library that contains the user-defined object.

User-defined object name. The name of the user-defined object that is to be used by the user driver program.

User-defined object type. The type of the user-defined object that is to be used by the user driver program.

User-defined option. An option to be accessed by the user driver program.

User driver program library. The name of the library that contains the user-defined driver program.

User driver program name. The name of a user-defined driver program.

Validation list (VLDL). Specifies a validation list that is used if the printer requests authentication. The validation list is checked for the name of the user who created the spooled file, the name of the printer device, or the name of the system. Authentication information associated with the name is returned to the printer. (See the VLDL parameter in the Control Language (CL) information for the CRTDEVPRT command.)

More information about building a validation list can be found in the Printing topic.

Start of changeVirtual Ethernet base UDP port. The lowest numbered User Datagram Protocol (UDP) port that the network server host adapter local LAN interface will use for virtual Ethernet communication with the remote server. (See the LCLIFC parameter in the Control Language (CL) information for the CRTDEVNWSH command.)

Virtual Ethernet upper UDP port. The highest numbered User Datagram Protocol (UDP) port that the network server host adapter local LAN interface will use for virtual Ethernet communication with the remote server. (See the LCLIFC parameter in the Control Language (CL) information for the CRTDEVNWSH command.) End of change

Word length (WORDLEN). For ASCII devices, the word length used to communicate over the attachment between the controller and the device. (See the WORDLEN parameter in the Control Language (CL) information for the CRTDEVDSP or CRTDEVPRT command.)

Work station customizing object (WSCST). The object containing pointers to the work station customizing tables for this device. This information is returned in two separate fields:

(See the WSCST parameter in the Control Language (CL) information for the CRTDEVDSP or CRTDEVPRT command.)


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.
CPF26A7 E Category of object not compatible with API format.
CPF2702 E Device 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.
CPF3CF1 E Error code parameter not valid.
CPF3C90 E Literal value cannot be changed.
CPF8104 E Controller description &4 damaged.
CPF8105 E Device description &4 damaged.
CPF9872 E Program or service program &1 in library &2 ended. Reason code &3.


API introduced: V2R3
Top | Configuration APIs | APIs by category