Retrieve Line Description (QDCRLIND) API

  Required Parameter Group:


  Default Public Authority: *USE

  Threadsafe: Yes

The Retrieve Line Description (QDCRLIND) API retrieves information about a line description.


Authorities and Locks

Controller Description Authority
*USE
Line Description Authority
*USE
Controller Description Lock
*SHRRD
Line Description Lock
*SHRNUP

Required Parameter Group

Receiver variable
OUTPUT; CHAR(*)

The variable that is to receive the line 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 line description. The possible format names are:

Note: Formats LIND0600 and LIND0700 are no longer supported.

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

Line name
INPUT; CHAR(10)

The name of the line 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 Line Information

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

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


LIND0100 Format

Use this format to find out the line category, plus some basic information about the line. Then you may use the returned line category to select one of the other (category-specific) formats to call the API again for detailed information about the line description. This format also returns the number of controllers currently attached to this line.



LIND0200 Format

This format returns basic line information, plus a list of attached nonswitched controllers. Some basic information is also included for each attached nonswitched controller.



LIND0300 Format

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



LIND0400 Format

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



LIND0500 Format

This format returns detailed information about a line of category *ELAN.



LIND0600 Format

This format returns detailed information about a line of category *IDLC.



LIND0700 Format

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



LIND0800 Format

This format returns detailed information about a line of category *SDLC.



LIND0900 Format

This format returns detailed information about a line of category *TDLC.



LIND1000 Format

This format returns detailed information about a line of category *TRN.



LIND1100 Format

This format returns detailed information about a line of category *X25.



LIND1200 Format

This format returns detailed information about a line of category *DDI.



LIND1300 Format

This format returns detailed information about a line of category *FR.



LIND1400 Format

This format returns detailed information about a line of category *FAX.



LIND1500 Format

This format returns detailed information about a line of category *WLS.



LIND1600 Format

This format returns detailed information about a line of category *PPP.



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.

Activate LAN manager (ACTLANMGR). Whether the LAN manager support is activated. (See the ACTLANMGR parameter in the CRTLINTRN command.)

Activate switched network backup. Whether the switched network backup is activated.

Active switched controller name. The name of a controller associated with this line.

Aggregate policy. Specifies the algorithm used for load-balancing Outgoing Ethernet frames when configuring aggregate ports. (See the AGGPCY parameter in the CRTLINETH command.)

Aggregated resource list entry name. The name of an aggregate line description resource list entry.

Start of changeAggregated resource list entry status. Specifies the status of the aggregated resource list entry. This value will be one of the following:

End of change

Aggregate standard. The standard used to configure aggregated resource list entries. (See the AGGPCY parameter in the CRTLINETH command.)

Application type (APPTYPE). The type of application that this BSC line is used for. (See the APPTYPE parameter in the CRTLINBSC command.)

ARP retry count. The number of times an address resolution protocol (ARP) request will be retried if no response is received.

ARP retry timer The amount of time to wait for a response to an address resolution protocol (ARP) request.

Associated port resource name (ASSOCPORT). Specifies the resource name that describes the port that is used to establish a connection between a Windows® network server and the network. (See the ASSOCPORT parameter in the CRTLINETH command.)

Async control character map. Control characters that either may not be successfully received over an asynchronous serial line or which may be spuriously introduced by other data communications equipment into a transmission on the line.

Attach mode. The attach mode specified when the line was created. The term attach mode means the same thing as station type.

Attached nonswitched controller name. The name of a controller associated with this line.

Attached nonswitched network interface (NWI). The name of the nonswitched network interface (NWI) description that contains the channel to which this line is to be attached. (See the NWI parameter in the CRTLINDDI, CRTLINETH, CRTLINFR, CRTLINPPP, CRTLINTRN, or CRTLINX25 command.)

Attached workstation controller (WSC). The name of the controller description for the 5394 work station controller or the work station controller to which the personal computer is attached. (See the WSC parameter in the CRTLINTDLC command.)

ATM access type (ACCTYPE). The type of access to the ATM network. (See the ACCTYPE parameter in the CRTLINETH or CRTLINTRN command.)

Note: This field is no longer supported as of V5R3M0.

Autoanswer (AUTOANS). Whether you intend to use your modem's automatic answer function. (See the AUTOANS parameter in the CRTLINASC, CRTLINBSC, CRTLINSDLC, or CRTLINX25 command.)

Autoanswer type (AUTOANSTYP). The method to be used by the system and modem to answer incoming calls. (See the AUTOANSTYP parameter in the CRTLINASC, CRTLINBSC, CRTLINSDLC, or CRTLINX25 command.)

Autocall resource name (ACRSRCNAME). The name that is assigned by the system to a communications port from which a communications line attaches to an automatic call unit. (See the ACRSRCNAME parameter in the CRTLINASC, CRTLINBSC, CRTLINSDLC, or CRTLINX25 command.)

Autocall unit (AUTOCALL). An associated automatic call unit. (See the AUTOCALL parameter in the CRTLINASC, CRTLINBSC, CRTLINSDLC, or CRTLINX25 command.)

Autoconfigured for AS/36. The line was automatically configured for AS/36.

Autocreate controller (AUTOCRTCTL). Whether the system is to automatically create APPC controller descriptions when incoming calls are received from other systems on the local area network. (See the AUTOCRTCTL parameter in the CRTLINDDI, CRTLINETH, CRTLINTRN, or CRTLINWLS command.)

Autodelete controller (AUTODLTCTL). The number of minutes the system should wait before automatically varying off and deleting automatically created controller descriptions associated with this line. (See the AUTODLTCTL parameter in the CRTLINDDI, CRTLINETH, CRTLINTRN, or CRTLINWLS command.)

Exception:

Autodial (AUTODIAL). Whether or not you intend to use the automatic call function to dial the remote system or network to establish a switched line connection. (See the AUTODIAL parameter in the CRTLINASC, CRTLINBSC, CRTLINSDLC, or CRTLINX25 command.)

Bridge identifier (BRIDGE). The identifier of the bridge that is associated with this Ethernet line description. A value of *NONE indicates no bridge identifier is associated with this Ethernet line description. (See the BRIDGE parameter in the CRTLINETH command.)

Call immediate (CALLIMMED). For switched X.25 lines, whether a call should be made immediately after varying on the line description. (See the CALLIMMED parameter in the CRTLINX25 command.)

Calling number (CALLNBR). The local connection number of a line. (See the CALLNBR parameter in the CRTLINASC, CRTLINBSC, CRTLINPPP, CRTLINSDLC, or CRTLINX25 command.)

Call progress signal retry value (CPSRTY). Whether a call attempt should be retried if the specified call progress signal is received. (See the CPSRTY parameter in the CRTLINSDLC command.)

Character code (CODE). The type of character code used. (See the CODE parameter in the CRTLINBSC command.)

Clear to send timer (CTSTMR). The length of time that the system should wait for the modem (DCE) to raise or drop Clear to Send (CTS) before signaling an error. (See the CTSTMR parameter in the CRTLINASC, CRTLINBSC, CRTLINPPP, CRTLINSDLC, or CRTLINX25 command.)

Exception:

Clocking (CLOCK). The clocking function for the line is provided by the modem (*MODEM). (See the CLOCK parameter in the CRTLINBSC, CRTLINPPP, CRTLINSDLC, or CRTLINX25 command.)

Compression (COMPRESS). The compression function is provided. (See the COMPRESS parameter in the CRTLINPPP command.)

Connection initiation (CNNINIT). The values to initiate the X.25 data link connection. (See the CNNINIT parameter in the CRTLINX25 command.)

Connection list (CNNLSTIN). The name of the connection list used to retrieve ISDN call information when authorizing incoming calls. (See the CNNLSTIN parameter in the CRTLINPPP, or CRTLINX25 command.)

Note: This field is no longer supported as of V5R3M0.

Connection number (CNNNBR). For switched X.25 lines, the number of the remote DCE (packet switched data network) that can be contacted using this line description. (See the CNNNBR parameter in the CRTLINX25 command.)

Connect poll retry (CNNPOLLRTY). The number of connect poll retries that will be attempted before the system indicates an error in contacting the remote system or controller. (See the CNNPOLLRTY parameter in the CRTLINSDLC command.)

Connect poll timer (CNNPOLLTMR). The length of time that the system waits for the response to a poll while in normal disconnect mode before polling the next station. (See the CNNPOLLTMR parameter in the CRTLINSDLC command.)

Connect retry count (IDLCCNNRTY). The number of times to retry a transmission at connection time. (See the IDLCCNNRTY parameter in the CRTLINIDLC command.)

Exceptions:

Note: This field is no longer supported as of V5R3M0.

Connect timer (CNNTMR). The amount of time that an automatic answer connect request waits for an incoming call on an X.21 circuit-switched line. (See the CNNTMR parameter in the CRTLINSDLC command.)

Exception:

Connection type (CNN). The type of line connection. (See the CNN parameter in the CRTLINASC, CRTLINBSC, CRTLINPPP, CRTLINSDLC, or CRTLINX25 command.)

Contention state retry (CTNRTY). The number of contention state retries that can be attempted before disconnecting the line. (See the CTNRTY parameter in the CRTLINBSC command.)

Continue timer (CONTTMR). The length of time that the system waits before sending a TTD or WACK control character. (See the CONTTMR parameter in the CRTLINBSC command.)

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

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

Controller name (CTL). The names of one or more controller descriptions associated with this line. (See the CTL parameter in the CRTLINASC, CRTLINBSC, CRTLINFAX, CRTLINSDLC, or CRTLINTDLC command.)

Controller text description. A brief description of a controller associated with this line.

Controller type. The type of controller being described. (See the TYPE parameter in the CRTCTLAPPC, CRTCTLFNC, CRTCTLLWS, CRTCTLRTL, CRTCTLRWS, or CRTCTLTAP command.)

Cost per byte (COSTBYTE). The relative cost per byte of sending and receiving data on the line. (See the COSTBYTE parameter in the CRTLINDDI, CRTLINETH, CRTLINFR, CRTLINSDLC, CRTLINTRN, CRTLINWLS, or CRTLINX25 command.)

Exception:

Cost per connect time (COSTCNN). The relative cost of being connected on the line. (See the COSTCNN parameter in the CRTLINDDI, CRTLINETH, CRTLINFR, CRTLINSDLC, CRTLINTRN, CRTLINWLS, or CRTLINX25 command.)

Exception:

CRC errors received (CRCRCV). The level of error threshold monitoring done by the system for CRC errors received. (See the CRCRCV parameter in the CRTLINIDLC command.)

Exceptions:

Note: This field is no longer supported as of V5R3M0.

Current duplex (DUPLEX). The actual duplex mode being used by the hardware associated with the line description. The current duplex value with *AUTO is determined by the hardware. (See the DUPLEX parameter in the CRTLINASC, CRTLINBSC, CRTLINETH, CRTLINSDLC, or CRTLINTRN command.)

Note: *AUTO is valid until the line is varied on. After the line is varied on, *AUTO is resolved to either *HALF or *FULL.

Current line speed (LINESPEED). The actual speed of the line description. This value is determined by the hardware. (See the LINESPEED parameter in the CRTLINASC, CRTLINBSC, CRTLINETH, CRTLINPPP, CRTLINSDLC, CRTLINTRN, or CRTLINX25 command.)

Exceptions:

Note: The values *CALC, *NWI, and *AUTO can be returned only when the line is varied off. If the line is varied on, these values will be resolved to a discrete line speed.

Current message queue (MSGQ). The message queue to which messages are currently being sent using this line description. This field is valid only for lines 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 CRTLINDDI, CRTLINETH, CRTLINFR, CRTLINPPP, CRTLINTRN, or CRTLINX25 command.) This information is returned in two separate fields:

Data bits per character (BITSCHAR). The data bits per character (either 7 or 8 bits excluding the parity bit). (See the BITSCHAR parameter in the CRTLINASC command.)

Data link role (ROLE). Whether this system is the primary station or secondary station, or if this station should dynamically negotiate its role with the remote station when the line is varied on. (See the ROLE parameter in the CRTLINSDLC command.)

Data set ready drop timer (DSRDRPTMR). The length of time that the system should wait for the modem (DCE) to drop Data Set Ready (DSR) after the system has dropped Data Terminal Ready (DTR) before signalling an error. (See the DSRDRPTMR parameter in the CRTLINASC, CRTLINBSC, CRTLINSDLC, or CRTLINX25 command.)

Data state retry (DTASTTRTY). The time before retry when BSC is sending or receiving data on the communications line. (See the DTASTTRTY parameter in the CRTLINBSC command.)

Date information retrieved. The date that the information was provided by the API. This is returned as 7 characters in the form CYYMMDD, as follows:

Default packet size (DFTPKTSIZE). The default packet size to use for controllers attached to this line description. This information is returned in two separate fields:

(See the DFTPKTSIZE parameter in the CRTLINX25 command.)

Exception:

Default window size: transmit/receive (IDLCWDWSIZ, DFTWDWSIZE) The default window size used for this line description. (See the DFTWDWSIZE parameter in the CRTLINX25 command.)

Exceptions:

Dial command type (DIALCMD). The dial command type used to establish a connection with a remote system. (See the DIALCMD parameter in the CRTLINASC, CRTLINBSC, CRTLINPPP, CRTLINSDLC, or CRTLINX25 command.)

Dial retries (DIALRTY). The number of times to retry dialing the number before considering the dialing unsuccessful. (See the DIALRTY parameter in the CRTLINX25 command.)

Duplex (DUPLEX). This value will be one of the following:

(See the DUPLEX parameter in the CRTLINASC, CRTLINBSC, CRTLINETH, CRTLINSDLC, or CRTLINTRN command.)

Early token release (ELYTKNRLS). Allows greater throughput on 16MB token-ring network lines. (See the ELYTKNRLS parameter in the CRTLINTRN command.)

Echo support (ECHO). Whether the system is to send back (echo) to the remote station none of the characters that it receives, all of the characters it receives, or all data up to, but not including, the end-of-record character (*CNTL). (See the ECHO parameter in the CRTLINASC command.)

Emulated LAN name (EMLLANNAME). Specifies the emulated LAN name. (See the EMLLANNAME parameter in the CRTLINETH or CRTLINTRN command.)

Note: This field is no longer supported as of V5R3M0.

Enable for TCP/IP (TCPONLY). Whether you want the line description to be used for TCP/IP only.

Note: TCPONLY is not used after release V4R5. The field will contain blanks.

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

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

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

Entry length for list of call progress signal retry values. The entry length in bytes of each element in the list of call progress signal retry values returned with this format. A value of zero is returned if the list is empty.

Entry length for list of EOR characters. The entry length in bytes of each element in the list of end-of-record (EOR) characters returned with this format. A value of zero is returned if the list is empty.

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

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

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

Entry length for list of PVC identifiers. The entry length in bytes of each element in the list of permanent virtual circuits (PVC) returned with this format. A value of zero is returned if the list is empty.

Note: This field is no longer supported as of V5R3M0.

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

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

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

Entry length for list of switched NWIs. The entry length in bytes of each element in the list of switched network interface (NWI) descriptions returned with this format. A value of zero is returned if the list is empty.

Note: This field is no longer supported as of V5R3M0.

EOR character. The end-of-record character.

Error threshold level (THRESHOLD). The level of the error threshold that is monitored by the system. (See the THRESHOLD parameter in the CRTLINASC, CRTLINBSC, CRTLINETH, CRTLINSDLC, CRTLINTRN, or CRTLINX25 command.)

Ethernet standard (ETHSTD). The standard used by the Ethernet local area network. (See the ETHSTD parameter in the CRTLINETH or CRTLINWLS command.)

Exchange identifier (EXCHID). The exchange identifier that the local system can send to the remote controller or system. (See the EXCHID parameter in the CRTLINDDI, CRTLINETH, CRTLINFR, CRTLINSDLC, CRTLINTRN, CRTLINWLS, or CRTLINX25 command.)

Extended network addressing (EXNNETADR). Whether extended network addressing is used by this line description and attached controller descriptions. (See the EXNNETADR parameter in the CRTLINX25 command.)

Fair polling timer (FAIRPLLTMR). The maximum length of time (in seconds) that the system will send data to one or more stations on the line before polling stations without pending output requests. (See the FAIRPLLTMR parameter in the CRTLINSDLC command.)

Flow control (FLOWCNTL). Whether you will use the XON and XOFF flow control characters to control the flow of data to your system. (See the FLOWCNTL parameter in the CRTLINASC or CRTLINPPP command.)

Frame aborts (ABORTS). The level of error threshold monitoring done by the system for frame aborts. (See the ABORTS parameter in the CRTLINIDLC command.)

Exceptions:

Note: This field is no longer supported as of V5R3M0.

Frame retry (FRAMERTY). The number of retries for an unanswered or unacknowledged frame. (See the FRAMERTY parameter in the CRTLINSDLC or CRTLINX25 command.)

Frame retry limit (IDLCFRMRTY). The maximum number of frame retransmissions to attempt before initiating recovery. (See the IDLCFRMRTY parameter in the CRTLINIDLC command.)

Exception:

Note: This field is no longer supported as of V5R3M0.

Frame sequence errors (FRMSEQERR). The level of error threshold monitoring done by the system for frame sequence errors. (See the FRMSEQERR parameter in the CRTLINIDLC command.)

Exceptions:

Note: This field is no longer supported as of V5R3M0.

Framing type (FRAMING). Specifies whether the line uses asynchronous or synchronous framing. (See the FRAMING parameter in the CRTLINPPP command.)

Function address. Functional address used by token-ring network lines.

Generate test frame (GENTSTFRM). Whether the system will have test frames automatically generated. Test frames are used to detect whether the Ethernet network has become inoperational during idle periods. (See the GENTSTFRM parameter in the CRTLINETH command.)

Group address. The group of addresses to which a subset of nodes on the network respond to, in addition to their local adapter addresses.

Idle timer (IDLTMR). The maximum allowable time between characters before the adapter forwards the receive buffer to the system. (See the IDLTMR parameter in the CRTLINASC, CRTLINSDLC, or CRTLINX25 command.)

Inactivity timer (INACTTMR). The time that the system waits for activity on a line before disconnecting. (See the INACTTMR parameter in the CRTLINASC, CRTLINBSC, CRTLINPPP, or CRTLINSDLC command.)

Exception:

Include STX character in the LRC (STXLRC). Whether to exclude the start-of-text (STX) character in the longitudinal redundancy check (LRC) calculation. (See the STXLRC parameter in the CRTLINBSC command.)

Incoming connection list (CNNLSTIN). The name of the connection list used to retrieve ISDN call information when authorizing incoming calls. (See the CNNLSTIN parameter in the CRTLINPPP, or CRTLINX25 command.)

Note: This field is no longer supported as of V5R3M0.

Information transfer type (INFTRFTYPE). How data is to be encoded for the ISDN B-channel associated with this line description. (See the INFTRFTYPE parameter in the CRTLINPPP, or CRTLINX25 command.)

Note: This field is no longer supported as of V5R3M0.

Initialization program library name. The name of the library in which the initialization program resides.

Initialization program name. The name of a program that is called to manage configuration initialization data.

Initialization source file library name. The name of the library in which the initialization source file resides.

Initialization source file name. The name of a source file containing configuration initialization data.

Initialization source member name. The name of a source member containing configuration initialization data.

Insert network address in packets (ADRINSERT). Whether the system inserts the local network address (NETADR) in call-request and call-accept packets. (See the ADRINSERT parameter in the CRTLINX25 command.)

IOP attach flag. Specifies what type of Ethernet IOP is attached.

LAN emulation client frame size (LECFRAME). The LAN emulation client (LEC) frame size. (See the LECFRAME parameter in the CRTLINTRN command.)

Exception:

Note: This field is no longer supported as of V5R3M0.

Last contacted LES ATM address. Specifies the most recently used LAN emulation server (LES) ATM network address associated with this line.

Note: These fields are no longer supported as of V5R3M0.

LEC cache aging time. Specifies the time-out period for which an address resolution protocol (ARP) entry will be cached without verification of that entry.

Note: This field is no longer supported as of V5R3M0.

LEC disconnect time out (LECDSCTIMO). The amount of time in minutes that a LAN emulation client will wait before disconnecting an idle virtual circuit connection to another client. (See the LECDSCTIMO parameter in the CRTLINETH or CRTLINTRN command.)

Note: This field is no longer supported as of V5R3M0.

Exception:

Start of changeLength 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.End of change

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

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

Line name. The name of the line description.

Line speed (LINESPEED). The line speed in bits per second (bps). (See the LINESPEED parameter in the CRTLINASC, CRTLINBSC, CRTLINETH, CRTLINPPP, CRTLINSDLC, CRTLINTRN, or CRTLINX25 command.)

Exception:

Link control protocol authentication values (LCPAUT). Specifies values controlling how the Link Control Protocol layer of IBM® i Point-to-Point Protocol (PPP) authenticates a remote peer. (See the LCPAUT parameter in the CRTLINPPP command.) These values are returned in two separate fields:

Exceptions:

Link control protocol configuration values (LCPCFG). Specifies values controlling how the Link Control Protocol layer of IBM i PPP negotiates mutually acceptable link configuration values with a remote peer. (See the LCPCFG parameter in the CRTLINPPP command.) These values are returned in four separate fields:

Link speed (LINKSPEED). The link speed in bits per second (bps). (See the LINKSPEED parameter in the CRTLINDDI, CRTLINETH, CRTLINFR, CRTLINSDLC, CRTLINTRN, CRTLINWLS, or CRTLINX25 command.)

Exceptions:

Note: For Ethernet (LIND0500) and Token-Ring (LIND1000), link speeds over one gigabit per second must be retrieved from two parameters as follows: LINKSPEED = (link_speed_multiplier x (10**9)) + link_speed. For link speeds less than one gigabit per second, the link speed multiplier will contain zero.

Link speed multiplier. For Ethernet (LIND0500) and Token-Ring (LIND1000), link speeds over one gigabit per second must use this multiplier to calculate the actual link speed as follows: LINKSPEED = (link_speed_multiplier x (10**9)) + link_speed. For link speeds less than one gigabit per second, the link speed multiplier will contain zero.

Local ATM address. Specifies the local ATM network address associated with this line.

Note: These fields are no longer supported as of V5R3M0.

Local adapter address (ADPTADR). The address used by the adapter for this line to transmit from and answer to on the token-ring or LAN. (See the ADPTADR parameter in the CRTLINDDI, CRTLINETH, CRTLINTRN, or CRTLINWLS command.)

Local manager mode (LCLMGRMODE). The local manager mode used with a distributed data interface (DDI) line. (See the LCLMGRMODE parameter in the CRTLINDDI command.)

Local network address (NETADR). The network address of the system. (See the NETADR parameter in the CRTLINX25 command.)

Log configuration changes (LOGCFGCHG). Whether the token-ring network manager for this line is to log configuration changes on the ring. (See the LOGCFGCHG parameter in the CRTLINTRN command.)

Logging level (LOGLVL). The error logging level used with a distributed data interface (DDI) line. (See the LOGLVL parameter in the CRTLINDDI command.)

Logical channel controller. Either an SVC or an attached PVC controller.

For a switched virtual circuit (SVC) logical channel, this is the controller description currently active on this logical channel.

For a permanent virtual circuit (PVC) logical channel, this is the controller description permanently attached to this logical channel.

Logical channel identifier. An identifier consisting of 3 hexadecimal characters that can range from hex 001 to hex FFF. The first character represents the logical channel group, as assigned by the network subscription. The last 2 characters are the network-assigned logical channel number.

Logical channel type. The type of logical channel.

Long retry (LONGRTY). The number of bursts of call retry attempts that the system makes when processing a connection request. (See the LONGRTY parameter in the CRTLINSDLC command.)

Long timer (LONGTMR). The length of time that the system waits between connection retry attempts. (See the LONGTMR parameter in the CRTLINSDLC command.)

Maximum ARP entries. Specifies the maximum number of address resolution protocol (ARP) table entries. This represents the maximum number of LAN emulation MAC addresses that can be resolved at any point in time.

Maximum buffer size (MAXBUFFER). The maximum size of the incoming and outgoing buffers. (See the MAXBUFFER parameter in the CRTLINASC or CRTLINBSC command.)

Maximum controllers (MAXCTL). The maximum number of controllers this line can support. (See the MAXCTL parameter in the CRTLINDDI, CRTLINETH, CRTLINFR, CRTLINSDLC, CRTLINTRN, or CRTLINWLS command.)

Maximum frame size (MAXFRAME). The maximum frame size or logical link control data unit that can be transmitted and received on this line. (See the MAXFRAME parameter in the CRTLINDDI, CRTLINETH, CRTLINFR, CRTLINPPP, CRTLINSDLC, CRTLINTRN, or CRTLINX25 command.)

Maximum outstanding frames (MAXOUT). The maximum number of information frames that can be sent to a remote system and received from a remote system before allowing the receiving system to respond. (See the MAXOUT parameter in the CRTLINSDLC command.)

Maximum packet size (MAXPKTSIZE). The maximum packet size that can be used by any controller associated with this line description. This information is returned in two separate fields:

(See the MAXPKTSIZE parameter in the CRTLINX25 command.)

Exceptions:

Message queue (MSGQ). The message queue to which operational messages for this line should normally be sent. Note that this is the value entered on the MSGQ parameter of the CL command, but under certain error conditions 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 CRTLINDDI, CRTLINETH, CRTLINFR, CRTLINPPP, CRTLINTRN, or CRTLINX25 command.) This information is returned in two separate fields:

Modem data rate select (MODEMRATE). Whether this modem is being operated at its full rated speed, or at an alternate or half speed. (See the MODEMRATE parameter in the CRTLINASC, CRTLINBSC, CRTLINSDLC, or CRTLINX25 command.)

Modem initialization command string (MDMINZCMD). The command string to send to set the modem. (See the MDMINZCMD parameter in the CRTLINASC, CRTLINPPP, CRTLINSDLC, or CRTLINX25 command.)

Modem type supported (MODEM). The type of modem diagnostic tests to be used on the line. (See the MODEM parameter in the CRTLINASC, CRTLINBSC, CRTLINSDLC, or CRTLINX25 command.)

Modulus (MODULUS). Whether extended sequence numbers are used (modulus 128) or not (modulus 8). (See the MODULUS parameter in the CRTLINSDLC or CRTLINX25 command.)

Network controller (NETCTL). The name of an existing network controller description. (See the NETCTL parameter in the CRTLINDDI, CRTLINETH, CRTLINFR, CRTLINPPP, CRTLINTDLC, CRTLINTRN, CRTLINWLS, or CRTLINX25 command.)

Network interface DLC identifier. The data link control (DLC) identifier used to connect to the network.

Network server description (NWS). The name of the network server to which the nonswitched line is attached. (See the NWS parameter in the CRTLINETH or CRTLINTRN command.)

Network user identification facility (NETUSRID). Allows X.25 network subscribers to specify the network user identification (NUI) selection facility that is encoded in the facility field of all call request packets sent on this line. (See the NETUSRID parameter in the CRTLINX25 command.)

Nonproductive receive timer (NPRDRCVTMR). The time that the system waits for either a final frame or an idle signal while the secondary station is continuously transmitting. (See the NPRDRCVTMR parameter in the CRTLINSDLC command.)

NRZI data encoding (NRZI). Whether the system uses the non-return-to-zero inverted (NRZI) transmission coding method. (See the NRZI parameter in the CRTLINPPP or CRTLINSDLC command.)

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

Number of aggregated resource list entries. The number of elements in the list of aggregated resource entry list returned with this format. A value of zero is returned if the list is empty.

Number of attached nonswitched controllers. The number of elements in the list of attached nonswitched controllers returned with this format. A value of zero is returned if the list is empty.

Number of call progress signal retry values. The number of elements in the list of call progress signal retry values returned with this format. A value of zero is returned if the list is empty.

Number of EOR characters. The number of elements in the list of end-of-record (EOR) characters returned with this format. A value of zero is returned if the list is empty.

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

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

Number of logical channel entries. The number of elements in the list of logical channel entries returned with this format. A value of zero is returned if the list is empty.

Number of PVC identifiers. The number of elements in the list of permanent virtual circuits returned with this format. A value of zero is returned if the list is empty.

Note: This field is no longer supported as of V5R3M0.

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

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

Number of SSAPs. The number of elements in the list of source service access points (SSAPs) returned with this format. A value of zero is returned if the list is empty.

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

Number of switched NWIs. The number of elements in the list of switched network interface (NWI) descriptions returned with this format. A value of zero is returned if the list is empty.

Note: This field is no longer supported as of V5R3M0.

Number of trailing characters. The value returned with each element in the list of EOR characters.

NWI channel number (NWICHLNBR). The network interface (NWI) channel to be used by this line description. (See the NWICHLNBR parameter in the CRTLINPPP, or CRTLINX25 command.)

Note: This field is no longer supported as of V5R3M0.

NWI channel type (NWICHLTYPE). The type of network interface channels to be used by this line description. (See the NWICHLTYPE parameter in the CRTLINX25 command.)

Note: This field is no longer supported as of V5R3M0.

NWI name. The name of the existing network interface description.

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

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

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

Offset to list of call progress signal retry values. The offset in bytes to the first element in the list of call progress signal retry values returned with this format. A value of zero is returned if the list is empty.

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

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

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

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

Offset to list of PVC identifiers. The offset in bytes to the first element in the list of permanent virtual circuits returned with this format. A value of zero is returned if the list is empty.

Note: This field is no longer supported as of V5R3M0.

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

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

Offset to list of SSAPs. The offset in bytes to the first element in the list of source service access points (SSAPs) returned with this format. A value of zero is returned if the list is empty.

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

Offset to list of switched NWIs. The offset in bytes to the first element in the list of switched network interface (NWI) descriptions returned with this format. A value of zero is returned if the list is empty.

Note: This field is no longer supported as of V5R3M0.

Online at IPL (ONLINE). Whether or not the line is varied on automatically when the system is turned on. (See the ONLINE parameter in the CRTLINASC, CRTLINBSC, CRTLINDDI, CRTLINETH, CRTLINFAX, CRTLINFR, CRTLINPPP, CRTLINSDLC, CRTLINTDLC, CRTLINTRN, CRTLINWLS, or CRTLINX25 command.)

Outgoing connection list (CNNLSTOUT). For switched ISDN connections, the name of a connection list containing the network-assigned numbers used for outgoing calls on this controller. (See the CNNLSTOUT parameter in the CRTLINPPP or CRTLINX25 command.)

Note: This field is no longer supported as of V5R3M0.

Outgoing connection list entry (CNNLSTOUTE). For switched ISDN connections, the name of the connection list entry containing the network-assigned numbers used for outgoing calls on this line. (See the CNNLSTOUTE parameter in the CRTLINPPP or CRTLINX25 command.)

Note: This field is no longer supported as of V5R3M0.

Packet mode (PKTMODE). Allows the system to communicate directly with another system by using the B-channel X.25 virtual circuit service integrated within an ISDN. (See the PKTMODE parameter in the CRTLINX25 command.)

Note: This field is no longer supported as of V5R3M0.

PVC identifiers (PVCID). Specifies the virtual path identifier and virtual circuit ID. (See the PVCID parameter in the CRTLINETH or CRTLINTRN command.)

Note: This field is no longer supported as of V5R3M0.

Physical interface (INTERFACE). The type of physical communications line interface that this communications adapter port and cable will be attached to. (See the INTERFACE parameter in the CRTLINASC, CRTLINBSC, CRTLINPPP, CRTLINSDLC, or CRTLINX25 command.)

Poll cycle pause (POLLPAUSE). The length of time that the system waits after the last remote system in the poll list is polled before beginning another pass through the poll list. (See the POLLPAUSE parameter in the CRTLINSDLC command.)

Poll response delay (POLLRSPDLY). The minimum duration of time that the system waits before it responds to a data poll if there is no information frame to transmit. (See the POLLRSPDLY parameter in the CRTLINSDLC command.)

Port number. The port number on the network server to which this line is physically attached.

Exceptions:

Predial delay (PREDIALDLY). The length of time to wait before dialing the number to establish a connection to the remote system or network. (See the PREDIALDLY parameter in the CRTLINX25 command.)

Propagation delay (PRPDLY). The time required for a signal to travel from one end of a link to the other end. (See the PRPDLY parameter in the CRTLINDDI, CRTLINETH, CRTLINFR, CRTLINSDLC, CRTLINTRN, CRTLINWLS, or CRTLINX25 command.)

Receive overrun (OVERRUN). The level of error threshold monitoring done by the system for receive overrun errors. (See the OVERRUN parameter in the CRTLINIDLC command.)

Exceptions:

Note: This field is no longer supported as of V5R3M0.

Receive timer (RCVTMR). The maximum amount of time the system waits for a response from the remote system before a time-out occurs. (See the RCVTMR parameter in the CRTLINBSC command.)

Receive TTD or WACK retry (RCVRTY). The number of times that a temporary text delay (TTD) or wait-before-transmit-positive acknowledgement (WACK) is received before the session fails. (See the RCVRTY parameter in the CRTLINBSC command.)

Exception:

Recovery limits (CMNRCYLMT). The second-level communications recovery limit for each line description. These limits are returned in two separate fields:

(See the CMNRCYLMT parameter in the CRTLINASC, CRTLINBSC, CRTLINDDI, CRTLINETH, CRTLINFR, CRTLINPPP, CRTLINSDLC, CRTLINTRN, CRTLINWLS, or CRTLINX25 command.)

Exception:

Redial delay (REDIALDLY). The length of time to wait before redialing the number to establish a connection to the remote system or network if the previous attempt was unsuccessful. (See the REDIALDLY parameter in the CRTLINX25 command.)

LES ATM address (LESATMADR). Specifies the ATM network address of the remote LAN emulation server. (See the LESATMADR parameter in the CRTLINETH or CRTLINTRN command.) This address is returned in three separate fields:

Note: This field is no longer supported as of V5R3M0.

Remote answer timer (RMTANSTMR). The length of time that the system should wait for the modem (DCE) to raise Data Set Ready (DSR) after dialing before signaling an error. (See the RMTANSTMR parameter in the CRTLINASC, CRTLINBSC, CRTLINPPP, CRTLINSDLC, or CRTLINX25 command.)

Start of changeRemote internet address (RMTINTNETA). The internet address of the remote Ethernet Device server. (See the RMTINTNETA parameter in the CRTLINASC or CRTLINPPP command.)

Remote port (RMTPORT). The remote port number for the TCP/IP connection to the Ethernet device server. (See the RMTPORT parameter in the CRTLINASC or CRTLINPPP command.)End of change

Reported emulated LAN name. The reported emulated LAN name.

Note: This field is no longer supported as of V5R3M0.

Reserved. Space included for alignment.

Response timer (IDLCRSPTMR). The length of time to wait before retransmitting a frame when an acknowledgement is not received. (See the IDLCRSPTMR parameter in the CRTLINIDLC command.)

Exception:

Note: This field is no longer supported as of V5R3M0.

Resource name (RSRCNAME). The unique name that is assigned by the system to the physical equipment (in this case, a communications port) attached to the system. (See the RSRCNAME parameter in the CRTLINASC, CRTLINBSC, CRTLINDDI, CRTLINETH, CRTLINFAX, CRTLINPPP, CRTLINSDLC, CRTLINTRN, CRTLINWLS, or CRTLINX25 command.)

Retransmitted frames (RETRANSMIT). The level of error threshold monitoring done by the system for retransmitted frames. (See the RETRANSMIT parameter in the CRTLINIDLC command.)

Exceptions:

Note: This field is no longer supported as of V5R3M0.

Security for line (SECURITY). The types of security protection available on the line. (See the SECURITY parameter in the CRTLINDDI, CRTLINETH, CRTLINFR, CRTLINSDLC, CRTLINTRN, CRTLINWLS, or CRTLINX25 command.)

Segment number. The unique number that identifies the LAN to which the network server is attached.

Serviceability options (SRVOPT). A value that is specified for serviceability options. The value must be provided by a service provider. (See the SRVOPT parameter in the CRTLINETH command.)

Set modem to ASYNC command (SETMDMASC). The V25BIS command that is used to set the modem to ASYNC mode. (See the SETMDMASC parameter in the CRTLINASC or CRTLINPPP command.)

Short frame (SHORTFRAME). The level of error threshold monitoring done by the system for short frame errors. (See the SHORTFRAME parameter in the CRTLINIDLC command.)

Exceptions:

Note: This field is no longer supported as of V5R3M0.

SHM access code (SHMACC). The access code used by an X.21 short-hold mode (SHM) line when calling a system on another network. (See the SHMACC parameter in the CRTLINSDLC command.)

SHM answer delay timer (SHMANSDLY). The length of time the system waits for controllers to call in before attempting to call out. (See the SHMANSDLY parameter in the CRTLINSDLC command.)

Exception:

SHM call format (SHMCALLFMT). The format of the network identifier used in the local system's connection number. (See the SHMCALLFMT parameter in the CRTLINSDLC command.)

SHM call timer (SHMCALLTMR). The interval at which a connection is reestablished on an X.21 short-hold mode line to verify the state of the remote system if no normal data traffic occurs in the specified interval. (See the SHMCALLTMR parameter in the CRTLINSDLC command.)

Exception:

SHM maximum connect timer (SHMMAXCNN). The length of time the system allows connection to any one controller when there are more controllers than there are available ports. (See the SHMMAXCNN parameter in the CRTLINSDLC command.)

Exception:

SHM node type (SHMNODE). The physical unit type of the controllers using the X.21 short-hold mode line. (See the SHMNODE parameter in the CRTLINSDLC command.)

Short retry (SHORTRTY). The number of retry attempts that the system makes during a burst of call retries. (See the SHORTRTY parameter in the CRTLINSDLC command.)

Short timer (SHORTTMR). The length of time that the system waits between retry attempts when processing a connection request. (See the SHORTTMR parameter in the CRTLINSDLC command.)

SSAP address. The hexadecimal logical channel address that is used to route data off the line to the proper user.

SSAP maximum frame. The largest frame size allowed on this source service access point (SSAP).

Exception:

SSAP type. The type of communications used by the system on this SSAP.

Station address (STNADR). The address used by the remote control station to poll the system. (See the STNADR parameter in the CRTLINBSC or CRTLINSDLC command.)

Stop bits (STOPBITS). The number of bits to be added to the end of each character to keep the local and remote ends of the line synchronized. (See the STOPBITS parameter in the CRTLINASC command.)

Switched connection type (SWTCNN). Whether the line can be used for incoming and outgoing calls, incoming calls only, or outgoing calls only. (See the SWTCNN parameter in the CRTLINASC, CRTLINBSC, CRTLINPPP, CRTLINSDLC, or CRTLINX25 command.)

Switched controller name. The name of a controller associated with this line.

Switched disconnect (SWTDSC). For switched lines (CNN(*SWTPP)), whether the line is to be dropped when no virtual circuits are active and the disconnection timers specified on the SWTDSCTMR parameter have expired. (See the SWTDSC parameter in the CRTLINX25 command.)

Switched disconnect timers (SWTDSCTMR). The timers used for disconnecting switched lines from a network or remote system. The timer values are returned in two separate fields:

(See the SWTDSCTMR parameter in the CRTLINX25 command.)

Switched network backup (SNBU). Whether or not you want the switched network backup capability. (See the SNBU parameter in the CRTLINASC, CRTLINBSC or CRTLINSDLC command.)

Switched NWI selection (SWTNWISLCT). The method used to select network interface (NWI) descriptions from the switched NWI list. (See the SWTNWISLCT parameter in the CRTLINPPP, or CRTLINX25 command.)

Note: This field is no longer supported as of V5R3M0.

SYN characters (SYNCCHARS). The number of SYN characters used to establish and maintain synchronization and as time-fill characters in the absence of any data or other control character. (See the SYNCCHARS parameter in the CRTLINBSC command.)

Text description (TEXT). A brief description of the line and its location. (See the TEXT parameter in the CRTLINASC, CRTLINBSC, CRTLINDDI, CRTLINETH, CRTLINFAX, CRTLINFR, CRTLINPPP, CRTLINSDLC, CRTLINTDLC, CRTLINTRN, CRTLINWLS, or CRTLINX25 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:

Token-ring inform of beacon (TRNINFBCN). Whether the token-ring network manager for this line is to provide notification of beaconing on the ring to the system operator. (See the TRNINFBCN parameter in the CRTLINTRN command.)

Token rotation time. The token rotation time requested when the line was created. (See the TKNRTTTIME parameter in the CRTLINDDI command.)

Exception:

Transmit TTD or WACK retry (TMTRTY). The number of times that a temporary-text-delay (TTD) or wait-before-transmit-positive acknowledgement (WACK) control character is sent to hold up the line when the system is not ready to respond to the remote end. (See the TMTRTY parameter in the CRTLINBSC command.)

Exception:

Transmit underrun (UNDERRUN). The level of error threshold monitoring done by the system for transmit underrun errors. (See the UNDERRUN parameter in the CRTLINIDLC command.)

Exceptions:

Note: This field is no longer supported as of V5R3M0.

TRLAN manager logging level (TRNLOGLVL). The logging level to be used by the token-ring network manager. This information is returned in two separate fields:

(See the TRNLOGLVL parameter in the CRTLINTRN command.)

TRLAN manager mode (TRNMGRMODE). Whether the token-ring network manager for this line is operating in observing or controlling mode. (See the TRNMGRMODE parameter in the CRTLINTRN command.)

Use LECS address (USELECSADR). Specifies whether the local system contacts the LAN emulation server (LES) address. (See the USELECSADR parameter in the CRTLINETH or CRTLINTRN command.)

Note: This field is no longer supported as of V5R3M0.

Type of parity (PARITY). The type of parity for error checking. (See the PARITY parameter in the CRTLINASC command.)

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

(See the RMTINTNETA parameter in the CRTLINASC or CRTLINPPP command.)End of change

User-defined 1, 2, and 3 (USRDFN1, USRDFN2, USRDFN3). Used to describe any unique characteristics of the line that you want to control. (See the USRDFN1, USRDFN2, or USRDFN3 parameter in the CRTLINDDI, CRTLINETH, CRTLINFR, CRTLINSDLC, CRTLINTRN, CRTLINWLS, or CRTLINX25 command.)

Vary on wait (VRYWAIT). Whether the line is varied on synchronously or asynchronously. (See the VRYWAIT parameter in the CRTLINASC, CRTLINBSC, CRTLINDDI, CRTLINETH, CRTLINFAX, CRTLINFR, CRTLINPPP, CRTLINSDLC, CRTLINTRN, CRTLINWLS, or CRTLINX25 command.)

Exception:

Virtual hardware. Specifies whether a real Ethernet line or a virtual Ethernet LAN adapter is associated with the line description.

X.25 DCE support (X25DCE). Allows the system to communicate directly with another system without going through an X.25 network. (See the X25DCE parameter in the CRTLINX25 command.)

XOFF character (XOFFCHAR). The hexadecimal value used to tell your line to stop sending data. (See the XOFFCHAR parameter in the CRTLINASC command.)

XON character (XONCHAR). The hexadecimal value used to tell your line to start sending data. (See the XONCHAR parameter in the CRTLINASC command.)


Error Messages


API introduced: V2R3