CICSRGN Resource Table

A CICS® Resource that describes an active CICS region being managed by CICSPlex® SM.

The CICSRGN resource class does not provide an explicit key attribute. The set of object instances returned is a function of the current scope in effect when the request is made.

The following actions are supported:

Start of changeARMRESTARTEnd of change
Start of changeRequest an MVS CANCEL of the CICS system with an ARM restart. Note that this action will complete successfully even if the MVS CANCEL command fails. The userid associated with the CMAS (not the API user) must have the appropriate security access in order to issue the MVS CANCEL command successfully.End of change
DELETSHIPPED
Control the removal of redundant shipped terminal definitions.
RESETTIME
Reset the interval CICS clock.
SECREBUILD
Rebuild the ESM security profiles.
SHUTDOWN
Shutdown the CICS system.

The parameter data for the SHUTDOWN action is:

   PARM('<NORMAL | IMMEDIATE | TAKEOVER> <DUMP> <NORESTART>
         <PLT(plt)> <XLT(xlt)> <SDTRAN(tranid) | NOSDTRAN>.')

     where:

     plt    = 2-character DFHPLT suffix.
     xlt    = 2-character DFHXLT suffix.
     tranid = 1-to  8-character shutdown transaction ID.
SNAP
Request a system dump.

The parameter data for the SNAP action is:

   PARM('DUMPCODE(code) <CALLER(caller)> <TITLE(title)>.')

     where:

     code   = (Required) 1- to 8-character dump code.
     caller = Caller text.
     title  = Title text.
STATISTICS
Request statistics processing.

The parameter data for the STATISTICS action is:

   PARM('ALL <RESETNOW> |
         <AUTOINSTALL> <CONNECTION> <DISPATCHER> <DTBACKOUT> <FILE>
         <IRCBATCH> <JOURNAL> <LSRPOOL> <MONITOR> <PROGRAM>
         <STATISTICS> <STORAGE> <SYSDUMP> <TABLEMGR> <TASKCONTROL>
         <TRANCLASS> <TRANDATA> <TERMINAL> <TRANDUMP> <TRANSACTION>
         <TEMPSTOR> <VTAM> <FEPI> <PROGAUTOINS>.')
SWITCH
Switch auxiliary tracing from one data set to the other.
Length
920
Usage
API or EVALDEF
API view
Yes
CMAS context
No
SCOPE applies
Yes
Only query CMASs in workload
No
Object type
CICS Resource
Copybook identifier
EYUt0001 or CICSRGN
Valid API operations
GET SET and PERFORM

API Actions

SHUTDOWN
Shutdown

PARM(' [IMMEDIATE] [TAKEOVER] [NORMAL] [DUMP] [NORESTART] [PLT(value)] [XLT(value)] [SDTRAN(value)] [NOSDTRAN] .')

SNAP
Request system dump

PARM(' DUMPCODE(value) [CALLER(value)] [TITLE(value)] .')

SWITCH
Switch auxiliary tracing data set

Parameters: None

RESETTIME
Reset the internal CICS clock

Parameters: None

SECREBUILD
Rebuild security profiles

Parameters: None

DELETSHIPPED
Delete shipped terminal definitions

Parameters: None

STATISTICS
Request statistics processing

PARM(' [ALL] [RESETNOW] [AUTOINSTALL] [CONNECTION] [DISPATCHER] [DTBACKOUT] [FILE] [IRCBATCH] [JOURNAL] [LSRPOOL] [MONITOR] [PROGRAM] [STATISTICS] [STORAGE] [SYSDUMP] [TABLEMGR] [TASKCONTROL] [TRANCLASS] [TRANDATA] [TERMINAL] [TRANDUMP] [TRANSACTION] [TEMPSTOR] [VTAM] [FEPI] [PROGAUTOINS] [JRNLNAME] [STREAMNAME] [ENQUEUE] [RECOVERY] [DB2] [TCPIP] [TCPIPSERVICE] [CORBASERVER] [JVMPOOL] [REQUESTMODEL] [BEAN] [JVMPROFILE] [JVMPROGRAM] [URIMAP] [PIPELINE] [WEBSERVICE] .')

ARMRESTART
Request MVS CANCEL with ARM restart

Parameters: None

Table 24. CICSRGN FEEDBACK error codes
Code Description Code Description
ACTNOT_SUPPORTED Action not supported ARM_NOT_REGISTERED Not registered for ARM
ALL_REQUIRED Collect all statistics required ARM_POLICY_CHECK Current ARM policy prohibits ARM restart of this MAS
ARM_NOT_ACTIVE ARM restart unavailable - ARM not active on system INV_CONTEXT Context not found
ARM_NOT_AVAILCICSREL ARM invalid for CICS Release RESOURCE_REQUIRED Resource required
ARM_NOT_AVAILOPSYS ARM invalid for Operating System SYSTEM_NOT_ACTIVE System not active
Table 25. CICSRGN resource table attributes
Name Datatype Source Len Sum Set Description Get Invalid Set Invalid Attr ID
EYU_CICSNAME CHAR CPSM 8 N/A CICS System Name
EYU_CICSREL CHAR CPSM 4 N/A CICS Release
EYU_RESERVED CHAR CPSM 4 N/A Reserved
JOBNAME CHAR INQ 8 DIF Job name 1
APPLID CHAR INQ 8 DIF VTAM application ID 2
MVSSYSID CHAR CPSM 4 DIF MVS system ID 3
AKP CODEDBIN INQ 4 MAX yes Activity keypoint (AKP) frequency 4
AMAXTASKS BINARY INQ 4 AVG yes Maximum number of active tasks 5
MAXTASKS BINARY INQ 4 AVG yes Maximum number of active and suspended tasks 6
CICSSTATUS CVDAS INQ 4 LIKE CICS status 7
CICSSTATUS Output Valid Values STARTUP ACTIVE FIRSTQUIESCE FINALQUIESCE CONTROLSHUT SHUTDOWN CANCELLED FIRSTINIT SECONDINIT THIRDINIT INITCOMPLETE
SYSDUMP CVDAS INQ 4 LIKE yes System dump status 8
SYSDUMP Input/Output Valid Values SYSDUMP NOSYSDUMP
EXTSEC CVDAS INQ 4 LIKE External security status 9
EXTSEC Output Valid Values EXTSECURITY CICSSECURITY NOSECURITY
STARTUP CVDAS INQ 4 LIKE Startup type 10
STARTUP Output Valid Values COLDSTART WARMSTART EMERGENCY LOGTERM
STGPROT CVDAS INQ 4 LIKE Storage protection status 11
STGPROT Output Valid Values ACTIVE INACTIVE
DTRPROGRAM CHAR INQ 8 DIF yes Dynamic routing program name 12
GMMTRANID CHAR INQ 4 DIF Good morning transaction ID 13
MROBATCH BINARY INQ 4 AVG yes Number of MRO requests to be batched 14
OPREL BINARY INQ 2 AVG Operating system release 15
OPSYS CHAR INQ 1 DIF Operating system 16
CICSSYS CHAR INQ 1 DIF CICS operating system ID 17
PRTYAGING BINARY INQ 4 AVG yes Priority aging value 18
RELEASE CHAR INQ 4 DIF CICS Release 19
RUNAWAY BINARY INQ 4 AVG yes Runaway time interval 20
SCANDELAY BINARY INQ 4 AVG yes Terminal scan delay time 21
EXITTIME BINARY INQ 4 AVG yes Exit wait time 22
XRFSTATUS CVDAS INQ 4 LIKE Extended recovery facility (XRF) status 23
XRFSTATUS Output Valid Values PRIMARY TAKEOVER NOTAPPLIC
AINSPROG CHAR INQ 8 DIF yes Autoinstall program name 24
AINSCREQ BINARY INQ 4 AVG Number of current autoinstall requests 25
AINSMREQ BINARY INQ 4 AVG yes Maximum number of autoinstall requests 26
AINSSTAT CVDAS INQ 4 LIKE Autoinstall enabled status 27
AINSSTAT Output Valid Values ENABLED DISABLED
DDSOSTAT CVDAS INQ 4 LIKE yes Dump data set open status 28
DDSOSTAT Input/Output Valid Values OPEN CLOSED
DDSOSTAT Input Valid Values SWITCH
DDSSSTAT CVDAS INQ 4 LIKE yes Dump data set switch type 29
DDSSSTAT Input/Output Valid Values SWITCHNEXT NOSWITCH
IRCSTAT CVDAS INQ 4 LIKE yes Interregion communication (IRC) status 30
IRCSTAT Input/Output Valid Values OPEN CLOSED
IRCSTAT Input Valid Values IMMCLOSE
IRCSTAT Output Valid Values CLOSING IMMCLOSING
EVENTCLASS CVDAS INQ 4 LIKE yes SYSEVENT monitoring status E620 and higher 31
EVENTCLASS Input/Output Valid Values EVENT NOEVENT
EXCEPTCLASS CVDAS INQ 4 LIKE yes Exception class monitoring status 32
EXCEPTCLASS Input/Output Valid Values EXCEPT NOEXCEPT
PERFCLASS CVDAS INQ 4 LIKE yes Performance class monitoring status 33
PERFCLASS Input/Output Valid Values PERF NOPERF
MONSTAT CVDAS INQ 4 LIKE yes Monitor status 34
MONSTAT Input/Output Valid Values ON OFF
ENDOFDAY DECTIMES INQ 4 AVG yes Statistics end-of-day time 35
INTERVAL DECTIMES INQ 4 AVG yes Statistics recording interval 36
NEXTTIME DECTIMES INQ 4 AVG Next statistics recording time 37
RECORDING CVDAS INQ 4 LIKE yes Interval statistics recording status 38
RECORDING Input/Output Valid Values ON OFF
AUXSTATUS CVDAS INQ 4 LIKE yes Auxiliary trace status 39
AUXSTATUS Input/Output Valid Values AUXSTART AUXSTOP AUXPAUSE
GTFSTATUS CVDAS INQ 4 LIKE yes Generalized Tracing Facility (GTF) trace status 40
GTFSTATUS Input/Output Valid Values GTFSTART GTFSTOP
INTSTATUS CVDAS INQ 4 LIKE yes Internal trace status 41
INTSTATUS Input/Output Valid Values INTSTART INTSTOP
SWITCHSTATUS CVDAS INQ 4 LIKE yes Auxiliary trace data set switch type 42
SWITCHSTATUS Input/Output Valid Values NOSWITCH SWITCHNEXT SWITCHALL
TABLESIZE BINARY INQ 4 AVG yes Internal trace table size 43
SINGLESTATUS CVDAS INQ 4 LIKE yes Single task trace status 44
SINGLESTATUS Input/Output Valid Values SINGLEON SINGLEOFF
SYSTEMSTATUS CVDAS INQ 4 LIKE yes System trace status 45
SYSTEMSTATUS Input/Output Valid Values SYSTEMON SYSTEMOFF
TCEXITSTATUS CVDAS INQ 4 LIKE yes CICS VTAM exit trace status 46
TCEXITSTATUS Input/Output Valid Values TCEXITALL TCEXITSYSTEM TCEXITNONE
TCEXITSTATUS Input Valid Values TCEXITALLOFF
TCEXITSTATUS Output Valid Values NOTAPPLIC
USERSTATUS CVDAS INQ 4 LIKE yes User trace status 47
USERSTATUS Input/Output Valid Values USERON USEROFF
PLASTRESET DECTIMES STAT 4 AVG Last reset time 48
PEAKTASKS BINARY STAT 2 AVG Peak number of tasks in system 50
CURRAMAX BINARY STAT 2 AVG Current number of user tasks eligible for dispatch 51
PEAKAMAX BINARY STAT 2 AVG Peak number of user tasks eligible for dispatch 52
CUTCBCNT BINARY STAT 2 AVG Number of MVS task control blocks (TCBs) 54
LASTRESET BINARY STAT 8 AVG Last statistics reset time 55
LOADREQS BINARY STAT 4 AVG Number of load requests 56
LOADTIME INT16US STAT 4 MAX Total loading time 57
PRGMUCNT BINARY STAT 4 AVG Number of program uses 58
PRGMWAIT BINARY STAT 4 AVG Number of waiting loader requests 59
LOADWCNT BINARY STAT 4 AVG Number of tasks waiting for load requests 60
LOADHWMW BINARY STAT 4 AVG Peak number of tasks waiting for load requests 61
LOADHWMC BINARY STAT 4 AVG Number of times maximum suspended tasks reached 62
LOADWAIT INT16US STAT 4 MAX Total load waiting time 63
RDEBRBLD BINARY STAT 4 AVG Number of times DFHRPL reopened and load retried 64
PRGMRCMP BINARY STAT 4 AVG Number of programs removed by compression 65
LOADTNIU INTSTCK STAT 8 MAX Total time to remove not-in-use programs 66
LOADPNIU BINARY STAT 4 AVG Number of programs on not-in-use queue 67
LOADRNIU BINARY STAT 4 AVG Number of reclaims from not-in-use queue 68
SDMPTOTL BINARY STAT 4 AVG Number of system dumps taken 69
SDMPSUPP BINARY STAT 4 AVG Number of system dumps suppressed 70
TDMPTOTL BINARY STAT 4 AVG Number of transaction dumps taken 71
TDMPSUPP BINARY STAT 4 AVG Number of transaction dumps suppressed 72
STRTTIME DATETIME CPSM 8 MAX CICS start time 73
SYSID CHAR CPSM 4 DIF CICS system ID 74
CPUTIME INTUSEC CPSM 8 MAX Total CPU time used 75
PAGEIN BINARY CPSM 4 AVG Number of page-in requests 76
PAGEOUT BINARY CPSM 4 AVG Number of page-out requests 77
REALSTG BINARY CPSM 4 AVG Real storage in use 78
SIOREQ BINARY CPSM 4 AVG Number of I/O requests 79
VTMSTATUS CVDAS INQ 4 LIKE yes CICS-VTAM connection status 80
VTMSTATUS Input/Output Valid Values OPEN CLOSED
VTMSTATUS Input Valid Values IMMCLOSE FORCECLOSE
VTMSTATUS Output Valid Values CLOSING IMMCLOSING FORCECLOSING NOTAPPLIC
VTMRPLMAX DECIMAL STAT 4 AVG Number of times RPL maximum value was reached 81
VTMRPLPOST DECIMAL STAT 2 AVG Maximum number of VTAM RPLs posted 82
VTMSOSCNT BINARY STAT 2 AVG Number of times VTAM had short-on-storage status 83
VTMACBDOPE BINARY STAT 2 AVG Number of times VTAM ACB dynamically opened 84
CURRENTDDS CHAR INQ 1 DIF Current dump data set 85
INITIALDDS CHAR INQ 1 DIF yes Initial dump data set 86
CURAUXDS CHAR INQ 1 DIF Current auxiliary trace dataset 87
LUCURR BINARY STAT 4 AVG Number of LUs currently logged on 91
LUHWM BINARY STAT 4 AVG Highest number of LUs logged on at any one time 92
PRSSINQCNT BINARY STAT 4 AVG Number of CICS persistent-session inquiries 93
PRSSNIBCNT BINARY STAT 4 AVG Number of VTAM sessions that persisted 94
PRSSOPNCNT BINARY STAT 4 AVG Number of persistent sessions successfully restored 95
PRSSUNBNDCNT BINARY STAT 4 AVG Number of persistent sessions that were terminated 96
PRSSERRORCNT BINARY STAT 4 AVG Number of persistent sessions already unbound 97
CONVERSEST CVDAS INQ 4 LIKE yes Separate conversational task performance records 98
CONVERSEST Input/Output Valid Values CONVERSE NOCONVERSE
FREQUENCY DECTIMES INQ 4 AVG yes Performance record interval 99
SUBSYSTEMID CHAR INQ 4 DIF Subsystem ID used on SYSEVENT class records 100
SYNCPOINTST CVDAS INQ 4 LIKE yes Performance record at syncpoint 101
SYNCPOINTST Input/Output Valid Values SYNCPOINT NOSYNCPOINT
MONRPTTIME CVDAS INQ 4 LIKE Time zone for performance class records 102
MONRPTTIME Output Valid Values GMT LOCAL
DFLTUSER CHAR INQ 8 DIF Default user ID 103
PROGAUTOEXIT CHAR INQ 8 DIF yes Autoinstall program exit name 104
PROGAUTOCTLG CVDAS INQ 4 LIKE yes Autoinstalled-program catalog type 105
PROGAUTOCTLG Input/Output Valid Values CTLGALL CTLGMODIFY CTLGNONE
PROGAUTOINST CVDAS INQ 4 LIKE yes Status of autoinstall for programs 106
PROGAUTOINST Input/Output Valid Values AUTOACTIVE AUTOINACTIVE
TRANISOLATE CVDAS INQ 4 LIKE Transaction isolation status 107
TRANISOLATE Output Valid Values ACTIVE INACTIVE
STARTUPDATE DECDATE INQ 4 AVG Date on which CICS started 108
PSDINTERVAL DECTIMES INQ 4 AVG yes Persistent session delay interval 109
CURRTASKS BINARY INQ 4 AVG Current number of tasks 110
MAXTRCNT BINARY STAT 4 AVG Number of times MAXTASK limit reached 111
CURACTVUSRTR BINARY STAT 4 AVG Current number of active user transactions 112
CURQUEDUSRTR BINARY STAT 4 AVG Current number of queued user transactions 113
PEKACTVUSRTR BINARY STAT 4 AVG Peak number of active user transaction 114
PEKQUEDUSRTR BINARY STAT 4 AVG Peak number of queued user transactions 115
TOTACTVUSRTR BINARY STAT 4 AVG Total number of active user transactions 116
TOTDELYUSRTR BINARY STAT 4 AVG Total number of queued user transactions 117
TOTQUETIME INTSTCK STAT 8 MAX Total time queued transactions waited 118
CURQUETIME INTSTCK STAT 8 MAX Time currently queued transactions waiting 119
PROGAUTOATTM BINARY STAT 4 AVG Number of program autoinstall attempts 120
PROGAUTOXREJ BINARY STAT 4 AVG Number of times autoinstall prog request rejected 121
PROGAUTOFAIL BINARY STAT 4 AVG Number of failed program autoinstall attempts 122
INITSTATUS CVDAS INQ 4 LIKE Initialization status 133
INITSTATUS Output Valid Values FIRSTINIT SECONDINIT THIRDINIT INITCOMPLETE
SHUTSTATUS CVDAS INQ 4 LIKE Shutdown status 134
SHUTSTATUS Output Valid Values CONTROLSHUT SHUTDOWN CANCELLED NOTAPPLIC
INTVTRANS BINARY STAT 4 AVG Transactions run since last CICS statistics reset 135
GMMTEXT CHAR INQ 246 DIF yes Good morning message 136
GMMLENGTH BINARY INQ 2 AVG Good morning message length 137
GRNAME CHAR INQ 8 DIF CICS registered generic name 138
GRSTATUS CVDAS INQ 4 LIKE yes Generic resource registration status 139
GRSTATUS Input/Output Valid Values DEREGISTERED
GRSTATUS Output Valid Values REGISTERED UNREGISTERED UNAVAILABLE REGERROR DEREGERROR
REENTPROTECT CVDAS INQ 4 LIKE Reentrant program protection status 140
REENTPROTECT Output Valid Values REENTPROT NOREENTPROT
CMDPROTECT CVDAS INQ 4 LIKE Command protection status 141
CMDPROTECT Output Valid Values CMDPROT NOCMDPROT
SOSSTATUS CVDAS INQ 4 LIKE Short on storage status 142
SOSSTATUS Output Valid Values SOS NOTSOS SOSABOVE SOSBELOW
TOTLTASKS BINARY STAT 8 AVG Total number of tasks 143
RLSSTATUS CVDAS INQ 4 LIKE Record level sharing (RLS) status 144
RLSSTATUS Output Valid Values RLSACTIVE RLSINACTIVE NOTAPPLIC
DFLTREMSYS CHAR INQ 4 DIF yes Default remote system 145
SDTRAN CHAR INQ 4 DIF Shutdown transaction 146
DSIDLE DECTIMES INQ 4 MAX yes Minimum terminal idle-time before deletion 147
DSINTERVAL DECTIMES INQ 4 MAX yes Idle terminal check interval 148
CTSLEVEL CHAR INQ 6 DIF CICS Transaction Server level 149
OSLEVEL CHAR INQ 6 DIF OS/390 level 150
RRMSSTAT CVDAS INQ 4 LIKE Resource recovery management service (RRMS) status 151
RRMSSTAT Output Valid Values OPEN CLOSED
MVSSYSNAME CHAR CPSM 8 DIF MVS system name 152
FORCEQR CVDAS INQ 4 LIKE yes Force quasi-reentrancy 153
FORCEQR Input/Output Valid Values FORCE NOFORCE
MAXOPENTCBS BINARY INQ 4 AVG yes Maximum number of Open pool TCBs 154
ACTOPENTCBS BINARY INQ 4 AVG Number of currently allocated Open pool TCBs 155
DSRTPROGRAM CHAR INQ 8 DIF yes Distributed routing program 156
CONSOLES CVDAS INQ 4 LIKE yes Autoinstall console status 157
CONSOLES Input/Output Valid Values PROGAUTO FULLAUTO NOAUTO
TCPIP CVDAS INQ 4 LIKE yes TCP/IP status 158
TCPIP Input/Output Valid Values OPEN CLOSED
TCPIP Input Valid Values IMMCLOSE
TCPIP Output Valid Values CLOSING IMMCLOSING OPENING
GARBAGEINT BINARY INQ 4 AVG yes Web domain garbage collection interval 159
TIMEOUTINT BINARY INQ 4 AVG yes Web domain terminal timeout interval 160
COLDSTATUS CVDAS INQ 4 LIKE Cold start status 161
COLDSTATUS Output Valid Values COLD INITIAL NOTAPPLIC
MAXHPTCBS BINARY INQ 4 AVG yes Maximum number of HP pool TCBs E530 and E640 and higher 162
ACTHPTCBS BINARY INQ 4 AVG Number of currently allocated HP pool TCBs E530 and E640 and higher 163
MAXJVMTCBS BINARY INQ 4 AVG yes Maximum number of JVM pool TCBs E530 164
ACTJVMTCBS BINARY INQ 4 AVG Number of currently allocated JVM pool TCBs E530 165
SUBTASKS BINARY INQ 4 AVG Value set by the SUBTSKS system initialization parameter E530 166
DEBUGTOOL CVDAS INQ 4 LIKE yes Debugging profiles status E530 and E620 167
DEBUGTOOL Input/Output Valid Values DEBUG NODEBUG
MAXXPTCBS BINARY INQ 4 AVG yes Maximum number of XPLink pool TCBs E530, E620 and E630 168
ACTXPTCBS BINARY INQ 4 AVG Number of currently allocated XPLink pool TCBs E620 and E630 169
MAXSSLTCBS BINARY INQ 4 AVG yes Maximum number of SSL pool TCBs E530, E620 and E630 170
ACTSSLTCBS BINARY INQ 4 AVG Number of currently allocated SSL pool TCBs E620 and E630 171
[[ Contents Previous Page | Next Page Index ]]