TAA Tools
RTVSBSD         RETRIEVE SUBSYSTEM DESCRIPTION         TAASYSM

The Retrieve  Subsystem Description  command provides return  variables
for the information about a subsystem.

A typical command would be entered as:

         DCL        &STATUS *CHAR LEN(10)
          .
          .
         RTVSBSD    SBSD(QBATCH) STATUS(&STATUS)
         IF         (&STATUS *EQ '*ACTIVE') ...

The detail  information from the first  3 pools is also  returned.  The
command uses the QWDRSBSD API.

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

   SBSD          The  qualified  file  name  of  the  subsystem.    The
                 library value  defaults to  *LIBL.   *CURLIB may  also
                 be specified.

   RTNLIB        The  return library  where  the  subsystem was  found.
                 An  optional return variable that  must be declared as
                 *CHAR LEN(10).

   STATUS        The status  of  the  subsystem.   An  optional  return
                 variable  that  must  be declared  as  *CHAR  LEN(10).
                 The value will be either *ACTIVE or *INACTIVE.

   EXTSTATUS     The  extended status  of the  subsystem.   An optional
                 return  variable  that  must  be  declared  as   *CHAR
                 LEN(12).     The   value  will   be  either   *ACTIVE,
                 *INACTIVE, *ENDING, *RESTRICTED, or *STARTING.

   SGNONDEV      The signon  device file.  An  optional return variable
                 that must be declared as *CHAR LEN(10).

   SGNONDEVL     The  signon device  file library.   An optional return
                 variable that must be declared as *CHAR LEN(10).

   SECLNGLIB     The secondary  language library.   An optional  return
                 variable that must be declared as *CHAR LEN(10).

   MONJOBNAME    The name  of the subsystem  monitor job.   An optional
                 return  variable   that  must  be  declared  as  *CHAR
                 LEN(10).

   MONJOBUSER    The user of  the subsystem monitor  job.  An  optional
                 return  variable  that  must   be  declared  as  *CHAR
                 LEN(10).

   MONJOBNBR     The  job  number of  the  subsystem monitor  job.   An
                 optional return  variable  that must  be  declared  as
                 *CHAR LEN(6).

   TEXT          The text  description of the  subsystem.   An optional
                 return  variable  that   must  be  declared  as  *CHAR
                 LEN(50).

   MAXACT        The  maximum  number  of  active  jobs.    An optional
                 return variable that  must be  declared as *DEC  LEN(5
                 0).     If  *NOMAX  has  been   specified,  the  value
                 returned is -1.

   CURACT        The  number  of currently  active jobs.    An optional
                 return variable that  must be  declared as *DEC  LEN(5
                 0).   If the  subsystem is not  active, the  number of
                 current  jobs  will  be zero.    If  the actual  value
                 exceeds 5 digits, 0 is returned.  Use CURACT2.

   CURACT2       The number  of currently  active  jobs.   An  optional
                 return variable  that must be  declared as  *DEC LEN(7
                 0).   If the  subsystem is  not active, the  number of
                 current jobs will be zero.

   NBRSTGP       The  number  of storage  pools  defined.   An optional
                 return variable  that must be  declared as *DEC  LEN(5
                 0).

   TOTSTG        The  total storage  assigned (sum  from all  pools) in
                 KB.     An  optional  return  variable  that  must  be
                 declared as *DEC LEN(9 0).

   POOL1ID       The pool ID.   An optional  return variable that  must
                 be declared as *DEC LEN(3 0).

   POOL1NAME     The  pool name.    An  optional return  variable  that
                 must  be declared  as *CHAR LEN(10).   The  value will
                 contain one of  *BASE, *NTERACT,  *NOSTG, *SHRPOOL1  -
                 10, *SPOOL,  or *USERPOOL.   For *BASE or  *NOSTG, the
                 pool size and activity level will always be 0.

   POOL1SIZ      The  size  of the  pool  in KB.    An optional  return
                 variable that must be declared as *DEC LEN(9 0).

   POOL1ACT      The   activity  level  assigned  to   the  pool.    An
                 optional return  variable  that  must be  declared  as
                 *DEC LEN(5 0).

   POOL2ID       The pool  ID.  An  optional return variable  that must
                 be declared as *DEC LEN(3 0).

   POOL2NAME     The  pool  name.   An  optional  return  variable that
                 must be declared  as *CHAR  LEN(10).   The value  will
                 contain one  of *BASE,  *NTERACT, *NOSTG,  *SHRPOOL1 -
                 10,  *SPOOL, or *USERPOOL.   For *BASE  or *NOSTG, the
                 pool size and activity level will always be 0.

   POOL2SIZ      The size  of  the pool  in  KB.   An  optional  return
                 variable that must be declared as *DEC LEN(9 0).

   POOL2ACT      The  activity  level   assigned  to  the  pool.     An
                 optional  return  variable that  must  be declared  as
                 *DEC LEN(5 0).

   POOL3ID       The  pool ID.   An optional return  variable that must
                 be declared as *DEC LEN(3 0).

   POOL3NAME     The  pool name.    An  optional return  variable  that
                 must  be declared as  *CHAR LEN(10).   The  value will
                 contain  one of  *BASE, *NTERACT, *NOSTG,  *SHRPOOL1 -
                 10, *SPOOL, or  *USERPOOL.  For  *BASE or *NOSTG,  the
                 pool size and activity level will always be 0.

   POOL3SIZ      The  size of  the  pool in  KB.    An optional  return
                 variable that must be declared as *DEC LEN(9 0).

   POOL3ACT      The  activity   level  assigned  to  the   pool.    An
                 optional return  variable  that must  be  declared  as
                 *DEC LEN(5 0).

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

Because the  command returns  variables, it can  only be  used in  a CL
program.

Prerequisites
-------------

The following TAA Tools must be on your system:

       SNDESCMSG     Send escape message

Implementation
--------------

None, the tool is ready to use.

Objects used by the tool
------------------------

   Object        Type    Attribute      Src member    Src file
   ------        ----    ---------      ----------    ----------

   RTVSBSD       *CMD                   TAASYSM       QATTCMD
   TAASYSMC      *PGM       CLP         TAASYSMC      QATTCL
					

Added to TAA Productivity tools May 1, 1996


Home Page Up to Top