TAA Tools
RTVLINSDLC      RETRIEVE LINE DESCRIPTION SDLC         TAACFGN

The Retrieve  Line Description  SDLC tool  retrieves information  about
an SDLC  line.  Because many parameters exist,  2 commands are provided
(RTVLINSDLC  and RTVLINSDL2).   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)
              .
             RTVLINSDLC LIND(xxx) LINESPEED(&LINESPEED)


RTVLINSDLC escape messages you can monitor for
----------------------------------------------

      TAA9891    The line is not an SDLC type.

Escape messages from based on functions will be re-sent.

RTVLINSDL2 escape messages you can monitor for
----------------------------------------------

      TAA9891    The line is not an SDLC type.

Escape messages from based on functions will be re-sent.

RTVLINSDLC Command parameters                         *CMD
-----------------------------

   LIND          The SDLC 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).

   MAXCTL        The   maximum  number  of  controllers   that  can  be
                 supported.  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).

   SHMCALLTMR    The  interval at which  a connection is re-established
                 on an X.21  short-hold mode line  to verify the  state
                 of  the remote  system.   This is  an  optional return
                 variable  that  if  used  must  be  specified as  *DEC
                 LEN(9 0).

   SHMMAXCNN     The length of  time the  system allows connections  to
                 any  one controller  when there  are more  controllers
                 than there  are available ports.   This is an optional
                 return variable  that if  used  must be  specified  as
                 *DEC LEN(9 0).

   SHMMAXDLY     The length  of time the  system waits  for controllers
                 to  call in before  attempting to  call out.   This is
                 an  optional  return  variable that  if  used  must be
                 specified as *DEC LEN(9 0).

   CNNPOLLRTY    The  number of  connect  poll  retries  that  will  be
                 attempted  before the  system  indicates  an error  in
                 contacting  a remote  system or  controller.   This is
                 an optional  return  variable  that if  used  must  be
                 specified as *DEC LEN(9 0).

   CNNTMR        The  length of  time  that the  system  waits for  the
                 response  to a  poll while  in normal  disconnect mode
                 before  polling  the  next   station.    This  is   an
                 optional  return  variable   that  if  used   must  be
                 specified as *DEC LEN(9 0).

   SHORTTMR      The  length  of time  that  the  system waits  between
                 retry  attempts when processing  a connection request.
                 This  is an  optional  return  variable that  if  used
                 must be specified as *DEC LEN(9 0).

   LONGTMR       The  length  of time  that  the  system waits  between
                 connection  retry  attempts.    This  is  an  optional
                 return variable  that if  used  must be  specified  as
                 *DEC LEN(9 0).

   SHORTRTY      The number of  retry attempts the system  makes during
                 a burst  of call retries.  This  is an optional return
                 variable that  if  used  must  be  specified  as  *DEC
                 LEN(9 0).

   LONGRTY       The number of  bursts of call retry attempts  that the
                 system  makes  when processing  a  connection attempt.
                 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).

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

   POLLRSPDLY    The maximum  duration of  time that  the system  waits
                 before  it responds  to a  data  poll if  there is  no
                 information  frame to transmit.   This  is an optional
                 return variable  that if  used  must be  specified  as
                 *DEC LEN(9 0).

   NPRDRCVTMR    The  time that  the system  waits for  either a  final
                 frame  or an idle  signal while  the secondary station
                 is continuously  transmitting.   This is  an  optional
                 return  variable that  if used  must  be specified  as
                 *DEC LEN(9 0).

   IDLTMR        The  maximum  allowable  time  that the  system  waits
                 between  characters  before the  adapter  forwards the
                 receive buffer  to the system.   This  is an  optional
                 return  variable that  if  used must  be specified  as
                 *DEC LEN(9 0).

   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.    This   is  an
                 optional   return  variable  that  if   used  must  be
                 specified as *DEC LEN(9 0).

   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.   This
                 is  an optional return  variable that if  used must be
                 specified as *DEC LEN(9 0).

   FRAMERTY      The   number  of   retries   for  an   unanswered   or
                 unacknowledged  frame.   This  is  an optional  return
                 variable  that  if  used  must  be  specified as  *DEC
                 LEN(9 0).

   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.  This  is an optional  return variable  that
                 if used must be specified as *DEC LEN(9 0)

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

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

   LINKSPEED     The link  speed in  bits  per second.   The  following
                 special     values     exist     -5=*MIN,     -7=*MAX,
                 -12=*INTERFACE,   -23=10   million,   -24=4   million,
                 -25=16  million,  -29=100   million.     This  is   an
                 optional  return   variable  that  if  used   must  be
                 specified as *DEC LEN(9 0).

   COSTCNN       The  relative cost  of being connected  on line.   The
                 following special values  exist -9=*CNN.   This is  an
                 optional  return  variable   that  if  used   must  be
                 specified as *DEC LEN(9 0).

   COSTBYTE      The  relative cost per  byte of sending  and receiving
                 data  on  the  line.    The  following  special values
                 exist -9=*CNN.   This is  an optional return  variable
                 that if used must be specified as *DEC LEN(9 0).

   USRDFN1       Used  to described any  unique characteristics  of the
                 line.   This  is an  optional return variable  that if
                 used must be specified as *DEC LEN(9 0).

   USRDFN2       Used to described  any unique  characteristics of  the
                 line.   This is  an optional  return variable  that if
                 used must be specified as *DEC LEN(9 0).

   USRDFN3       Used  to described  any unique characteristics  of the
                 line.  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).

   NBRATTNON     The  number  of  attached  non-switched   controllers.
                 This  is an  optional  return  variable that  if  used
                 must be specified as *DEC LEN(9 0).

   ATTNONSW      The  list of attached non-switched  controllers.  Each
                 controller takes  10  bytes.    This  is  an  optional
                 return  variable that  if used  must  be specified  as
                 *CHAR LEN(3000).

   NBRACTCTL     The  number of active  switched controllers.   This is
                 an  optional  return  variable that  if  used  must be
                 specified as *DEC LEN(9 0).

   ACTSW         The  list  of  active  switched  controllers.     Each
                 controller  takes  10  bytes.   This  is  an  optional
                 return  variable  that if  used must  be  specified as
                 *CHAR LEN(3000).

   TEXT          The  text  description  of  the  line.    This  is  an
                 optional  return   variable  that  if  used   must  be
                 specified as *CHAR LEN(50).


RTVLINSDL2 Command parameters                         *CMD
-----------------------------

   LIND          The SDLC line to retrieve information for.

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

   CNN           The type  of line  connection.   This  is an  optional
                 return  variable that  if used  must  be specified  as
                 *CHAR LEN(10).

   SNBU          Whether   or   not   the   switched   network   backup
                 capability  exists.    This  is  an  optional   return
                 variable  that if  used  must  be specified  as  *CHAR
                 LEN(10).

   ACTSNBU       Whether  the  switched  network backup  capability  is
                 activated.   This is an  optional return variable that
                 if used must be specified as *CHAR LEN(10).

   SHMNODE       The physical unit  type of  the controllers using  the
                 X.21  short-hold  mode  line.   This  is  an  optional
                 return  variable  that if  used must  be  specified as
                 *CHAR LEN(10).

   AUTOCALL      An associated auto  call unit.   This  is an  optional
                 return  variable that  if  used must  be specified  as
                 *CHAR LEN(10).

   EXCHID        The  exchange  identifier that  the  local  system can
                 send to the remote controller  or system.  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).

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

   MODEM         The type  of modem diagnostic test  to be used  on the
                 line.   This  is an optional  return variable  that if
                 used must be specified as *CHAR LEN(10).

   MODEMRATE     Whether the  modem  is  being  operated  at  its  full
                 rated speed, or at  an alternate or half speed.   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  call,  incoming  calls  only,   or  outgoing
                 calls  only.   This  is  an  optional return  variable
                 that if used must be specified as *CHAR LEN(10).

   AUTOANS       Whether   to   use   the   modem's  automatic   answer
                 function.  This  is an  optional return variable  that
                 if used must be specified as *CHAR LEN(10).

   AUTODIAL      Whether  to use  the modem's  automatic call  function
                 to  dial the remote  system or network  to establish a
                 switched  line  connection.    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).

   ACRSCNAME     The  name  that  is   assigned  by  the  system  to  a
                 communications  port from which  a communications line
                 attaches to  an  automatic  call  unit.   This  is  an
                 optional  return   variable  that  if  used   must  be
                 specified as *CHAR LEN(10)

   SHMCALLFMT    The  format  of the  network  identifier  used in  the
                 local  system's  connection  number.     This  is   an
                 optional  return  variable   that  if  used   must  be
                 specified as *CHAR LEN(10).

   SHMACC        The  access  code  used  by  an X.21  short-hold  mode
                 (SHM)  line when calling a  system or another network.
                 This is  an  optional  return variable  that  if  used
                 must be specified as *CHAR LEN(10).

   CALLNBR       The local  connection number  of a line.   This  is an
                 optional   return  variable  that   if  used  must  be
                 specified as *CHAR LEN(10).

   STNADR        The address  used  by the  remote control  station  to
                 poll  the  system.     This  is  an   optional  return
                 variable  that  if  used must  be  specified  as *CHAR
                 LEN(10).

   THRESHOLD     The error  threshold level  that is  monitored by  the
                 system.  This  is an optional return variable  that if
                 used must be specified as *CHAR LEN(10).

   DUPLEX        For   WAN,   whether  the   system   will  leave   the
                 request-to-send  modem signal on  continuously or will
                 be  raised when  the  system  must transmit  data  and
                 dropped  when   finished.     For  LAN,   whether  the
                 hardware   is   able   to   send   and  receive   data
                 simultaneously.  This is  an optional return  variable
                 that if used must be specified as *CHAR LEN(10).

   MODULUS       Whether extended  sequence numbers  are used  (modulus
                 129) or  not (modulus 8).  This  is an optional return
                 variable that  if  used  must be  specified  as  *CHAR
                 LEN(10).

   AUTOANSTYP    The method  to  be used  by the  system  and modem  to
                 answer  incoming calls.   This  is an  optional return
                 variable  that  if  used must  be  specified  as *CHAR
                 LEN(10).

   SECURITY      The types  of  security  protection available  on  the
                 line.   This is  an optional  return variable  that if
                 used must be specified as *CHAR LEN(10).

   PRPDLY        The  time required  for  a signal  to travel  from one
                 end of a link to the  other end.  This is an  optional
                 return  variable that  if  used must  be specified  as
                 *CHAR LEN(10).

   AUTOCFGS36    Whether  the  line  was  auto  configured  for  AS/36.
                 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).

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

   NBRRSCS       The  number of  resource names.   This is  an optional
                 return variable  that if  used  must be  specified  as
                 *DEC LEN(9 0).

   RSCNAMES      The list  of resource  names with  each name 12  bytes
                 in length.   This is an optional  return variable that
                 if used must be specified as *CHAR LEN(1200).

   NBRPRGVAL     The  number  of  call  progress  signal  retry values.
                 This is  an  optional  return variable  that  if  used
                 must be specified as *DEC LEN(9 0).

   PRGVALUES     The  list of  call progress  signal retry  values with
                 each  value 12 bytes  in length.  This  is an optional
                 return variable  that  if used  must be  specified  as
                 *CHAR LEN(1200).


Restrictions
------------

Because the  commands return  variables, RTVLINSDLC and  RTVLINSDL2 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
   ------        ----    ---------      ----------    ----------

   RTVLINSDLC    *CMD                   TAACFGN       QATTCMD
   RTVLINSDL2     *CMD                  TAACFGN2      QATTCMD
   TAACFGNC      *PGM       CLP         TAACFGNC      QATTCL
   TAACFGNC2     *PGM       CLP         TAACFGNC2     QATTCL

Structure
---------

RTVLINSDLC  Cmd
   TAACFGNC   CL pgm

RTVLINSDL2  Cmd
   TAACFGNC2  CL pgm
					

Added to TAA Productivity tools September 15, 2007


Home Page Up to Top