The Retrieve Line Description Point to Point Protocol (PPP) tool
retrieves information about a PPP line. Because many parameters
exist, 2 commands are provided (RTVLINPPP and RTVLINPPP2). This
provides the current information about the line. The QDCRLIND API is
used to retrieve the data.
A typical command would be:
DCL &LINESPEED *DEC LEN(9 0)
.
RTVLINPPP LINE(xxx) LINESPEED(&LINESPEED)
RTVLINPPP escape messages you can monitor for
---------------------------------------------
TAA9891 The line is not a PPP type.
Escape messages from based on functions will be re-sent.
RTVLINPPP2 escape messages you can monitor for
----------------------------------------------
TAA9891 The line is not a PPP type.
Escape messages from based on functions will be re-sent.
RTVLINPPP Command parameters *CMD
----------------------------
LIND The Point-to-Point Protocol (PPP) line to retrieve
information for.
ONLINE Whether the line is varied on at IPL. This is an
optional return variable that if used must be
specified as *CHAR LEN(4).
VARYWAIT Whether the line should be varied on at IPL. A
value of -15 = *NOWAIT. This is an optional return
variable that if used must be specified as *DEC
LEN(9 0).
LINESPEED The speed of the line in bits per second. This is
an optional return variable that if used must be
specified as *DEC LEN(9 0).
MAXFRAME The maximum frame size or logical link control data
unit that can be transmitted and received on this
line. This is an optional return variable that if
used must be specified as *DEC LEN(9 0).
INACTTMR The time that the system waits for activity on a
line before disconnecting. This is an optional
return variable that if used must be specified as
*DEC LEN(9 0).
RMTANSTMR The length of time that the system should wait for
the modem (DCE) to raise Data Set Ready (DSR) after
dialing before signalling an error. This is an
optional return variable that if used must be
specified as *DEC LEN(9 0).
CTSTMR The length of time that the system should wait for
the modem (DCE) to raise or drop Clear to Send (CTS)
before signalling an error. This is an optional
return variable that if used must be specified as
*DEC LEN(9 0).
CMNRCYLMTC The number of second-level recovery attempts to be
automatically performed. This is an optional return
variable that if used must be specified as *DEC
LEN(9 0).
CMNRCYLMTI The length of time in minutes in which the specified
number of recoveries can be attempted. This is an
optional return variable that if used must be
specified as *DEC LEN(9 0).
LCPAUT The number of link control protocol authentication
values. This is an optional return variable that if
used must be specified as *DEC LEN(9 0).
LCPAUTATMP The maximum number of unacknowledged authentication
challenges to a remote peer before assuming that the
peer is unable to respond. This is an optional
return variable that if used must be specified as
*DEC LEN(9 0).
LCPAUTTMR Specifies the interval in minutes to periodically
issue an authentication challenge to the remote
peer. This is an optional return variable that if
used must be specified as *DEC LEN(9 0).
LCPCFGFAIL Specifies the maximum number of attempts that are
made to negotiate a mutually acceptable
configuration with a remote peer before assuming
that the configuration is not converging. This is
an optional return variable that if used must be
specified as *DEC LEN(9 0).
LCPCFGMAXR Specifies the maximum number of unacknowledged
configuration requests sent to a remote peer before
assuming that the peer is unable to respond. This
is an optional return variable that if used must be
specified as *DEC LEN(9 0).
LCPCFGMAXT Specifies the interval in seconds, that the system
waits before resending an unacknowledged
configuration, termination, or authentication
challenge to a remote peer. This is an optional
return variable that if used must be specified as
*DEC LEN(9 0).
LCPCFGTMR Specifies the interval in seconds to periodically
issue an authentication challenge to the remote
peer. This is an optional return variable that if
used must be specified as *CHAR LEN(10).
ACCM The 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. This is an optional return variable that
if used must be specified as *CHAR LEN(10).
RSRCNAME The unique name that is assigned by the system to
the physical equipment attached to the system. This
is an optional return variable that if used must be
specified as *CHAR LEN(10).
INTERFACE The type of physical communications line interface
that this communications adapter port and cable will
be attached to. This is an optional return variable
that if used must be specified as *CHAR LEN(10).
FRAMING Specifies whether the line uses asynchronous or
synchronous framing. This is an optional return
variable that if used must be specified as *CHAR
LEN(10).
CNN The type of line connection. This is an optional
return variable that if used must be specified as
*CHAR LEN(10).
NETCTL The name of an existing network controller
description. This is an optional return variable
that if used must be specified as *CHAR LEN(10).
NRZI Whether the system uses the non-return-to-zero
inverted (NRZI) transmission coding method. This is
an optional return variable that if used must be
specified as *CHAR LEN(10).
SWTCNN Whether the line can be used for incoming and
outgoing calls, incoming calls only, or outgoing
calls only. This is an optional return variable
that if used must be specified as *CHAR LEN(10).
CLOCK Whether the clocking function for the line is
provided by the modem (*MODEM). This is an optional
return variable that if used must be specified as
*CHAR LEN(10).
DIALCMD The dial command type used to establish a connection
with a remote system. This is an optional return
variable that if used must be specified as *CHAR
LEN(10).
SETMDMASC The V25BIS command that is used to set the modem to
ASYNC mode. This is an optional return variable
that if used must be specified as *CHAR LEN(40).
CALLNBR The local connection number of a line. This is an
optional return variable that if used must be
specified as *CHAR LEN(32).
FLOWCNTL Whether XON or XOFF flow control characters exist to
control the flow of data to the system. This is an
optional return variable that if used must be
specified as *CHAR LEN(10).
NWI The name of the existing network interface
description. This is an optional return variable
that if used must be specified as *CHAR LEN(10).
NWICHLNBR The network interface channel to be used by the line
description. This is an optional return variable
that if used must be specified as *CHAR LEN(10).
INFTFRTYPE How the data is to be encoded for the ISDN B-channel
associated with the line description. This is an
optional return variable that if used must be
specified as *CHAR LEN(13).
NBRSWTNWI The number of switched NWIs. This is an optional
return variable that if used must be specified as
*DEC LEN(9 0).
SWTNWIS The list of switched NWIs. A maximum of 10 will be
returned. Each entry is 32 bytes made up of NWI
name (10 bytes), NWI channel type (10 bytes), NWI
channel number (10 bytes), and reserved (2 bytes).
This is an optional return variable that if used
must be specified as *CHAR LEN(320).
TEXT The text description of the line. This is an
optional return variable that if used must be
specified as *CHAR LEN(50).
RTVLINPPP2 Command parameters *CMD
-----------------------------
LIND The Point-to-Point Protocol (PPP) line to retrieve
information for.
CNNLSTOUT Specifies for ISDN/T1 switched connections, the name
of the connection list object that contains the
ISDN/T1 assigned numbers for dial out. The
parameter is not supported after V5R3. This is an
optional return variable that if used must be
specified as *CHAR LEN(10).
CNNLSTOUTE Specifies for ISDN/T1 switched connections, the
entry name from the connection list used to make a
call to the ISDN/T1. The parameter is not supported
after V5R3. This is an optional return variable
that if used must be specified as *CHAR LEN(10).
CNNLSTIN Specifies for ISDN/T1 switched connections, the name
of the connection list that is used to retrieve call
information for identifying incoming calls. The
parameter is not supported after V5R3. This is an
optional return variable that if used must be
specified as *CHAR LEN(10).
SWTNWISLCT The method used to select network interface (NWI)
descriptions from the switched NWI list.
COMPRESS The compression function provided. This is an
optional return variable that if used must be
specified as *CHAR LEN(10).
MSGQ The message queue to which operational messages are
normally sent. This is an optional return variable
that if used must be specified as *CHAR LEN(10).
MSGQLIB The message queue library to which operational
messages are normally sent. This is an optional
return variable that if used must be specified as
*CHAR LEN(10).
CURMSGQ The message queue to which operational messages are
currently being sent. This is an optional return
variable that if used must be specified as *CHAR
LEN(10).
CURMSGQLIB The message queue library to which operational
messages are currently being sent. This is an
optional return variable that if used must be
specified as *CHAR LEN(10).
MDMINZCMD The command string to send to set the modem. This
is an optional return variable that if used must be
specified as *CHAR LEN(60).
Restrictions
------------
Because the commands return variables, RTVLINPPP and RTVLINPPP2 may
only be used in a CL program.
Prerequisites
-------------
The following TAA Tools must be on your system:
SNDESCINF Send escape information
SNDESCMSG Send escape message
Implementation
--------------
None, the tool is ready to use.
Objects used by the tool
------------------------
Object Type Attribute Src member Src file
------ ---- --------- ---------- ----------
RTVLINPPP *CMD TAACFGO QATTCMD
RTVLINPPP2 *CMD TAACFGO2 QATTCMD
TAACFGOC *PGM CLP TAACFGOC QATTCL
TAACFGOC2 *PGM CLP TAACFGOC2 QATTCL
Structure
---------
RTVLINPPP Cmd
TAACFGOC CL pgm
RTVLINPPP2 Cmd
TAACFGOC2 CL pgm
|