INQUIRE SYSTEM

Description

The INQUIRE SYSTEM command returns information about the CICS system in which the task that issues the command is running.

Many options in this command correspond to system initialization parameters and take their initial values from the parameters. Some options 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 others return information determined solely by the current state of the system. Table 1 indicates the origin of the option values and, for options that are specified in the system initialization parameter, the name of the parameter.

Options

ACTOPENTCBS(data-area)

Returns a fullword binary field giving the number of open TCBs currently allocated to user tasks. CICS dispatcher maintains a pool of L8 and L9 mode TCBs for use by OPENAPI applications and by task-related user exits that are enabled with the OPENAPI option. Task-related user exits use only L8 mode TCBs; for example, the CICS Db2® adapter when connecting to Db2. The ACTOPENTCBS value can be equal to, or less than, the MAXOPENTCBS value. If the value is equal to MAXOPENTCBS, tasks that require an open TCB are made to wait.

AIDCOUNT(data-area)

Returns a fullword binary value giving the current number of automatic initiator descriptors (AIDs) that are in the AID chain for the local system.

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.

A value of minus one (not applicable) means that keypoints are not being taken.

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 DSALIMIT value, that is, the overall limit for dynamic storage areas that reside below 16 MB (below the line).

CICSSTATUS(cvda)

Returns a CVDA value that identifies the current execution status of CICS:

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 for further information.

CICSSYS(data-area)

Returns a 1-character value that identifies the operating system for which the running CICS system has been built. The value X represents MVS.

CICSTSLEVEL(data-area)

Returns a 6-character value that identifies the version, release, and modification level of the CICS Transaction Server for z/OS product under which the CICS region is running. The value is of the form vvrrmm, and CICS Transaction Server for z/OS, Version 5 Release 6 returns 050600.

CMDPROTECT(cvda)

Returns a CVDA value that indicates whether command storage protection is active. When a task issues a command and command storage protection is active, 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 as follows:

CMDPROT

Command storage protection is active.

NOCMDPROT

Command storage protection is not active.

COLDSTATUS(cvda)

Returns a CVDA value that indicates whether CICS performed a cold or an initial start.

The CVDA values are as follows:

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 resource definition that is currently installed for the CICS region, or blanks if no DB2CONN definition is currently installed. Only one DB2CONN definition can be installed at a time. The DB2CONN resource definition specifies the attributes of the connection between CICS and Db2.

DEBUGTOOL(cvda)

Returns a CVDA value that indicates 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, for example the CICS Execution Diagnostic Facility (CEDF), do not use debugging profiles. The CVDA values are as follows:

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 Debugging profiles.

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 16 MB (below the line). 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 that indicates whether the taking of CICS system dumps is suppressed:

NOSYSDUMP

System dumps are suppressed.

TABLEONLY

System dumps are suppressed except for those that have an entry in the dump table that allows sdumps to be taken.

SYSDUMP

System dumps are not suppressed.

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

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 EDSALIMIT value, that is, the overall limit for dynamic storage areas that reside above 16 MB but below 2 GB (above the line).

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 individual dynamic storage areas that reside above 16 MB but below 2 GB (above the line). 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 EDSALIMIT value, that is, the overall limit for dynamic storage areas that reside above 16 MB but below 2 GB (above the line).

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 EDSALIMIT value, that is, the overall limit for dynamic storage areas that reside above 16 MB but below 2 GB (above the line).

ETDSASIZE(data-area)

Returns the current size in bytes of the extended trusted dynamic storage area (ETDSA), 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 EDSALIMIT value, that is, the overall limit for dynamic storage areas that reside above 16 MB but below 2 GB (above the line).

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 EDSALIMIT value, that is, the overall limit for dynamic storage areas that reside above 16 MB but below 2 GB (above the line).

FORCEQR(cvda)

Returns a CVDA value that indicates whether CICS forces CICSAPI user application programs that are defined as threadsafe to run on the quasi-reentrant (QR) TCB:

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 certain programs, for example OPENAPI programs, or C or C++ programs compiled with XPLINK. For details, see FORCEQR system initialization parameter.

NOFORCE

CICS honors the CONCURRENCY(THREADSAFE) attribute on CICSAPI user application programs, and allows user programs to run on an open TCB to avoid unnecessary TCB switching.

GCDSASIZE(data-area)

Returns the current size in bytes of the above-the-bar CICS dynamic storage area (GCDSA), in doubleword binary form. It includes both storage in use and storage available for use. This size is calculated and managed by CICS automatically.

GMMLENGTH(data-area)

Returns a halfword binary field that shows 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.

GSDSASIZE(data-area)

Returns the current size in bytes of the above-the-bar shared dynamic storage area (GSDSA), in doubleword binary form. It includes both storage in use and storage available for use. This size is calculated and managed by CICS automatically.

GUDSASIZE(data-area)

Returns the current size in bytes of the above-the-bar user dynamic storage area (GUDSA), in doubleword binary form. It includes both storage in use and storage available for use. This size is calculated and managed by CICS automatically.

INITSTATUS(cvda)

Returns a fullword binary field that shows the initialization status of the CICS system. CVDA values are as follows:

FIRSTINIT

First stage of CICS initialization.

INITCOMPLETE

CICS initialization is complete.

SECONDINIT

Second stage of initialization.

THIRDINIT

Third stage of initialization.

JOBNAME(data-area)

Returns the 8-character MVS jobname under which CICS is running.

LASTCOLDTIME(data-area)

Returns an ABSTIME value that represents the date and time of the last cold start of the CICS system that occurred since the last initial start. If the CICS system was not cold started since the last initial start, a null value is returned.

The ABSTIME value is derived from the system time-of-day clock, which is adjusted for both leap seconds and the local timezone offset (including daylight saving time). These might have changed since the last cold start, and the time returned in this field is adjusted accordingly.

LASTEMERTIME(data-area)

Returns an ABSTIME value that represents the date and time of the last emergency start of the CICS system that occurred since the last initial start. If the CICS system was not emergency started since the last initial start, a null value is returned.

The ABSTIME value is derived from the system time-of-day clock, which is adjusted for both leap seconds and the local timezone offset (including daylight saving time). These might have changed since the last cold start, and the time returned in this field is adjusted accordingly.

LASTINITTIME(data-area)

Returns an ABSTIME value that represents the date and time of the last initial start of the CICS system.

The ABSTIME value is derived from the system time-of-day clock, which is adjusted for both leap seconds and the local timezone offset (including daylight saving time). These might have changed since the last cold start, and the time returned in this field is adjusted accordingly.

LASTWARMTIME(data-area)

Returns an ABSTIME value that represents the date and time of the last warm start of the CICS system that occurred since the last initial start. If the CICS system was not warm started since the last initial start, a null value is returned.

The ABSTIME value is derived from the system time-of-day clock, which is adjusted for both leap seconds and the local timezone offset (including daylight saving time). These might have changed since the last cold start, and the time returned in this field is adjusted accordingly.

LOGDEFER(data-area)

Returns the halfword binary value that shows 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 LGDFINT system initialization parameter 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 L8 and L9 mode open TCBs that CICS attaches and maintains in its pool of L8 and L9 mode TCBs. CICS sets this limit automatically based on the maximum number of tasks (MXT or MAXTASKS) specified for the CICS region, using the following formula:

(2 * MXT Value) + 32

For information about the number of L8 and L9 mode open TCBs allocated, see the ACTOPENTCBS value. The difference between MAXOPENTCBS and ACTOPENTCBS represents the number of L8 and L9 mode open TCBs that are free.

MAXTASKS(data-area)

Returns a fullword binary field that shows 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 are not counted.

MEMLIMIT(data-area)

Returns a doubleword binary field that shows the maximum amount, in bytes, of storage above the bar for use by the CICS region. A value of -1 indicates that no limit has been imposed on the amount of storage that the region can attempt to use (also known as NOLIMIT). The MEMLIMIT value can be set as a PARMLIB member, by JCL, or through the IEFUSI global user exit.

MESSAGECASE(cvda)

Returns a CVDA value that shows how the message domains display mixed case messages, as set by the MSGCASE system initialization parameter. CVDA values are as follows:

MIXED

All messages displayed by the CICS message domain or the CICSPlex® SM message domain remain in mixed case.

UPPER

The message domain displays all mixed case messages in uppercase only.

MQCONN(data-area)

Returns the 1- to 8-character name of the MQCONN resource definition that is currently installed for the CICS region, or blanks if no MQCONN definition is currently installed. Only one MQCONN definition can be installed at a time. The MQCONN resource definition specifies the attributes of the connection between CICS and IBM® MQ.

MROBATCH(data-area)

Returns a fullword binary field that shows 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.

MVSSMFID(data-area)

Returns a 4-byte value indicating the MVS system identification. This field is copied from the SMCASID field of the SMCA MVS control block.

MVSSYSNAME(data-area)

Returns an 8-byte value indicating the MVS system name. This field is copied from the CVTSNAME field of the MVS CVT control block.

OPREL(data-area) (supported for compatibility only)

Returns a halfword binary field that shows the last 2 digits of the level number of the operating system under which the CICS region is running. For example, z/OS Release 9 is represented by 09.

Note: This field is supported for compatibility purposes only. The information is derived from the last two numbers held in the MVS CVTPRODN field. See the OSLEVEL field for the full version and release number of z/OS.

OPSYS(data-area)

Returns a 1-character value that identifies the operating system under which CICS is running. A value of X represents MVS.

OSLEVEL(data-area)

Returns a 6-byte field that shows the version, release, and modification level of the z/OS product on which CICS is running. For example, z/OS, Version 2 Release 3 Modification 0 returns the value 020300.

PLTPIUSR(data-area)

Returns the user ID applicable to PLTPI processing in the supplied data area.

PROGAUTOCTLG(cvda)

Returns a CVDA value that indicates 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 as follows:

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 that indicates 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 as follows:

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 DSALIMIT value, that is, the overall limit for dynamic storage areas that reside below 16 MB (below the line).

REENTPROTECT(cvda)

Returns a CVDA value that indicates 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 as follows:

REENTPROT

Read-only DSAs are in key 0 storage.

NOREENTPROT

Read-only DSAs are in CICS-key storage.

REGIONUSERID(data-area)

Returns a region user ID in the supplied data area.

RELEASE(data-area) (supported for compatibility only)

Returns a 4-character string containing the level number of the CICS code. In this release, the value is 0730.

This option is supported only for compatibility with earlier releases. As an exclusive element of CICS Transaction Server for z/OS, 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 that indicates whether VSAM RLS is active - that is, the CICS region is registered (with a currently-open control ACB) with an SMSVSAM address space:

NOTAPPLIC

This CICS region does not support VSAM RLS because of one of the following reasons:

• CICS initialized with RLS=NO as a system initialization parameter
• 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 that shows 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.

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 DSALIMIT value, that is, the overall limit for dynamic storage areas that reside below 16 MB (below the line).

SDTRAN(data-area)

Returns the 4-character name of the transaction to run at the beginning of normal or immediate shutdown. This can be the name of a user-supplied transaction, or the CICS-supplied default transaction, CESD.

SECURITYMGR(cvda)

Returns a CVDA value that identifies whether an external security manager (such as RACF®) is active in the system:

EXTSECURITY

An external security manager is active.

NOSECURITY

No security is being used.

SHUTSTATUS(cvda)

Returns a CVDA value that indicates the shutdown status of CICS (see the CICSSTATUS option):

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.

SOSABOVEBAR(cvda)

Returns a CVDA value that indicates whether CICS is short on storage in the dynamic storage areas above the bar:

NOTSOS

CICS is not short on storage in any of the dynamic storage areas above the bar.

SOS

CICS is short on storage in at least one dynamic storage area above the bar.

SOSABOVELINE(cvda)

Returns a CVDA value that indicates whether CICS is short on storage in the dynamic storage areas above 16 MB but below 2 GB (above the line):

NOTSOS

CICS is not short on storage in any of the dynamic storage areas above 16 MB but below 2 GB.

SOS

CICS is short on storage in at least one dynamic storage area above 16 MB but below 2 GB.

SOSBELOWLINE(cvda)

Returns a CVDA value that indicates whether CICS is short on storage in the dynamic storage areas below 16 MB (below the line):

NOTSOS

CICS is not short on storage in any of the dynamic storage areas below 16 MB.

SOS

CICS is short on storage in at least one dynamic storage area below 16 MB.

SOSSTATUS(cvda)

Returns a CVDA value that indicates whether CICS is short on storage in any of the dynamic storage areas below 2 GB (below the bar):

NOTSOS

CICS is not short on storage in any of the dynamic storage areas below 2 GB.

SOS

CICS is short on storage in at least one dynamic storage area below 16 MB, and at least one dynamic storage area above 16 MB but below 2 GB.

SOSABOVE

CICS is short on storage in at least one dynamic storage area above 16 MB but below 2 GB, but is not short on storage in any of the dynamic storage areas below 16 MB.

SOSBELOW

CICS is short on storage in at least one dynamic storage area below 16 MB, but is not short on storage in any of the dynamic storage areas above 16 MB but below 2 GB.

STARTUP(cvda)

Returns a CVDA value that indicates how the current execution of CICS started:

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 that indicates whether storage protection is active. For storage protection to be active, the system initialization parameter STGPROT must be set to YES or allowed to default to YES. CVDA values are as follows:

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 that indicates whether transaction isolation is active. For it to be active, both transaction isolation and storage protection must be specified for the CICS region (the TRANISO and STGPROT system initialization parameters). CVDA values are as follows:

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 DSALIMIT value, that is, the overall limit for dynamic storage areas that reside below 16 MB (below the line).

XRFSTATUS(cvda)

Returns a CVDA value that indicates whether the current execution of CICS started as an active or alternate region under the extended recovery facility (XRF):

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.