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.

Start of changeNotes:


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:

Start of changeNotes:

  • Formats LIND0600 and LIND0700 are no longer supported as of V5R3M0.
  • Formats LIND0800, LIND0900, LIND1000, LIND1100, LIND1200, LIND1300, LIND1400 and LIND1500 are no longer supported as of V7R4M0. Formats are documented in prior release.
End of change

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.



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

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

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. Start of change(4)End of change

ATM access type (ACCTYPE). The type of access to the ATM network. Start of change(3)End of change

Autoanswer (AUTOANS). Whether you intend to use your modem's automatic answer function. (See the AUTOANS parameter in the Start of changeCRTLINASC or CRTLINBSCEnd of change command.)

Autoanswer type (AUTOANSTYP). The method to be used by the system and modem to answer incoming calls. (See the AUTOANSTYP parameter in the Start of changeCRTLINASC or CRTLINBSCEnd of change 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 Start of changeCRTLINASC or CRTLINBSCEnd of change command.)

Autocall unit (AUTOCALL). An associated automatic call unit. (See the AUTOCALL parameter in the Start of changeCRTLINASC or CRTLINBSCEnd of change 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. Start of change(4)End of change

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. Start of change(4)End of change

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 Start of changeCRTLINASC or CRTLINBSCEnd of change 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.)

Calling number (CALLNBR). The local connection number of a line. (See the CALLNBR parameter in the Start of changeCRTLINASC, CRTLINBSC, or CRTLINPPPEnd of change 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 Start of changeCRTLINASC, CRTLINBSC, or CRTLINPPPEnd of change command.)

Exception:

Clocking (CLOCK). The clocking function for the line is provided by the modem (*MODEM). (See the CLOCK parameter in the Start of changeCRTLINBSC or CRTLINPPPEnd of change command.)

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

Connection type (CNN). The type of line connection. (See the CNN parameter in the Start of changeCRTLINASC, CRTLINBSC, or CRTLINPPPEnd of change 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 Start of changeCRTLINASC or CRTLINBSCEnd of change 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 Start of changeCRTCTLAPPC, CRTCTLLWS, or CRTCTLTAPEnd of change command.)

Cost per byte (COSTBYTE). The relative cost per byte of sending and receiving data on the line. Start of change(4)End of change

Exception:

Cost per connect time (COSTCNN). The relative cost of being connected on the line. Start of change(4)End of change

Exception:

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 Start of changeCRTLINASC, CRTLINBSC, or CRTLINETHEnd of change command.)

Note: Start of changeFor an Ethernet line description using a virtual Ethernet LAN adapter, a value of *AUTO is returned. Otherwise, theEnd of change value *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 Start of changeCRTLINASC, CRTLINBSC, CRTLINETH, or CRTLINPPPEnd of change command.)

Exceptions:

Note: Start of changeFor an Ethernet line description using a virtual Ethernet LAN adapter, a value of *AUTO is returned. Otherwise, theEnd of change 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 Start of changeCRTLINETH or CRTLINPPPEnd of change 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 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 Start of changeCRTLINASC or CRTLINBSCEnd of change 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:

Dial command type (DIALCMD). The dial command type used to establish a connection with a remote system. (See the DIALCMD parameter in the Start of changeCRTLINASC, CRTLINBSC, or CRTLINPPPEnd of change command.)

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

(See the DUPLEX parameter in the Start of changeCRTLINASC, CRTLINBSC, or CRTLINETHEnd of change 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. Start of change(3)End of change

Enable for TCP/IP (TCPONLY). Whether you want the line description to be used for TCP/IP only. Start of change(2)End of change

Note: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 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. Start of change(3)End of change

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. Start of change(4)End of change

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 Start of changeCRTLINASC or CRTLINBSCEnd of change command.)

Ethernet standard (ETHSTD). The standard used by the Ethernet local area network. (See the ETHSTD parameter in the Start of changeCRTLINETHEnd of change command.)

Exchange identifier (EXCHID). The exchange identifier that the local system can send to the remote controller or system. Start of change(4)End of change

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

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

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. Start of change(4)End of change

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 Start of changeCRTLINASCEnd of change command.)

Inactivity timer (INACTTMR). The time that the system waits for activity on a line before disconnecting. (See the INACTTMR parameter in the Start of changeCRTLINASC, CRTLINBSC, or CRTLINPPPEnd of change 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. Start of change(3)End of change

Information transfer type (INFTRFTYPE). How data is to be encoded for the ISDN B-channel associated with this line description. Start of change(3)End of change

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

LAN emulation client frame size (LECFRAME). The LAN emulation client (LEC) frame size. Start of change(3)End of change

Exception:

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

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. Start of change(3)End of change

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. Start of change(3)End of change

Exception:

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.

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 Start of changeCRTLINASC, CRTLINBSC, CRTLINETH, or CRTLINPPPEnd of change 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). Start of change(4)End of change

Exceptions:

Note: For Ethernet (LIND0500), 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), 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. Start of change(3)End of change

Local adapter address (ADPTADR). The address used by the adapter for this line to transmit from and answer to on the Start of changeLAN.End of change

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. Start of change(4)End of change

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 Start of changeCRTLINETH or CRTLINPPPEnd of change command.)

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 Start of changeCRTLINETH or CRTLINPPPEnd of change 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 Start of changeCRTLINASC or CRTLINBSCEnd of change command.)

Modem initialization command string (MDMINZCMD). The command string to send to set the modem. (See the MDMINZCMD parameter in the Start of changeCRTLINASC or CRTLINPPPEnd of change command.)

Modem type supported (MODEM). The type of modem diagnostic tests to be used on the line. (See the MODEM parameter in the Start of changeCRTLINASC or CRTLINBSCEnd of change command.)

Network controller (NETCTL). The name of an existing network controller description. (See the NETCTL parameter in the Start of changeCRTLINETH or CRTLINPPPEnd of change command.)

Network interface DLC identifier. The data link control (DLC) identifier used to connect to the network. Start of change(4)End of change

Network server description (NWS). The name of the network server to which the nonswitched line is attached. (See the NWS parameter in the Start of changeCRTLINETHEnd of change 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 Start of changeCRTLINPPPEnd of change 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 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. Start of change(3)End of change

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. Start of change(4)End of change

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 Start of changeCRTLINPPPEnd of change command.) Start of change(4)End of change

NWI name. The name of the existing network interface description. Start of change(4)End of change

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 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. Start of change(3)End of change

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. Start of change(4)End of change

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 Start of changeCRTLINASC, CRTLINBSC, CRTLINETH, or CRTLINPPPEnd of change 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. Start of change(3)End of change

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. Start of change(3)End of change

PVC identifiers (PVCID). Specifies the virtual path identifier and virtual circuit ID. Start of change(3)End of change

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 Start of changeCRTLINASC, CRTLINBSC, or CRTLINPPPEnd of change command.)

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

Exceptions:

Propagation delay (PRPDLY). The time required for a signal to travel from one end of a link to the other end. Start of change(4)End of change

Start of changeRDMA adapter. Specifies whether an Ethernet line description is configured for a Remote Direct Memory Access (RDMA) adapter.

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 Start of changeCRTLINASC, CRTLINBSC, CRTLINETH, or CRTLINPPPEnd of change command.)

Exception:

LES ATM address (LESATMADR). Specifies the ATM network address of the remote LAN emulation server. This address is returned in three separate fields: Start of change(3)End of change

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 Start of changeCRTLINASC, CRTLINBSC, or CRTLINPPPEnd of change command.)

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

Reported emulated LAN name. The reported emulated LAN name. Start of change(3)End of change

Reserved. Space included for alignment.

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 Start of changeCRTLINASC, CRTLINBSC, CRTLINETH, or CRTLINPPPEnd of change command.)

Security for line (SECURITY). The types of security protection available on the line. Start of change(4)End of change

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

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 Start of changeCRTLINBSCEnd of change 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 Start of changeCRTLINASC, CRTLINBSC, or CRTLINPPPEnd of change command.)

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

Switched network backup (SNBU). Whether or not you want the switched network backup capability. (See the SNBU parameter in the Start of changeCRTLINASC or CRTLINBSCEnd of change command.)

Switched NWI selection (SWTNWISLCT). The method used to select network interface (NWI) descriptions from the switched NWI list. Start of change(4)End of change

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 Start of changeCRTLINASC, CRTLINBSC, CRTLINETH, or CRTLINPPPEnd 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:

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:

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

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

User-defined 1, 2, and 3 (USRDFN1, USRDFN2, USRDFN3). Used to describe any unique characteristics of the line that you want to control. Start of change(4)End of change

Vary on wait (VRYWAIT). Whether the line is varied on synchronously or asynchronously. (See the VRYWAIT parameter in the Start of changeCRTLINASC, CRTLINBSC, CRTLINETH, or CRTLINPPPEnd of change command.)

Exception:

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

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