The Retrieve Storage Pool command retrieves the information about a
storage pool. Either a shared storage pool name or a pool ID must be
specified. Various return parameters exist. The QWCRSSTS API is
used.
A typical command approach would be:
DCL &POOLSIZE *DEC LEN(9 0)
.
RTVSTGPOOL POOLTYPE(*SHARED) SHRPOOL(*xxxx)
POOLSIZE(&POOLSIZE)
The pool size in KB would be returned for the specified shared pool.
Either a shared pool name such as *BASE or a pool ID (1 - 64) must be
specified.
RTVSTGPOOL escape messages you can monitor for
----------------------------------------------
None. Escape messages from based on functions will be re-sent.
Command parameters *CMD
------------------
POOLTYPE The type of pool to be retrieved. *SHARED is the
default in which case the SHRPOOL parameter must
identify a shared pool.
*POOLID may be entered in which case the POOLID
parameter must be entered.
SHRPOOL The name of the the shared pool to retrieve
information for. The default is *NONE. A value
must be entered if POOLTYPE(*SHARED) is specified.
The valid values are *MACHINE, *BASE, *INTERACT,
*SPOOL, or *SHRPOOL1 - *SHRPOOL60.
POOLID The pool ID to retrieve information for. The
default is *NONE. A number between 1 and 64 must be
entered if POOLTYPE(*POOLID) is specified.
RESET A *YES/*NO value for whether to reset the
statistics. This is the same value that appears on
WRKSYSSTS. The default is *NO to retain the
existing statistics.
*YES may be specified to reset the statistics.
There is one set of statistics kept by the system.
Resetting the statistics using RTVSTGPOOL resets the
values used by WRKSYSSTS and vice versa.
RTNPOOLID The pool ID of the pool being retrieved. This may
be useful if a shared pool name was specified. If
used, the return variable must be specified as *DEC
LEN(2 0).
RTNPOOLNAM The name of the shared storage pool. This
information may be useful if a pool ID was
specified. The name returned will be the same as
one of the special values which may be named for the
SHRPOOL parameter (such as *BASE and *SPOOL). If a
number is returned, it is for a private pool. If
used, the return variable must be specified as *CHAR
LEN(10).
POOLSIZE The size of the pool in KB. If used, the return
variable must be specified as *DEC LEN(9 0). If the
size exceeds nine digits then 999,999,999 is
returned.
RSVDSIZE The reserved size of the pool in KB. If used, the
return variable must be specified as *DEC LEN(9 0).
If the size exceeds nine digits then 999,999,999 is
returned.
ACTLVL The maximum active threads that may exist in the
pool. If used, the return variable must be
specified as *DEC LEN(9 0).
DBFLT The rate at which data base faults (in tenths) per
second occur in the pool. Both data base and access
path pages are considered. If used, the return
variable must be specified as *DEC LEN(9 1).
DBPAGE The rate at which data base pages (in tenths) per
second are brought into the pool. Both data base
and access path pages are considered. If used, the
return variable must be specified as *DEC LEN(9 1).
NONDBFLT The rate at which non-data base faults (in tenths)
per second occur in the pool. If used, the return
variable must be specified as *DEC LEN(9 1).
NONDBPAGE The rate at which non-data base pages (in tenths)
per second are brought into the pool. Both data
base and access path pages are considered. If used,
the return variable must be specified as *DEC LEN(9
1).
ACTTOWAIT The rate at which transitions per minute (in tenths)
from an active condition to a waiting condition
occur in the pool. If used, the return variable
must be specified as *DEC LEN(9 1).
WAITTOINEL The rate at which transitions per minute (in tenths)
from a wait condition to an ineligible condition
occur in the pool. If used, the return variable
must be specified as *DEC LEN(9 1).
ACTTOINEL The rate at which transitions per minute (in tenths)
from an active condition to an ineligible condition
occur in the pool. If used, the return variable
must be specified as *DEC LEN(9 1).
SBS The subsystem associated with the pool. The value
will be blank for shared pools. If used, the return
variable must be specified as *CHAR LEN(10).
SBSLIB The subsystem library associated with the pool. The
value will be blank for shared pools. If used, the
return variable must be specified as *CHAR LEN(10).
PAGING The paging option assigned to the pool to
dynamically adjust the paging characteristics of the
pool. The values returned will be *FIXED, *CALC, or
USRDFN. If used, the return variable must be
specified as *CHAR LEN(10).
DEFSIZE The defined size of the pool in KB. A value of -1
will be returned for pools without a defined size.
If used, the return variable must be specified as
*DEC LEN(9 0).
CURTHD The number of current threads that are using the
pool's activity level. If used, the return variable
must be specified as *DEC LEN(9 0).
CURINELTHD The number of ineligible threads in the pool. If
used, the return variable must be specified as *DEC
LEN(9 0).
PTY The priority of the shared pool when making
automatic performance adjustments. The value is 0
for non-shared pools. If used, the return variable
must be specified as *DEC LEN(5 0).
MINPCT The minimum percentage (in hundredths) of total main
storage to allocate to the shared pool when making
performance adjustments. If used, the return
variable must be specified as *DEC LEN(5 2).
MAXPCT The maximum percentage (in hundredths) of total main
storage to allocate to the shared pool when making
performance adjustments. If used, the return
variable must be specified as *DEC LEN(5 2).
MINFLT The minimum page faults (in hundredths) per second
to use as a guideline for a shared pool when making
performance adjustments. The value is 0 for
non-shared pools. If used, the return variable must
be specified as *DEC LEN(5 2).
MAXFLT The maximum page faults (in hundredths) per second
to use as a guideline for a shared pool when making
performance adjustments. The value is 0 for
non-shared pools. If used, the return variable must
be specified as *DEC LEN(5 2).
PERTHDFLT The page faults (in hundredths) per second for each
active thread to use as a guideline when making
performance adjustments. If used, the return
variable must be specified as *DEC LEN(5 2).
TEXT The text description of a shared pool. If used, the
return variable must be specified as *CHAR LEN(50).
STATUS The status of the pool. The values returned are
*ACTIVE or *INACTIVE. If used, the return variable
must be specified as *CHAR LEN(10).
Restrictions
------------
Because the command returns variables, it 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
------ ---- --------- ---------- ----------
RTVSTGPOOL *CMD TAAJODQ QATTCMD
TAAJODQC *PGM CLP TAAJODQC QATTCL
|
