TAA Tools
RTVCTLASC       RETRIEVE CONTROLLER DESCRIPTION ASYNC  TAACFGS

The Retrieve  Controller Description  ASYNC tool retrieves  information
about an  ASYNC controller.  Because many  parameters exist, 2 commands
are  provided (RTVCTLASC, and  RTVCTLASC2).  This  provides the current
information  about  the controller.    The  QDCRCTLD  API  is  used  to
retrieve the data.

A typical command would be:

             DCL        &NBRDEV *DEC LEN(5 0)
              .
             RTVCTLASC2 CTLD(xxx) NBRDEV(&NBRDEV)

RTVCTLASC escape messages you can monitor for
---------------------------------------------

      TAA9891    The controller is not a *ASC type.

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

RTVCTLASC command parameters                          *CMD
----------------------------

   CTLD          The local  ASYNC controller name.   It must be  a *ASC
                 type.

   ONLINE        The  type of online  request for  IPL.  A  *YES or *NO
                 will  be  returned.    This  is  an   optional  return
                 variable  that if  used  must  be specified  as  *CHAR
                 LEN(4).

   PREDIALDLY    The length  of time to wait  before dialing the number
                 to   establish   a   connection   to   the   specified
                 controller.    This is  an  optional  return  variable
                 that if used must be specified as *DEC LEN(9 0).

   REDIALDLY     The  length  of time  to  wait  before re-dialing  the
                 number  to  establish  a connection  to  the specified
                 controller if the  previous attempt was  unsuccessful.
                 This  is  an optional  return  variable  that if  used
                 must be specified as *DEC LEN(9 0).

   DIALRTY       The   number  of   times   to  retry   dialing  before
                 considering that the  dialing is  unsuccessful.   This
                 is an  optional return variable  that if used  must be
                 specified as *DEC LEN(9 0).

   ACKTMR        The  time allowed  in  seconds for  an acknowledgement
                 when  using  file  transfer  support.    This  is   an
                 optional  return  variable   that  if  used   must  be
                 specified as *DEC LEN(9 0).

   RETRY         The number  of attempts to  transmit a frame  after an
                 unsuccessful  transmission  when  using  file transfer
                 support.   This is  an optional  return variable  that
                 if used must be specified as *DEC LEN(9 0).

   DFTPKTSIZT    The  default  packet  size   to  use  on  the  virtual
                 circuit    represented   by    this   controller   for
                 transmission.   This is  an optional  return  variable
                 that if used must be specified as *DEC LEN(9 0).

   DFTPKTSIZR    The  default  packet  size   to  use  on  the  virtual
                 circuit    represented   by   this    controller   for
                 receiving.  This is  an optional return variable  that
                 if used must be specified as *DEC LEN(9 0).

   NGTPKTSIZT    The  negotiated packet  size  to  use on  the  virtual
                 circuit    represented   by   this    controller   for
                 transmission.    This is  an optional  return variable
                 that if used must be specified as *DEC LEN(9 0).

   NGTPKTSIZR    The  negotiated packet  size  to  use on  the  virtual
                 circuit   represented    by   this    controller   for
                 receiving.   This is an  optional return variable that
                 if used must be specified as *DEC LEN(9 0).

   DFTWDWSIZT    The  default  window  size  to  use  on   the  virtual
                 circuit   represented    by   this    controller   for
                 transmission.   This  is  an optional  return variable
                 that if used must be specified as *DEC LEN(9 0).

   DFTWDWSIZR    The  default  window  size  to  use  on  the   virtual
                 circuit   represented    by   this   controller    for
                 receiving.   This is an optional  return variable that
                 if used must be specified as *DEC LEN(9 0).

   NGTWDWSIZT    The  negotiated  window  size to  use  on  the virtual
                 circuit   represented    by   this   controller    for
                 transmission.   This  is an  optional return  variable
                 that if used must be specified as *DEC LEN(9 0).

   NGTWDWSIZR    The  negotiated  window  size to  use  on  the virtual
                 circuit   represented   by    this   controller    for
                 receiving.  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 second-level
                 recovery  will  be  performed.   This  is  an optional
                 return variable  that  if used  must  be specified  as
                 *DEC LEN(9 0).

   LINKTYPE      The  type of  link  this controller  will be  attached
                 to.    This is  an  optional return  variable  that if
                 used must be specified as *CHAR LEN(10).

   SWITCHED      Whether the  controller  is  attached  to  a  switched
                 line,  a  local  area network,  or  an  X.25  switched
                 virtual  circuit  connection.    This  is an  optional
                 return variable  that if  used  must be  specified  as
                 *CHAR LEN(10).

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

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

   LINE          The  name of  the line  description that  connects the
                 network  to  the line.    This is  an  optional return
                 variable that  if  used  must be  specified  as  *CHAR
                 LEN(10).

   INLCNN        Whether  the initial  switched connection  is made  by
                 the  system when it answers  an incoming call  or by a
                 call started from  the system.   This  is an  optional
                 return  variable that  if used  must  be specified  as
                 *CHAR LEN(10).

   CNNNBR        The  number of  the remote  controller that  is called
                 from  the system to  establish a connection.   This is
                 an  optional return  variable  that  if used  must  be
                 specified as *CHAR LEN(32).

   ANSNBR        The   X.25   network   addresses   from   which   this
                 controller  can  accept calls.   This  is  an optional
                 return variable  that if  used  must be  specified  as
                 *CHAR LEN(10).

   ACTX25        The current  X.25 network address  for an  active X.25
                 controller  description.   This is an  optional return
                 variable that  if  used  must be  specified  as  *CHAR
                 LEN(10).

   SWTDSC        Whether the  switched connection  is dropped when  the
                 last session  is unbound and the  disconnect timer has
                 ended.   This is  an optional return  variable that if
                 used must be specified as *CHAR LEN(10).

   RMTVFY        Whether a  remote system  requires  verification if  a
                 generic  controller  and   device  are  configured  to
                 accept  calls from any X.25 network  address.  This is
                 an optional  return  variable  that if  used  must  be
                 specified as *CHAR LEN(10).

   LCLLOCNAME    The  name   which,  when   combined  with   the  local
                 identifier,  identifies  the  controller  to a  remote
                 system.  This is an  optional return variable that  if
                 used must be specified as *CHAR LEN(10).

   LCLID         The  name   which,  when   combined  with  the   local
                 identifier,  identifies  the  controller to  a  remote
                 system.   This is an  optional return variable that if
                 used must be specified as *CHAR LEN(10).

   PADEML        Whether or not  the controller is  to emulate an  X.25
                 packet  assembler/disassembler.   This is  an optional
                 return  variable  that if  used must  be  specified as
                 *CHAR LEN(10).

   LGLCHLID      The logical  channel identifier  that  is to  be  used
                 for  the  controller.   This  is  an  optional  return
                 variable  that  if used  must  be  specified as  *CHAR
                 LEN(10).

   SWTLINSLCT    Which line will  be selected for  making the  switched
                 connection.    This is  an  optional  return  variable
                 that if used must be specified as *CHAR LEN(10).

   USRGRPID      The  value which  is supplied  as a  unique identifier
                 by  the network if  the closed user  group facility is
                 subscribed to.   This is  an optional return  variable
                 that if used must be specified as *CHAR LEN(10).

   RVSCRG        For incoming  calls, whether reverse  charging will be
                 accepted,  and  for  outgoing  calls, whether  reverse
                 charging will  be  requested.   This  is  an  optional
                 return  variable that  if  used must  be specified  as
                 *CHAR LEN(10).

   USRFCL        Allows   network  subscribers   to   request  supplied
                 facilities that are not  available through the  system
                 parameters.    This is  an  optional  return  variable
                 that if used must be specified as *CHAR LEN(218).


RTVCTLASC2 command parameters                         *CMD
-----------------------------

   CTLD          The local  ASYNC controller name.   It must  be a *ASC
                 type.

   MSGQ          The  name of  the message  queue used  for operational
                 messages.   This is an  optional return variable  that
                 if used must be specified as *CHAR LEN(10).

   MSGQLIB       The  name  of  the  message  queue  library  used  for
                 operational  messages.   This  is  an  optional return
                 variable that  if  used  must be  specified  as  *CHAR
                 LEN(10).

   CURMSGQ       The  name  of  the  current  message  queue  used  for
                 operational  messages.   This  is  an  optional return
                 variable that  if  used  must be  specified  as  *CHAR
                 LEN(10).

   CURMSGQLIB    The name  of the  current message  queue library  used
                 for  operational  messages.     This  is  an  optional
                 return  variable  that if  used  must be  specified as
                 *CHAR LEN(10).

   SYSJOB        The  name  of  the  system  job  associated  with  the
                 controller.    This  is  an optional  return  variable
                 that if used must be specified as *CHAR LEN(10).

   NBRDEV        The  number  of devices  attached  to  the controller.
                 This is  an  optional  return variable  that  if  used
                 must be specified as *DEC LEN(5 0).

   DEVICES       A list of  the devices attached to the  controller.  A
                 maximum  of 300 devices  exists with  each device name
                 10 bytes  in length.   The  remainder of  the area  is
                 filled  with  blanks.   This  is  an  optional  return
                 variable  that  if used  must  be  specified as  *CHAR
                 LEN(3000).

   NBRSWTLIN     The   number  of   switched  lines   attached  to  the
                 controller.    This is  an  optional  return  variable
                 that if used must be specified as *DEC LEN(5 0).

   SWTLIN        A  list   of  the  switched  lines   attached  to  the
                 controller.   A maximum  of 300  switched lines exists
                 with  each  line  name  10  bytes  in  length.     The
                 remainder of  the area  is filled  with blanks.   This
                 is  an optional return  variable that if  used must be
                 specified as *CHAR LEN(3000).

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


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

Because RTVCTLASC  commands return variables, they 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
   ------        ----    ---------      ----------    ----------

   RTVCTLASC     *CMD                   TAACFGS       QATTCMD
   RTVCTLASC2    *CMD                   TAACFGS2      QATTCMD
   TAACFGSC      *PGM       CLP         TAACFGSC      QATTCL
   TAACFGSC2     *PGM       CLP         TAACFGSC2     QATTCL

Structure
---------

RTVCTLASC  Cmd
  TAACFGSC   CL

RTVCTLASC2 Cmd
  TAACFGSC2  CL
					

Added to TAA Productivity tools September 15, 2007


Home Page Up to Top