Retrieve Device Description (QDCRDEVD) API


  Required Parameter Group:


  Default Public Authority: *USE

  Threadsafe: Yes

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

Start of changeNote:


Authorities and Locks

Device Description Authority
*USE
Device Description Lock
*SHRRD

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:

Start of changeNote:

  • Formats DEVD0700 and DEVD1200 are no longer supported as of V7R4M0. Formats are documented in prior release.
End 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.



DEVD0200 Format

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



DEVD0300 Format

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



DEVD0400 Format

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



DEVD0500 Format

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



DEVD0600 Format

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



DEVD0800 Format

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



DEVD0900 Format

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



DEVD1000 Format

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



DEVD1100 Format

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



DEVD1300 Format

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



DEVD1400 Format

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



DEVD1500 Format

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



DEVD1600 Format

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



DEVD1700 Format

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



DEVD1800 Format

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



DEVD1900 Format

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



DEVD2000 Format

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



Field Descriptions

Some of the fields in the various formats returned by this API are described in greater detail in the documentation for the particular CL command that was used to create the device description object. See CL command finder. 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 Start of changeCRTDEVDSP or CRTDEVPRTEnd of change command.)

Active 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.

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™ support. (See the AFP parameter in 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 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 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 CRTDEVAPPC, CRTDEVDSP, or CRTDEVPRT command.)

Application identifier (APPID). The VTAM® application identifier of the CICS/VS or IMS/VS host subsystem with which the system communicates. (See the APPID parameter in the CRTDEVSNUF command.)

Application type (APPTYPE). The application type this device uses. (See the APPTYPE parameter in the Start of changeCRTDEVBSC, CRTDEVCRP, CRTDEVDSP, CRTDEVHOST, or CRTDEVPRTEnd of change command.)

APPN capable (APPN). Whether or not networking is used. (See the APPN parameter in 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 CRTDEVTAP command.) If the Assign device at vary on (ASSIGN) field is not supported for the device type/model, blanks are returned for the field.

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

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

Associated port resource name. The resource name that describes the port that is used to establish a connection between a virtual network server host adapter (NWSH) device and the network when the device is varied on. The value *NONE indicates that an associated port resource name is not associated with the device because the NWSH device is not varied on.

Note: An associated port resource name is returned when a network server host adapter (NWSH) device has a value of *VRT for the Resource name (RSRCNAME) field. When the Resource name (RSRCNAME) field does not have a value of *VRT, blanks are returned for the field.

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 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 Start of changeCRTDEVAPPC, CRTDEVASC, CRTDEVBSC, CRTDEVDSP, CRTDEVHOST, CRTDEVNET, CRTDEVPRT, CRTDEVSNPT, CRTDEVSNUF, or CRTDEVTAPEnd of change 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 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 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 CRTDEVBSC or CRTDEVSNUF command.)

Blocking type (BLOCK). Whether you or the system blocks and deblocks transmitted records. (See the BLOCK parameter in 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.

Cable connection. The type of cable connection used by a network server host adapter local interface (LCLIFC). (See the LCLIFC parameter in the CRTDEVNWSH command.)

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 CRTDEVDSP or CRTDEVPRT command.)

Exceptions:

Color supported (PUBLISHINF). Whether the printer device supports color ink printing. (See the PUBLISHINF parameter in 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 CRTDEVBSC command.)

Connection type (CNN). The connection type. (See the CNN parameter in 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 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.

Current duplex. The actual duplex mode being used by the 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 or if the value *VRT is returned in the Resource name (RSRCNAME) field for this device. (See the LCLIFC parameter in 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 if the Resource name (RSRCNAME) field does not have a value of *VRT.

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 CRTDEVAPPC, CRTDEVASP, CRTDEVCRP, CRTDEVMLB, CRTDEVNWSH, CRTDEVOPT, CRTDEVPRT, or CRTDEVTAP command.) This information is returned in two separate fields:

Current port speed. The actual speed of the port described by a network server host adapter local interface (LCLIFC). This value is determined by the hardware. (See the LCLIFC parameter in 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. A value of *AUTO is returned if the value *VRT is returned in the Resource name (RSRCNAME) field for this device.

Data stream supported. A data stream format supported by this printer device. (See the PUBLISHINF parameter in 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:

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 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 CRTDEVSNUF command.)

DES keystore file (DESKEYFILE). The name of the keystore file containing the data encryption standard (DES) keys to be used with this cryptographic device. (See the DESKEYFILE parameter in 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 CRTDEVDSP, CRTDEVHOST, CRTDEVPRT, CRTDEVSNPT, or CRTDEVSNUF command.)

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

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 Start of changeCRTDEVDSP, CRTDEVMLB or CRTDEVPRTEnd of change command.)

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

Device name (DEVD). The name of the device description. (See the DEVD parameter in the Start of changeCRTDEVAPPC, CRTDEVASC, CRTDEVASP, CRTDEVBSC, CRTDEVCRP, CRTDEVDSP, CRTDEVHOST, CRTDEVINTR, CRTDEVMLB, CRTDEVNET, CRTDEVNWSH, CRTDEVOPT, CRTDEVPRT, CRTDEVSNPT, CRTDEVSNUF, or CRTDEVTAPEnd of change command.)

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

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

Exception:

(See the TYPE parameter in the Start of changeCRTDEVDSP, CRTDEVMLB, CRTDEVNET, CRTDEVOPT, CRTDEVPRT, or CRTDEVTAPEnd of change command.)

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

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

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.

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 CRTDEVDSP command.)

Duplex. Whether the 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. A value of *AUTO is returned if the value *VRT is returned in the Resource name (RSRCNAME) field for this device. (See the LCLIFC parameter in the CRTDEVNWSH command.)

Duplex supported (PUBLISHINF). Whether the printer device supports duplex printing. (See the PUBLISHINF parameter in 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 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 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 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 CRTDEVBSC or CRTDEVHOST command.)

Emulating ASCII device (EMLASCII). Whether this device emulates a supported ASCII device type. (See the EMLASCII parameter in 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 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 supported media types. The entry length in bytes of each element in the list of supported media types returned with this format. A value of zero is returned if the list is empty.

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 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 manual. (See the ROBOTDEV parameter 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 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 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 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 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 CRTDEVMLB command.) For an explanation of cartridge identifiers, see the Local Device Configuration Link to PDF manual.

Group ID number (GID). The ID number of the remote group profile on the Network File System (NFS) server. This parameter is only valid if the value *SRVLAN is returned in the Local internet address (LCLINTNETA) field for this device. (See the GID parameter in the CRTDEVOPT command.)

Group separator type (GRPSEP). The separator for groups of data (data sets, documents, and so forth). (See the GRPSEP parameter in 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 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 CRTDEVDSP or CRTDEVPRT command.)

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

Idle timer (IDLTMR). The time that the system waits for a response. (See the IDLTMR parameter in 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 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 Start of changeCRTDEVDSP or CRTDEVPRTEnd of change 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 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 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.

The internet address is unique across the network and 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.

Exception:

Internet Protocol (IPv6) version 6 internet address in character representation form. A 128-bit address normally written as eight groups of four hexadecimal digits. An example IPv6 internet address is 2001:0db8:85a3:08d3:1319:8a2e:0370:7334.

The internet address is unique across the network and is used in all communications with the system.

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

Exception:

IPv6 Network protocol address. The network address is unique across the network and is used in all communications with the system.

The following format defines the network address for IPv6 network protocol:

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

Exception:

IPv6 Server network protocol address. The server network address is unique across the network and is used in all communications with the system.

The following format defines the server network address for IPv6 network protocol:

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

Exception:

Keyboard language type (KBDTYPE). The 3-character keyboard type identified for type 3277, 3278, or 3279 display stations. (See the KBDTYPE parameter in 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.

Last activity date. The date of last activity on the object. The date format used is CYYMMDD, where:

Length 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.

Length of local internet address. The length, in bytes, of the local internet address that is returned with this format.

Length of network image directory. The length, in bytes, of the network image directory that is returned with this format. A value of zero is returned if no network image directory exists.

Length of remote internet address. The length, in bytes, of the remote internet address that is returned with this format. A value of zero is returned if no remote internet address exists.

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.

Length 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.

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

Local 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, a local LAN adapter address, and a cable connection. (See the LCLIFC parameter in the CRTDEVNWSH command.)

Note: When the value *VRT is returned in the Resource name (RSRCNAME) field for the device, it represents virtual hardware instead of physical hardware and some of the fields in local interface do not apply.

Local internet address (LCLINTNETA). The TCP/IP interface to be used to communicate with the remote system when using virtual image files on a network. (See the LCLINTNETA parameter in the CRTDEVOPT command.)

Local LAN adapter address. The Ethernet adapter address of a network server host adapter local LAN interface. (See the LCLIFC parameter in the CRTDEVNWSH command.)

Exception:

Local LAN gateway address. The internet address of the gateway associated with a network server host adapter local LAN interface. A value of *NONE is returned if the value *VRT is returned in the Resource name (RSRCNAME) field for the device. (See the LCLIFC parameter in the CRTDEVNWSH command.)

Local LAN internet address. The internet address of a network server host adapter local LAN interface. A value of *IPSCSI is returned if the value *VRT is returned in the Resource name (RSRCNAME) field for the device. (See the LCLIFC parameter in the CRTDEVNWSH command.)

Local location address (LOCADR). The local location address. (See the LOCADR parameter in the Start of changeCRTDEVAPPC, CRTDEVBSC, CRTDEVDSP, CRTDEVHOST,CRTDEVPRT, CRTDEVSNPT, or CRTDEVSNUF End of changecommand.)

Local location name (LCLLOCNAME). The name by which the local system is known to other devices in the network. (See the LCLLOCNAME parameter in the CRTDEVAPPC, CRTDEVDSP, or CRTDEVPRT command.)

Local SCSI adapter address. The Ethernet adapter address of a network server host adapter local SCSI interface. (See the LCLIFC parameter in the CRTDEVNWSH command.)

Exception:

Local SCSI gateway address. The internet address of the gateway associated with a network server host adapter local SCSI interface. A value of *NONE is returned if the value *VRT is returned in the Resource name (RSRCNAME) field for the device. (See the LCLIFC parameter in 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 CRTDEVNWSH command.)

Locally controlled session (LCLCTLSSN). Whether the single session is locally or remotely controlled. (See the LCLCTLSSN parameter in the CRTDEVAPPC command.)

Location (PUBLISHINF). The location of the printer device. (See the PUBLISHINF parameter in 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 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 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 Start of changeCRTDEVHOSTEnd of change 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 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 CRTDEVPRT command.)

Media name. Physical characteristics of the optical media. This value will be one of the following:

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 CRTDEVAPPC, CRTDEVASP, CRTDEVCRP, CRTDEVMLB, CRTDEVNWSH, CRTDEVOPT, CRTDEVPRT, or CRTDEVTAP command.) This information is returned in two separate fields:

Mode name (MODE). The names used by the local system 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 CRTDEVAPPC or CRTDEVPRT command.)

Network image directory (NETIMGDIR). The network path on the Network File System (NFS) server containing the virtual image files that were prepared for use with this device. (See the NETIMGDIR parameter in the CRTDEVOPT 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 unique across the network 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.

Exception:

Network server name (NWSD). The name of a network server description that is actively using a file server storage resource.

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 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.

Number 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.

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 supported media types. The number of entries in the list of supported media types returned with this format. 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.

Number 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).

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.

Offset 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.

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 supported media types. The offset in bytes to the list of supported media types returned with this format. 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.

Offset 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.

Offset to network image directory. The offset in bytes to the network image directory that is returned with this format. A value of zero is returned if no network image directory exists.

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 Start of changeCRTDEVAPPC, CRTDEVASC, CRTDEVBSC, CRTDEVCRP, CRTDEVDSP, CRTDEVHOST, CRTDEVINTR, CRTDEVMLB, CRTDEVNET, CRTDEVNWSH, CRTDEVOPT, CRTDEVPRT, CRTDEVSNPT, CRTDEVSNUF, or CRTDEVTAPEnd of change 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 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 Start of changeCRTDEVPRTEnd of change 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 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 CRTDEVPRT command.)

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

Paper source 2 (PPRSRC2). The type of paper to be used in paper source two. (See the PPRSRC2 parameter in 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 CRTDEVDSP or CRTDEVPRT command.)

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

PKA keystore file (PKAKEYFILE). The name of the keystore 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 CRTDEVCRP command.)

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

Port speed. The port speed, in bits per second (bps), of a network server host adapter local interface. A value of -30 is returned if the value *VRT is returned in the Resource name (RSRCNAME) field for the device. (See the LCLIFC parameter in the CRTDEVNWSH command.)

Exceptions:

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 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 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 CRTDEVDSP command.)

Print quality (PRTQLTY). For printers, the quality of print to be produced. (See the PRTQLTY parameter in 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 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 CRTDEVPRT command.)

Printer (PRINTER). The device name of the printer to be associated with the display device. (See the PRINTER parameter in 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 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 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 CRTDEVPRT command.)

Read capability. Optical media can be read. If the media has the capability, this field is Y. If not, this field is N.

Record capability. Optical media can be recorded. If the media has the capability, this field is Y. If not, this field is N.

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

Recovery 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 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 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 CRTDEVBSC command.)

Remote internet address (RMTINTNETA). The internet address of the Network File System (NFS) server where the virtual optical device will look for virtual image files. (See the RMTINTNETA parameter in the CRTDEVOPT 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 Start of changeCRTDEVAPPC, CRTDEVASC, CRTDEVBSC, CRTDEVDSP, CRTDEVHOST, CRTDEVINTR, CRTDEVPRT, or CRTDEVSNUFEnd of change 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 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 CRTDEVMLB command.)

Exception:

Resource name (RSRCNAME). The unique name that is assigned by the system to the hardware attached to the system. For an explanation of resource names for devices, see the Local Device Configuration Link to PDF manual. (See the RSRCNAME parameter in the CRTDEVASP, CRTDEVCRP, CRTDEVMLB, CRTDEVNWSH, CRTDEVOPT, or CRTDEVTAP command.)

Exception:

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 manual. (See the ROBOTDEV parameter in 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 manual. (See the ROBOTHOST parameter in the CRTDEVMLB command.)

SCSI 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 CRTDEVNWSH command.)

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 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 CRTDEVBSC command.)

Separator drawer (SEPDRAWER). The sheet feeding drawer for file and job separators. (See the SEPDRAWER parameter in 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 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 unique across the network 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.

Exception:

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.

The internet address is unique across the network and 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.

Exception:

Server Internet Protocol (IPv6) version 6 internet address in character representation form. A 128-bit address normally written as eight groups of four hexadecimal digits. An example IPv6 internet address is 2001:0db8:85a3:08d3:1319:8a2e:0370:7334.

The internet address is unique across the network and is used in all communications with the system.

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

Exception:

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 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 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 Start of changeCRTDEVDSP, CRTDEVPRT, or CRTDEVSNPTEnd of change 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 Start of changeCRTDEVDSP, CRTDEVPRT, or CRTDEVSNPTEnd of change 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 Start of changeCRTDEVAPPC, CRTDEVASC, CRTDEVBSC, CRTDEVDSP, CRTDEVHOST, CRTDEVINTR, CRTDEVPRT, or CRTDEVSNUFEnd of change command.)

Special host application (SPCHOSTAPP). Whether this device is used to communicate with a special host application. (See the SPCHOSTAPP parameter in 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 CRTDEVDSP or CRTDEVPRT command.)

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. A value of *NONE is returned if the value *VRT is returned in the Resource name (RSRCNAME) field for the device. (See the LCLIFC parameter in the CRTDEVNWSH command.)

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 IBM i ® print output to a printer attached over a TCP/IP network. (See the SYSDRVPGM parameter in the CRTDEVPRT command.)

Text description (TEXT). A brief description of the device and its location. (See the TEXT parameter in the Start of changeCRTDEVAPPC, CRTDEVASC, CRTDEVASP, CRTDEVBSC, CRTDEVCRP, CRTDEVDSP, CRTDEVHOST, CRTDEVINTR, CRTDEVMLB, CRTDEVNET, CRTDEVNWSH, CRTDEVOPT, CRTDEVPRT, CRTDEVSNPT, CRTDEVSNUF, or CRTDEVTAPEnd of change 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:

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 CRTDEVBSC command.)

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

Type of local internet address. The type of the local internet address. Possible values are as follows:

(See the LCLINTNETA parameter in the CRTDEVOPT command.)

Type of remote internet address. The type of the remote internet address. Possible values are as follows:

(See the RMTINTNETA parameter in the CRTDEVOPT 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 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 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 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.

User ID number (UID). The ID number of the remote user profile on the Network File System (NFS) server. This parameter is only valid if the value *SRVLAN is returned in the Local internet address (LCLINTNETA) field for this device. (See the UID parameter in the CRTDEVOPT command.)

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 CRTDEVPRT command.)

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

Virtual Ethernet base UDP port. The lowest numbered User Datagram Protocol (UDP) port that the local LAN interface for a network server host adapter will use for virtual Ethernet communication with the remote system. (See the LCLIFC parameter in the CRTDEVNWSH command.)

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

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 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 CRTDEVDSP or CRTDEVPRT command.)

Write capability. Optical media can be written. If the media has the capability, this field is Y. If not, this field is N.


Error Messages


API introduced: V2R3

[ Back to top | Configuration APIs | APIs by category ]