INQUIRE SYSTEM

Retrieve CICS system information.

Read syntax diagramSkip visual syntax diagramINQUIRE SYSTEM
 
>>-INQUIRE SYSTEM----------------------------------------------->
 
   .----------------------------------------------.  .-----------------------------.
   V                                              |  V                             |
>----+------------------------------------------+-+----+-------------------------+-+-><
     +-ACTOPENTCBS(data-area)-------------------+      +-MAXOPENTCBS(data-area)--+
     +-AKP(data-area)---------------------------+      +-MAXTASKS(data-area)-----+
     +-CDSASIZE(data-area)----------------------+      +-MROBATCH(data-area)-----+
     +-CICSSTATUS(cvda)-------------------------+      +-OPREL(data-area)--------+
     +-CICSSYS(data-area)-----------------------+      +-OPSYS(data-area)--------+
     +-CICSTSLEVEL(data-area)-------------------+      +-OSLEVEL(data-area)------+
     +-CMDPROTECT(cvda)-------------------------+      +-PROGAUTOCTLG(cvda)------+
     +-COLDSTATUS(cvda)-------------------------+      +-PROGAUTOEXIT(data-area)-+
     +-DB2CONN(data-area)-----------------------+      +-PROGAUTOINST(cvda)------+
     +-DEBUGTOOL(cvda)--------------------------+      +-PRTYAGING(data-area)----+
     +-DFLTUSER(data-area)----------------------+      +-RDSASIZE(data-area)-----+
     +-DSALIMIT(data-area)----------------------+      +-REENTPROTECT(cvda)------+
     +-DSRTPROGRAM(data-area)-------------------+      +-RELEASE(data-area)------+
     +-DTRPROGRAM(data-area)--------------------+      +-RLSSTATUS(cvda)---------+
     +-DUMPING(cvda)----------------------------+      +-RUNAWAY(data-area)------+
     +-ECDSASIZE(data-area)---------------------+      +-SCANDELAY(data-area)----+
     +-EDSALIMIT(data-area)---------------------+      +-SDSASIZE(data-area)-----+
     +-ERDSASIZE(data-area)---------------------+      +-SDTRAN(data-area)-------+
     +-ESDSASIZE(data-area)---------------------+      +-SECURITYMGR(cvda)-------+
     +-EUDSASIZE(data-area)---------------------+      +-SHUTSTATUS(cvda)--------+
     +-FORCEQR(cvda)----------------------------+      +-SOSSTATUS(cvda)---------+
     +-GMMTEXT(data-area)--GMMLENGTH(data-area)-+      +-STARTUP(cvda)-----------+
     +-GMMTRANID(data-area)---------------------+      +-STARTUPDATE(data-area)--+
     +-INITSTATUS(cvda)-------------------------+      +-STOREPROTECT(cvda)------+
     +-JOBNAME(data-area)-----------------------+      +-TIME(data-area)---------+
     '-LOGDEFER(data-area)----------------------'      +-TRANISOLATE(cvda)-------+
                                                       +-UDSASIZE(data-area)-----+
                                                       '-XRFSTATUS(cvda)---------'
 

Condition: NOTAUTH

For more information about the use of CVDAs, see CICS-value data areas (CVDAs).

Description

The INQUIRE SYSTEM command returns information about the CICS system under which the task issuing the command is executing.

Many of the options in this command correspond to system initialization parameters and take their initial values from the parameters. Some of these can be changed by a subsequent SET SYSTEM command or its CEMT equivalent. Other options return information about the CICS or MVS release levels, and still others return information determined solely by the current state of the system. Table 3 indicates where the option values come from and, in the case of those specified in the system initialization parameter, the name of the parameter. For these options, the CICS® System Definition Guide is a good source of additional information. For state options, the CICS Customization Guide is the primary source.

Table 3. INQUIRE SYSTEM options
Option Origin
ACTOPENTCBS System state
AKP AKPFREQ system initialization parameter
CDSASIZE System state
CICSSTATUS System state
CICSSYS System state
CICSTSLEVEL CICS control block
CMDPROTECT CMDPROT system initialization parameter
COLDSTATUS System state
DB2CONN DB2CONN system initialization parameter
DEBUGTOOL DEBUGTOOL system initialization parameter
DFLTUSER DFLTUSER system initialization parameter
DSALIMIT DSALIM system initialization parameter
DSRTPROGRAM DSRTPGM system initialization parameter
DTRPROGRAM DTRPGM system initialization parameter
DUMPING DUMP system initialization parameter
ECDSASIZE System state
EDSALIMIT EDSALIM system initialization parameter
ERDSASIZE System state
ESDSASIZE System state
EUDSASIZE System state
FORCEQR FORCEQR system initialization parameter
GMMTEXT, GMMLENGTH GMTEXT system initialization parameter
GMMTRANID GMTRAN system initialization parameter
INITSTATUS System state
JOBNAME JCL or cataloged procedure
LOGDEFER LGDFINT system initialization parameter
MAXOPENTCBS MAXOPENTCBS system initialization parameter
MAXTASKS MXT system initialization parameter
MROBATCH MROBTCH system initialization parameter
OPREL Operating system (MVS)
OPSYS Operating system (MVS)
OSLEVEL Operating system (OS/390)
PROGAUTOCTLG PGAICTLG system initialization parameter
PROGAUTOEXIT PGAIEXIT system initialization parameter
PROGAUTOINST PGAIPGM system initialization parameter
PRTYAGING PRTYAGE system initialization parameter
RDSASIZE System state
REENTPROTECT RENTPGM system initialization parameter
RELEASE CICS system code
RLSSTATUS RLS system initialization parameter
RUNAWAY ICVR system initialization parameter
SCANDELAY ICVTSD system initialization parameter
SDSASIZE System state
SDTRAN SDTRAN system initialization parameter
SECURITYMGR SEC system initialization parameter
SHUTSTATUS System state
SOSSTATUS System state
STARTUP System state
STARTUPDATE System state
STOREPROTECT STGPROT system initialization parameter, and hardware
TIME ICV system initialization parameter
TRANISOLATE TRANISO system initialization parameter, and hardware
UDSASIZE System state
XRFSTATUS XRF system initialization parameter, and system state
 
Note:
The CSCS, ECSCS, ERSCS, EUSCS, and USCS options, each of which returned the size of the storage "cushion" for a particular dynamic storage area, are obsolete in CICS Transaction Server for z/OS®. The translator accepts them and gives a warning. At run time, the data areas provided are left unchanged.

Options

ACTOPENTCBS(data-area)
returns a fullword binary field giving the number of open TCBs currently allocated to user tasks.The open TCBs are allocated from the pool of open TCBs that CICS attaches up to the maximum set by the MAXOPENTCBS system initialization parameter. The ACTOPENTCBS value can be equal to, or less than , the MAXOPENTCBS value. If it is equal to MAXOPENTCBS, tasks that require an open TCB are made to wait.
AKP(data-area)
returns a fullword binary field giving the activity keypoint trigger value, which is the number of write requests to the CICS system log stream output buffer between the taking of keypoints.

Start of changeA value of minus one (not applicable) means that keypoints are not being taken.End of change

CDSASIZE(data-area)
returns the current size in bytes of the CICS dynamic storage area (CDSA), in fullword binary form. It includes both storage in use and storage available for use. This size is calculated and managed by CICS automatically, within the overall limit for dynamic storage areas that reside below 16MB (the DSALIMIT option value).
CICSSTATUS(cvda)
returns a CVDA value identifying the current execution status of CICS. CVDA values are:
ACTIVE
CICS is fully active.
FINALQUIESCE
CICS is in the final quiesce stage of shutdown. Programs in the second stage of the program list table for shutdown (PLTSD) are run during this stage.
FIRSTQUIESCE
CICS is in the first quiesce stage of shutdown. Programs in the first stage of the PLTSD are run during this stage.
STARTUP
CICS is starting up but is not yet fully active. Programs in the program list table for program initiation (PLTPI) are run during startup. See the INITSTATUS option in topic INQUIRE SYSTEM command options - GMMTRANID for further information.
CICSSYS(data-area)
returns a 1-character value identifying the operating system for which the running CICS system has been built. A value of "X" represents MVS/ESA.
CICSTSLEVEL(data-area)
returns a 6-character value identifying the version, release, and modification level of the CICS Transaction Server for OS/390® product under which the CICS region is running. The value is of the form vvrrmm, and CICS Transaction Server for z/OS Version 3 Release 1 returns 030100.
CMDPROTECT(cvda)
returns a CVDA value indicating whether command protection is active or not. With command protection active, when a task issues a command, CICS verifies that the task has write access to the first byte of every area into which CICS is to return information. If any area fails the test, an AEYD abend occurs.

The CVDA values are:

CMDPROT
Command protection is active.
NOCMDPROT
Command protection is not active.
COLDSTATUS(cvda)
returns a CVDA value indicating whether CICS performed a cold or an initial start. (For information about the types of CICS startup, see the CICS Recovery and Restart Guide.)

The CVDA values are:

COLD
CICS performed a cold start. Log information about local resources was erased, but information about the outcome of local units of work, needed to allow remote systems or RMI-connected resource managers to resynchronize their resources, was preserved.
INITIAL
CICS performed an initial start. All log information about both local and remote resources was erased.
NOTAPPLIC
CICS performed neither a cold nor an initial start.
DB2CONN(data-area)
returns the 1-8 character name of the DB2CONN currently installed, or blanks if no DB2CONN is currently installed. DB2CONN allows the user to determine the name of the RDO DB2CONN definition. Only one DB2CONN can be installed at a time. A DB2CONN defines the global attributes of the connection to be established between DB2 and CICS.
DEBUGTOOL(cvda)
returns a CVDA value indicating whether you can use debugging profiles to select the programs that will run under the control of a debugging tool. The following debugging tools use debugging profiles:
  • Debug Tool, for compiled language application programs (programs written in COBOL, PL/I, C, C++ and Assembler)
  • Remote debugging tools (for compiled language application programs and Java programs)
Other debugging mechanisms, such as the CICS Execution Diagnostic Facility (CEDF) do not use debugging profiles.

The CVDA values are:

DEBUG
You can use CICS debugging profiles to select the programs that will run under the control of a debugging tool.
NODEBUG
You cannot use CICS debugging profiles to select the programs that will run under the control of a debugger tool.

For more information about using debugging profiles, see the CICS Application Programming Guide.

DFLTUSER(data-area)
returns the 8-character identifier of the default user for this CICS region.
DSALIMIT(data-area)
returns a fullword binary field giving the maximum amount of storage, in bytes, within which CICS can dynamically allocate storage for the four individual dynamic storage areas that reside below the 16MB boundary. (See the CDSASIZE, RDSASIZE, SDSASIZE, and UDSASIZE options of this command.)
DSRTPROGRAM(data-area)
returns the 8-character name of the distributed routing program.
DTRPROGRAM(data-area)
returns the 8-character name of the dynamic routing program.
DUMPING(cvda)
returns a CVDA value indicating whether the taking of CICS system dumps is suppressed. CVDA values are:
NOSYSDUMP
System dumps are suppressed.
SYSDUMP
System dumps are not suppressed.

These values are set by the system initialization parameter DUMP=YES or NO.

ECDSASIZE(data-area)
returns the current size in bytes of the extended CICS dynamic storage area (ECDSA), in fullword binary form. It includes both storage in use and storage available for use. This size is calculated and managed by CICS automatically, within the overall limit for dynamic storage areas that reside above the 16MB boundary (the EDSALIMIT option value).
EDSALIMIT(data-area)
returns a fullword binary field giving the maximum amount of storage, in bytes, within which CICS can dynamically allocate storage for the four individual dynamic storage areas that reside above the 16MB boundary. (See the ECDSASIZE, ERDSASIZE, ESDSASIZE, and EUDSASIZE options of this command.)
ERDSASIZE(data-area)
returns the current size in bytes of the extended read-only dynamic storage area (ERDSA), in fullword binary form. It includes both storage in use and storage available for use. This size is calculated and managed by CICS automatically, within the overall limit for dynamic storage areas that reside above the 16MB boundary (the EDSALIMIT option value).
ESDSASIZE(data-area)
returns the current size in bytes of the extended shared dynamic storage area (ESDSA), in fullword binary form. It includes both storage in use and storage available for use. This size is calculated and managed by CICS automatically, within the overall limit for dynamic storage areas that reside above the 16MB boundary (the EDSALIMIT option value).
EUDSASIZE(data-area)
returns the current size in bytes of the extended user dynamic storage area (EUDSA), in fullword binary form. It includes both storage in use and storage available for use. This size is calculated and managed by CICS automatically, within the overall limit for dynamic storage areas that reside above the 16MB boundary (the EDSALIMIT option value).
Start of changeFORCEQR(cvda) End of change
Start of changereturns a CVDA value indicating whether CICS is to force CICSAPI user application programs that are defined as threadsafe to run on the quasi-reentrant (QR) TCB. The CVDA values are:
FORCE
CICS forces all user application programs specified with the CONCURRENCY(THREADSAFE) attribute to run under the QR TCB, as if they were specified with CONCURRENCY(QUASIRENT). Force does not apply to OPENAPI programs or C/C++ programs compiled with XPLINK.
NOFORCE
CICS is to honor the CONCURRENCY(THREADSAFE) attribute on CICSAPI user application programs, and allow user programs to run on an open TCB to avoid unnecessary TCB switching.
End of change
GMMLENGTH(data-area)
returns a halfword binary field giving the length in bytes of the "good morning" message text.
GMMTEXT(data-area)
returns the "good morning" message text in the data-area you provide, which must be long enough to accommodate it. The maximum length of any "good morning" message is 246 bytes. The actual length is returned in the GMMLENGTH option value.
GMMTRANID(data-area)
returns the 4-character name of the transaction that generates the "good morning" message.
INITSTATUS(cvda)
returns a fullword binary field giving the initialization status of the CICS system. CVDA values are:
FIRSTINIT
First stage of CICS initialization.
INITCOMPLETE
CICS initialization is complete.
SECONDINIT
Second stage of initialization.
THIRDINIT
Third stage of initialization.

See the CICS Customization Guide for more information about CICS initialization.

JOBNAME(data-area)
returns the 8-character MVS jobname under which CICS is running.
LOGDEFER(data-area)
returns the halfword binary value giving the log deferral interval, which is the period of time used by CICS Log Manager when determining how long to delay a forced journal write request before invoking the MVS system logger. See the CICS System Definition Guide for information about the LOGDEFER parameter and associated system initialization parameter LGDFINT.
MAXOPENTCBS(data-area)
returns a fullword binary field giving the maximum number of open TCBs that CICS is allowed to attach and maintain in its pool of open TCBs. For information about the number actually allocated, see the ACTOPENTCBS option.

The difference between MAXOPENTCBS and ACTOPENTCBS represents the number of open TCBs that are free.

MAXTASKS(data-area)
returns a fullword binary field giving the maximum number of tasks that can be eligible for dispatch at any one time in this CICS system. Both active and suspended tasks count toward this limit, but tasks that have not reached the point of initial dispatch do not. System tasks such as terminal and journal control tasks do not count in CICS Transaction Server for z/OS either, although they did in earlier releases.
MROBATCH(data-area)
returns a fullword binary field giving the number of events that must occur, from a list of MRO and DASD I/O events on which CICS is waiting, before CICS is posted explicitly to process them.
OPREL(data-area)   (supported for compatibility only)
returns a halfword binary field giving the last 2 digits of the level number of the operating system under which the CICS region is running. For example, OS/390 Release 4 is represented by 04.
Note:
This field is supported for compatibility purposes only. The information is derived from the last two numbers held in the MVS CVTPRODN field. For example, CVTPRODN holds the value SP5.2.2 for MVS/ESA SP™ Version 5 Release 2.2 (in which case OPREL returns 22), and SP6.0.3 for OS/390 Release 3. See the OSLEVEL field for the full version and release number of OS/390.
OPSYS(data-area)
returns a 1-character value identifying the operating system under which CICS is running. A value of "X" represents MVS/ESA.
OSLEVEL(data-area)
returns a 6-byte field containing the version, release, and modification level of the OS/390 product on which CICS is running. For example, OS/390 Version 2 Release 4 Modification 0 returns the value 020400.
PROGAUTOCTLG(cvda)
returns a CVDA value indicating whether and when autoinstalled program definitions are cataloged. Cataloged definitions are restored on a warm or emergency restart. Those not cataloged are discarded at shutdown, and must be installed again if they are used in a subsequent execution of CICS.

Decisions to catalog are made both at initial installation and whenever an autoinstalled definition is modified, and are based on the PROGAUTOCTLG value at the time. CVDA values are:

CTLGALL
Definitions are cataloged both when installed and when modified.
CTLGMODIFY
Definitions are cataloged only when modified.
CTLGNONE
Definitions are not cataloged.
PROGAUTOEXIT(data-area)
returns the 8-character name of the user-provided program that is called by the CICS program autoinstall code to provide a model definition.
PROGAUTOINST(cvda)
returns a CVDA value indicating whether autoinstall for programs is active or inactive. When a task requests a program, map set, or partition set that is not defined, CICS attempts to create a definition for it automatically if autoinstall for programs is active. If not, CICS raises the PGMIDERR exceptional condition. CVDA values are:
AUTOACTIVE
Autoinstall for programs is active.
AUTOINACTIVE
Autoinstall for programs is not active.
PRTYAGING(data-area)
returns a fullword binary field giving the rate at which CICS increases the priority of a task waiting for dispatch. CICS increases the task priority by 1 after each PRTYAGING milliseconds of wait time without a dispatch.
RDSASIZE(data-area)
returns the current size in bytes of the read-only dynamic storage area (RDSA), in fullword binary form. It includes both storage in use and storage available for use. This size is calculated and managed by CICS automatically, within the overall limit for dynamic storage areas that reside below the 16MB boundary (the DSALIMIT option value).
REENTPROTECT(cvda)
returns a CVDA value indicating whether storage for reentrant programs (the RDSA and ERDSA) is in key 0 or CICS key. MVS key 0 storage is write protected from programs running in CICS key or user key; programs in CICS key storage are protected only from those running in user key when CICS key and user key are different (that is, when storage protection is active). CVDA values are:
REENTPROT
Read-only DSAs are in key 0 storage.
NOREENTPROT
Read-only DSAs are in CICS-key storage.
RELEASE(data-area)   (supported for compatibility only)
returns a 4-character string comprising the value 640, indicating the level number of the CICS code within the CICS Transaction Server for OS/390.

This option is supported only for compatibility with earlier releases. As an exclusive element of CICS Transaction Server for OS/390, CICS does not have a product version and release number of its own. You are recommended to use CICSTSLEVEL to determine the version and release number of CICS Transaction Server.

RLSSTATUS(cvda)
returns a CVDA value indicating whether VSAM RLS is active--that is, the CICS region is registered (with a currently-open control ACB) with an SMSVSAM address space. CVDA values are:
NOTAPPLIC
This CICS region does not support VSAM RLS because:
  • CICS initialized with RLS=NO as a system initialization parameter, or
  • CICS has forced RLS=NO because the level of VSAM in the MVS in which CICS is running does not support VSAM RLS.
RLSACTIVE
CICS has registered with an SMSVSAM server and VSAM RLS is currently active.
RLSINACTIVE
CICS has registered with an SMSVSAM server, but VSAM RLS is currently inactive due to an SMSVSAM server failure. All RLS requests fail until CICS performs dynamic VSAM RLS restart, which occurs automatically when the SMSVSAM server has restarted.
RUNAWAY(data-area)
returns a fullword binary field giving the default value for runaway task time. This value is used for any task executing a transaction whose profile does not specify runaway task time (see the RUNAWAY option of the INQUIRE TRANSACTION command on page INQUIRE TRANSACTION options - RTIMEOUT).
SCANDELAY(data-area)
returns a fullword binary field giving the maximum number of milliseconds between a user task making a terminal I/O request and CICS dispatching the terminal control task to process it. This value is sometimes called the "terminal scan delay", and is set by the ICVTSD option in the system initialization table.
SDSASIZE(data-area)
returns the current size in bytes of the shared dynamic storage area (SDSA), in fullword binary form. It includes both storage in use and storage available for use. This size is calculated and managed by CICS automatically, within the overall limit for dynamic storage areas that reside below the 16MB boundary (the DSALIMIT option value).
SDTRAN(data-area)
returns the 4-character name of the transaction to be run at the beginning of normal or immediate shutdown. This may be the name of a user-supplied transaction, or the CICS-supplied default transaction, CESD.
SECURITYMGR(cvda)
returns a CVDA value identifying whether an external security manager (such as RACF) is active in the system, or whether no security is being used. CVDA values are:
EXTSECURITY
An external security manager is active.
NOSECURITY
No security is being used.
SHUTSTATUS(cvda)
returns a CVDA value indicating the shutdown status of CICS (see the CICSSTATUS option in topic CICSSTATUS). CVDA values are:
CANCELLED
CICS is canceled.
CONTROLSHUT
CICS is performing a controlled shutdown (that is, a normal shutdown with a warm keypoint).
NOTAPPLIC
CICS is not shutting down.
SHUTDOWN
CICS is performing an immediate shutdown.
SOSSTATUS(cvda)
returns a CVDA value indicating whether CICS is short on storage. CVDA values are:
NOTSOS
CICS is not short on storage in any of the dynamic storage areas.
SOS
CICS is short on storage in at least one dynamic storage area above and at least one below the 16MB line.
SOSABOVE
CICS is short on storage in at least one dynamic storage area above 16MB, but none below.
SOSBELOW
CICS is short on storage in at least one dynamic storage area below 16MB, but none above.
STARTUP(cvda)
returns a CVDA value indicating how the current execution of CICS started. CVDA values are:
COLDSTART
CICS performed an initial or a cold start.
Note:
The STARTUP option does not distinguish between an initial and a cold start. See the COLDSTATUS option.
EMERGENCY
CICS performed an emergency restart because the previous run did not shut down normally.
WARMSTART
CICS performed a warm restart following the normal shutdown of the previous run.
STARTUPDATE(data-area)
returns a 4-byte packed-decimal field containing the date on which the current execution of CICS started. The date is in the form 0cyyddd+, where c is the century code (0 for the 1900s, 1 for 2000-2099), yy is the low-order two digits of the year and ddd is the day of the year.
STOREPROTECT(cvda)
returns a CVDA value indicating whether storage protection is active or not. For storage protection to be active, it must be requested (the STGPROT option in the system initialization table), and it must be supported by the hardware. CVDA values are:
ACTIVE
Storage protection is active.
INACTIVE
Storage protection is not active.
TIME(data-area)
returns a fullword binary field giving the maximum interval in milliseconds for which CICS gives control to the operating system if no tasks are ready for dispatch. This value is set by the ICV option in the system initialization table and is sometimes called the "region exit time interval".
TRANISOLATE(cvda)
returns a CVDA value indicating whether transaction isolation is active or not. For it to be active, both transaction isolation and storage protection must be requested (the TRANISO and STGPROT system initialization parameters), and it must be supported by the hardware. CVDA values are:
ACTIVE
Transaction isolation is active.
INACTIVE
Transaction isolation is not active.
UDSASIZE(data-area)
returns the current size in bytes of the user dynamic storage area (UDSA), in fullword binary form. It includes both storage in use and storage available for use. This size is calculated and managed by CICS automatically, within the overall limit for dynamic storage areas that reside below the 16MB boundary (the DSALIMIT option value).
XRFSTATUS(cvda)
returns a CVDA value indicating whether the current execution of CICS started as an active or alternate region under the extended recovery facility (XRF). CVDA values are:
NOTAPPLIC
CICS is running without XRF support. (XRF=NO in the system initialization table.)
PRIMARY
CICS started as the active region.
TAKEOVER
CICS started as the alternate region.

Conditions

NOTAUTH
RESP2 values:
100
The user associated with the issuing task is not authorized to use this command.
[[ Contents Previous Page | Next Page Index ]]