CICSPlex SM system parameters in EYUPARM data set
You can use a number of system parameters to identify or alter CICSPlex® SM attributes. An extrapartition transient data queue called COPR specifies these parameters. The CICSPlex SM system parameters are contained in the EYUPARM data set.
You can assign these parameters to a DD * file, sequential data set, or a partitioned data set member. The DD name for the extrapartition transient data queue is EYUPARM.
keyword(v)keyword- The name of a CICSPlex SM system parameter.
v- An alphanumeric data value that you can specify with the system parameter.
For details of each parameter, see CICSPlex SM system parameters in detail.
Samples of CICSPlex SM system parameters
- EYUCMS0P
- CMAS parameters
- EYULMS0P
- Local MAS parameters
EYUCMS0P and EYULMS0P are supplied uncustomized in TDFHINST and customized in XDFHINST. Before using these members to start a CMAS, MAS, or WUI server, remove the comments from the samples and supply the appropriate values.
Summary of CICSPlex SM system parameters
| Parameter | CMAS | MAS and WUI server | Default |
|---|---|---|---|
| ALERTRCVR | Optional | n/a | NETVALRT |
| ALERTVER | Optional | n/a | 0 |
| APISIGNMSG | Optional | n/a | YES |
| BASASSOCBLK | Optional | n/a | 14301 |
| BASLOGMSG | n/a | Optional | NO |
| CACHEDSNUM | Optional | n/a | 2 |
| CICSPLEX | n/a | Required | |
| CMASSYSID | n/a | Optional | See description |
| CMTCMLNKACQ | Optional | n/a | RECONN |
| COHTTASKPRI | n/a | Optional | 200 |
| COIRTASKPRI | n/a | Optional | 200 |
| COMMTSBLOCKS | Optional | Optional | 128 (MAS) |
| 512 (CMAS) | |||
| HISTORYONLY | n/a | Optional | NO |
| HISTRECSMSG | n/a | Optional | 0 |
| HISTSECS | n/a | Optional | 30 |
| JRNLDEFCH | Optional | n/a | NO |
| JRNLOPACT | Optional | n/a | NO |
| JRNLRTAEV | Optional | n/a | NO |
| MASALTLRTCNT | n/a | Optional | 0 |
| MASALTLRTPRI | n/a | Optional | 255 |
| MASALTLRTTIM | n/a | Optional | 10 |
| MASINITTIME | n/a | Optional | 10 |
| MASPLTWAIT | n/a | Optional | NO |
| MASTASKPROT | Optional | n/a | NO |
| MAXAUXCPSM | Optional | n/a | 50 |
| MAXAUXTOTL | Optional | n/a | 70 |
| MAXHISTRECS | n/a | Optional | 1 |
| MSGBUCKETS | n/a | Optional | 1024 |
| NAME | Optional | Optional | |
| RESSTATUS | Optional | n/a | NOTIFY |
| SEC | Optional | n/a | NO |
| SECLOGMSG | Optional | n/a | NO |
| SECRPTLVL | Optional | n/a | RESPONSE |
| SECTIMEOUT | Optional | n/a | 30 |
| SPOOLCLASS | Optional | Optional | P |
| STALLASYTSK | n/a | Optional | 4 |
| STALLASYCNT | n/a | Optional | 4 |
| STALLCONTSK | n/a | Optional | 2 |
| STALLCONCNT | n/a | Optional | 3 |
| STALLDBCTSK | n/a | Optional | 4 |
| STALLDBCCNT | n/a | Optional | 4 |
| STALLDB2TSK | n/a | Optional | 4 |
| STALLDB2CNT | n/a | Optional | 4 |
| STALLDLITSK | n/a | Optional | 4 |
| STALLDLICNT | n/a | Optional | 4 |
| STALLDSPTSK | n/a | Optional | 4 |
| STALLDSPCNT | n/a | Optional | 2 |
| STALLEJBTSK | n/a | Optional | 2 |
| STALLEJBCNT | n/a | Optional | 3 |
| STALLENQTSK | n/a | Optional | 4 |
| STALLENQCNT | n/a | Optional | 4 |
| STALLFLETSK | n/a | Optional | 3 |
| STALLFLECNT | n/a | Optional | 4 |
| STALLILKTSK | n/a | Optional | 2 |
| STALLILKCNT | n/a | Optional | 3 |
| STALLIPCTSK | n/a | Optional | 2 |
| STALLIPCCNT | n/a | Optional | 3 |
| STALLLCKTSK | n/a | Optional | 4 |
| STALLLCKCNT | n/a | Optional | 4 |
| STALLLGRTSK | n/a | Optional | 2 |
| STALLLGRCNT | n/a | Optional | 3 |
| STALLITVTSK | n/a | Optional | 0 |
| STALLITVCNT | n/a | Optional | 0 |
| STALLJNLTSK | n/a | Optional | 1 |
| STALLJNLCNT | n/a | Optional | 3 |
| STALLMQSTSK | n/a | Optional | 2 |
| STALLMQSCNT | n/a | Optional | 3 |
| STALLPGMTSK | n/a | Optional | 2 |
| STALLPGMCNT | n/a | Optional | 4 |
| STALLRMITSK | n/a | Optional | 2 |
| STALLRMICNT | n/a | Optional | 3 |
| STALLSESTSK | n/a | Optional | 2 |
| STALLSESCNT | n/a | Optional | 3 |
| STALLSOCTSK | n/a | Optional | 2 |
| STALLSOCCNT | n/a | Optional | 3 |
| STALLSTGTSK | n/a | Optional | 1 |
| STALLSTGCNT | n/a | Optional | 2 |
| STALLTDQTSK | n/a | Optional | 3 |
| STALLTDQCNT | n/a | Optional | 4 |
| STALLTRMTSK | n/a | Optional | 0 |
| STALLTRMCNT | n/a | Optional | 0 |
| STALLTSKTSK | n/a | Optional | 0 |
| STALLTSKCNT | n/a | Optional | 0 |
| STALLTSQTSK | n/a | Optional | 3 |
| STALLTSQCNT | n/a | Optional | 4 |
| STALLUSRTSK | n/a | Optional | 0 |
| STALLUSRCNT | n/a | Optional | 0 |
| STALLWEBTSK | n/a | Optional | 2 |
| STALLWEBCNT | n/a | Optional | 3 |
| STALLXMGTSK | n/a | Optional | 4 |
| STALLXMGCNT | n/a | Optional | 2 |
| STALLXRFTSK | n/a | Optional | 1 |
| STALLXRFCNT | n/a | Optional | 2 |
| SUPPRESSCMF | n/a | Optional | NO |
| TOBATCHREQ | Optional | n/a | 0 |
| TOONLINEREQ | Optional | n/a | 0 |
| TOPOLLINT | Optional | n/a | 300 |
| WLMLCUSH | n/a | Optional | 20 |
CICSPlex SM system parameters in detail
- ALERTRCVR(NETVALRT | name)
- Identifies the 1- 8-character name of the NetView Alert Receiver to be used by the CMAS if the CMAS sends NetView Generic Alerts to NetView.
- ALERTVER( 0 | 1 )
- Identifies the version of the CICSPlex SM
generic alert record that the CMAS sends to NetView. See
Generic alert and resolution structures for details about the generic alert Records that
CICSPlex SM sends to NetView.
ALERTVER is relevant only for a CMAS that i named in an ACTNDEF as a CMAS that sends generic alerts to NetView.
- APISIGNMSG(YES | NO)
- Indicates whether the successful signon and signoff message, EYUXD0807I, is issued when a CICSPlex SM API user connects to, or disconnects (TERMINATE) from, the CICSPlex SM API.
- BASASSOCBLK(value | 14301)
- Specifies the number of BAS association blocks that can be acquired from a single association element. The default EYUPARM value creates an association segment size requiring approximately 1.2 MB of storage. If you specify the maximum value of 114597 blocks-per-segment is specified, then the resultant segment size is just over 8 MB.
- BASLOGMSG(YES | NO)
- Indicates whether CICS® resources defined using BAS must
have their definitions logged to the CSDL Transient Data Queue of the MAS when they are installed.
If the CICS version used by the MAS does not support the LOGMESSAGE option of the EXEC CICS CREATE command, BASLOGMSG has no effect.
- CACHEDSNUM(value | 2)
-
Specifies the number of data spaces that this CMAS creates for each CICSPlex SM component. At least 1MB is allocated in each data cache when the data space is created. The value must be in the range 1 to 8.
You can change this parameter only on a CPSM CMAS cold start. Normally, do not change this parameter unless advised to do so by IBM® Support.
- CICSPLEX(name)
- Identifies the 1- to 8-character name of the
CICSplex to which the local MAS is to be associated.
The name of a CICSplex must not be the same as the name of a CMAS, a CICS system, or a CICS system group.
- CMASSYSID(name)
- Identifies the 1- to 4-character name of the
CMAS to which a MAS is to be attached. If a MAS specifies a CMASSYSID and the CMAS is
active but does not manage the CICSplex, the MAS waits until the specified CMAS is managing the
CICSplex before it joins the CICSplex.You can also use this parameter when a local MAS is to attach to a specific CMAS in the same z/OS® image.Note: This parameter is optional. However; for a specific release of CICSPlex SM, if you do not specify a value for the CMASSYSID parameter and you have multiple CMASs on an z/OS system, a local MAS will connect to the last CMAS initialized on the z/OS system that manages the CICSplex specified by the CICSPLEX parameter.
- CMTCMLNKACQ(ALWAYS | RECONN)
- Specifies whether you want the CMAS to attempt to reacquire LU6.2 CMAS to CMAS links (CMTCMLNKs)
if the initial acquire attempt made by CICS fails. The
initial acquire attempt is made by CICS when a CMAS is
started, a z/OS Communications Server ACB is opened, or a
CMAS to CMAS definition (CMTCMDEF) is installed. If the initial acquire attempt fails, CICSPlex SM network surveillance might attempt to
re-acquire the LU6.2 CMAS to CMAS links depending on the value of CMTCMLNKACQ:
- If CMTCMLNKACQ is set to ALWAYS, the CMAS attempts to acquire CMTCMLNKs, independent of whether the links were established in the current CMAS run.
- If CMTCMLNKACQ is set to RECONN, the CMAS attempts to re-acquire CMTCMLNKs only where CMTCMLNKs were established in the current CMAS run.
If the CMTCMLNKs were not acquired in the current CMAS run and the initial acquire attempts fail, CMTCMLNK must manually be acquired.
Depending on the CMTCMLNKACQ option that you are using, repeated failed acquire attempts can produce messages DFHZC3437, DFHZC3462 and DFHZC2405 and z/OS Communications Server IST663 and IST664.
CMTCMLNKACQ can be dynamically changed in a CMAS using the COD0 SET command.
- COHTTASKPRI(value | 200)
- Specifies the task priority of COHT, in the range 0 - 255. COHT is a CICSPlex SM system task that you can use to process evaluation definitions, EVALDEFs, independent of the MAS. COHT is invoked in a MAS when an API or a Web User Interface query for completed task history records (HTASK records) is directed to the MAS. Use this parameter to tune the priority of HTASK requests so that a resource-intensive query does not affect the performance of other tasks in the MAS.
- COIRTASKPRI(value | 200)
- Specifies the task priority of COIR, in the
range 0 - 255. COIR is a CICSPlex SM system task
that you can use to process evaluation definitions, EVALDEFs, independent of the MAS.
For each EVALDEF that requests a separate task, an instance of COIR is started at the specified priority. If you specify a priority of 0, no separate COIR system tasks are started; all EVALDEFs are processed by the MAS long running task (LRT).
- COMMTSBLOCKS((value | 512/128)
- Specifies the number of sets of control blocks allocated at CMAS or MAS startup for CICSPlex SM Communications Transport Services. These
control blocks are used when data must be shipped between a CMAS or MAS and other CMASs or MASs.
The default and minimum values for this parameter are 512 in a CMAS and 128 in a MAS. The maximum value is 8192 in either a CMAS or MAS.
Each set requires 1204 bytes of storage allocated in ESDSA in the CMAS or MAS. If the defaults are used, this amount of total storage is allocated:- CMAS: 512 * 1204 = 616,448 bytes
- MAS: 128 * 1204 = 154,112 bytes
- CMAS: 8192 * 1204 = 9,863,168 bytes
- MAS: 8192 * 1204 = 9,863,168 bytes
- HISTORYONLY( YES | NO)
- Specifies whether history data is collected without collecting normal CICSPlex SM monitoring data as well. For example, if MLOCTRAN and MREMTRAN data is not required set HISTORYONLY(YES) to prevent this data from being collected.
- HISTRECSMSG( value | 0)
- Specifies that message EYUNL0179I
Task History Recorder data set EYUHISTx has accrued nnnn records
is produced each timevalue
thousand records are written to the history data sets. The maximum allowed value is 1000 which specifies that a message is produced every time 1 million records are written to the history data sets.The message is an aid to determining the optimum size of the history data sets. A value of 0 means that no EYUNL0179I messages are to be produced.
- HISTSECS( value | 30)
- Specifies the number of seconds to use as the default when API or Web User Interface users specify a parameter of RECENT(HISTSECS) when requesting completed task (HTASK) resource table records. The maximum allowed value is 86400 seconds (24 hours).
- JRNLDEFCH(YES | NO)
- Causes a journal record to be written for each data repository add, delete, and update operation.
- JRNLOPACT(YES | NO)
- Causes a journal record to be written for each successful action command issued against a MAS or CMAS.
- JRNLRTAEV(YES | NO)
- Causes a journal record to be written each time a real-time analysis (RTA) event is generated.
- MASALTLRTCNT(0 - 5 | 0)
- Indicates the number of alternate
long-running system tasks (CONA) started in the MAS during MAS agent initialization. These system
tasks remain active until the MAS agent stops or goes into restart mode, and handle all API, WUI, or
RTA requests normally handled by the CONL system task, allowing the CONL system task to perform
other processing in the MAS. At any time, only one of the CONA system tasks processes requests. If
the CONA system task that is currently processing requests becomes busy (as determined by the value
of the MASALTLRTTIM EYUPARM), subsequent requests are directed to another CONA system task.
If you specify zero (0), no CONA system tasks are started and the CONL system task services the API, WUI or RTA requests that are normally directed to the long running system task. Specifying different values for MASALTLRTCNT for multiple WLM target regions cause an uneven distribution of transactions to those regions because of differing long-running task counts.
- MASALTLRTPRI(0 - 255 | 255)
- Specifies the priority given to the CONA transaction for running the current MAS. If you specify this value as less than 255 you might adversely affect the response time of API and WUI users and stop RTA EVENTs from being created or resolved in a timely manner.
- MASALTLRTTIM(1 - 3600 | 10)
- Specifies the amount of time in seconds for which a CONA task can be busy before subsequent requests are directed to another active CONA task.
- MASINITTIME(value | 10)
- Specifies the number of minutes, from 5 to
59, that CICSPlex SM waits for the MAS to
initialize.
- If you specify MASPLTWAIT(YES), the MASINITTIME value is the maximum length of time that PLT processing can be suspended for MAS initialization. (By suspending PLT processing, the chance of completing MAS initialization in a specified time is increased, because you are asking for less work to be done in a given time interval and thereby reducing the scope for contention during that time).
- If you specify MASPLTWAIT(NO), the MASINITTIME value is the maximum length of time that can elapse before MAS initialization is halted if it does not complete.
- MASPLTWAIT(YES | NO)
- Indicates whether CICSPlex SM suspends all PLT processing until the MAS is fully initialized and connected to the CMAS.
- When you specify MASPLTWAIT(YES), no CICS applications can be started and no users can sign on to the system until CICSPlex SM completes the installation of resources and resumes PLT processing.
- If CICSPlex SM does complete the installation of resources and resume PLT processing in the time interval specified by MASINITTIME, message EYUTS0003I is issued.
- If it does not complete in the time interval specified by MASINITTIME, one of two messages will
be issued:
- EYUNL0090W is issued when MAS initialization is halted and PLT processing resumes to allow the region to function as a CICS region without CICSPlex SM control.
- EYUXL0090W is issued when MAS initialization is halted and PLT processing resumes to allow the region to function as a CICS region without CICSPlex SM control, but the MAS agent continues to wait for the CICSplex to be registered with the ESSS subsystem by a starting CMAS. When a CMAS registers the CICSplex, MAS agent initialization will continue.
- MAS initialization can be retried by entering the COLM transaction manually.
- When you specify MASPLTWAIT(NO), CICSPlex SM still observes the MASINITTIME value waiting for the MAS agent to complete the topology connect.
- If CICSPlex SM does not complete the topology connect in the time interval specified by MASINITTIME or its default value, message EYUNL0090W is issued, the MAS initialization is halted, and the PLT processing resumes to allow the region to function as a CICS region without CICSPlex SM control.
- MAS initialization can be retried by entering the COLM transaction manually.
If you are including a CICS system in a platform, or if you are using Business Application Services (BAS) to automatically install resources at CICS system initialization, specify MASPLTWAIT(YES) for that system. MASPLTWAIT(YES) is required to automatically install resources for an application or platform, or BAS resources, when the CICS region is initialized.
If you are using Business Application Services (BAS) to automatically install a Db2® connection, and you want the connection to be activated during CICS startup, see Activating Db2 and IBM MQ connections during CICS startup.
- MASTASKPROT (YES | NO)
- Controls whether the CICSPlex SM API, Web User Interface (WUI), and CICS Management Client Interface (CMCI) are allowed to perform
actions or set attribute values forCICSPlex SM
MAS agent system tasks with transaction IDs COIE, COI0, CONA, or CONL.
Note: Beginning with CICS TS Version 5.4, CICSPlex SM MAS agent tasks that execute in a MAS that is at CICS TS Version 5.4 cannot be terminated with FORCEPURGE. If the MAS is at a release level earlier than CICS TS Version 5.4, these tasks can be terminated with FORCEPURGE.
- If you specify MASTASKPROT(NO), the default, users of the CICSPlex SM API, WUI, and CMCI are allowed to FORCEPURGE or modify attribute values for CICSPlex SM MAS agent tasks.
- If you specify MASTASKPROT(YES), CICSPlex SM
validates the transaction ID of all tasks before allowing actions to be performed, or attribute
values to be modified for active tasks. If the transaction ID indicates that the task runs as part
of the CICSPlex SM MAS agent, the request is not
processed, and a CICS response is set as follows:
- RESP = TASKIDERR
- RESP2 = 2 (The task is protected by CICS and is not eligible for modification with this command.)
The function code (EIBFN) is null, to indicate that the response is simulated and not set by the CICS SPI.
- MAXAUXCPSM(value | 50)
- Specifies the percentage of total auxiliary storage that can be committed to each CMAS, in the
range of 0 to 99. A value of 0 stops CICSPlex SM
from checking the amount of space used. Important: Setting a value of 0 might result in a shortage of auxiliary storage, requiring an IPL of the z/OS system.
Each CMAS requires 24,160 4 KB pages (94 MB) of cache storage at initialization. If a request for additional cache storage would cause the CMAS to exceed the MAXAUXCPSM threshold, an SDUMP is taken and the CMAS is terminated. If the threshold is exceeded during CMAS initialization, the CMAS was unable to acquire the initial allocations for all required component data cache areas. Either increase the value of MAXAUXCPSM, or increase the total amount of auxiliary storage by adding or expanding external page data sets. If this threshold is reached during an attempt to create or extend a data cache after CMAS initialization has completed, the automatic restart mechanism (ARM) is invoked to attempt to restart the CMAS.
- MAXAUXTOTL(value | 70)
- Specifies the maximum total auxiliary storage use at which the CMAS allows a request for
additional cache storage to be made, in the range of 0 to 99. A value of 0 stops CICSPlex SM from checking the amount of space used.
Important: Setting a value of 0 might result in a shortage of auxiliary storage, requiring an IPL of the z/OS system.
Setting a nonzero value for MAXAUXTOTL prevents the CMAS from requesting an amount of cache storage that would cause the z/OS system to enter a state of auxiliary storage shortage. If a request for additional cache storage causes the CMAS to exceed this threshold, an SDUMP is taken and the CMAS is terminated. This parameter can cause a CMAS to shut down even though the CMAS is not the largest user of auxiliary storage. If such a shutdown occurs during CMAS initialization, the CMAS was unable to acquire the initial allocations for all required component data cache areas. You must increase the total amount of auxiliary storage available by adding or expanding external page data sets. If this threshold is reached during an attempt to create or extend a data cache after CMAS initialization has completed, the automatic restart mechanism (ARM) is invoked to attempt to restart the CMAS.
- MAXHISTRECS( value | 1)
- Specifies a value in thousands, in the range 1 to 50. This value is a limit on the number of records returned on a completed task query from the MAS. You can limit the amount of data in a request for completed task (HTASK) resource table records. When this limit is reached, the CICSPlex SM API GET request receives a WARNING response and MAXRECORDS reason.
- MSGBUCKETS(value | 1024)
- Specifies a value in the range 1 - 32768. This value specifies the number of buffers to be allocated for Topology data collection in the MAS. Each buffer is 64 bytes long. The buffer pool, allocated in the MAS cache data space, is used by CICSPlex SM XMEOUT and XRSINDI global user exits and by the MAS Heartbeat task. The number of buffers must equal or exceed the total number of connections, DSNAMEs, GLUEs, TRUEs, and FEPI connections defined in the MAS. If the number of buffers is not sufficient for the Topology mapped resources in the MAS, a trace record with debug text XDATLOST is written at every other heartbeat interval when MAS Topology resource data is collected. Without sufficient buffers, resources are missing from Topology Resource Maps for the MAS in all CMASes in the CICSplex, and query or action requests entered from the WUI or API for specific resources can fail because the target resources are not known to Topology.
- NAME(name)
- Identifies the 1- to 8-character name of the CMAS or local MAS that is to be started. If you do not specify this parameter, the default is the z/OS Communications Server application ID.
- RESSTATUS(NOTIFY | MSG | CONMSG)
- Indicates how the CMAS is to respond when a CICS
resource that is being reported to the resource
status facility has a change in operational state:
- NOTIFY
- Issues event notifications in the form of ERESSTAT resource table records.
You can monitor these event notifications by using the LISTEN command of the CICSPlex SM API. For more information, see LISTEN command.
- MSG
- Writes external messages to EYULOG.
If you specify MSG, event notifications are produced in addition to the messages.
- CONMSG
- Writes external messages to the job log, console, and EYULOG.
If you specify CONMSG, event notifications are produced in addition to the messages.
Use this option with care. It can cause many messages to be sent to the console.
- SEC(YES | NO)
- For a CMAS, indicates whether the CMAS is to perform
security checking of CICSPlex SM requests
directed to the CICS systems it manages.
If you specify NO, all security-related parameters are ignored.
If a CMAS manages any CICS regions that are running with security active (SEC=YES specified as a system initialization parameter), the CMAS must include SEC(YES) in EYUPARM. If you do not activate CICSPlex SM security in the CMAS, a connection cannot be established to a CICS system that specifies SEC=YES. If a connection is attempted, the following message is issued to the console, the CMAS job log, and the CMAS EYULOG:EYUCR0007E Security mismatch between CMAS cmasname and MAS masname. Connection terminating.If a CMAS that is started with SEC(NO) connects directly or indirectly to a CMAS started with SEC(YES), any request sent to the SEC(YES) CMAS fails.- If the request originates from the CICSPlex SM API connected to the SEC(NO) CMAS, the API request receives: RESPONSE 1031 NOTPERMIT REASON 1345 USRID
- If the request originates from the CICSPlex SM Web User Interface server connected to a SEC(NO) CMAS, the Web browser receives the message EYUVC1220E
- SECLOGMSG(NO | YES | ALL)
- Controls whether CICSPlex SM issues message EYUCR0009I to the CMAS
EYULOG to record security failures.
When you specify NO, the default, message EYUCR0009I is not issued.
Specify YES, or ALL, to cause message EYUCR0009I to be issued.
SECLOGMSG(YES) can be useful if the External Security Manager (ESM) does not issue messages when it cannot make a decision or when a failure occurs.
When you specify SECLOGMSG(YES), EYUCR0009I is issued only for requests that are to be logged to the ESM.
SECLOGMSG(ALL) causes EYUCR0009I to be issued even when the ESM permits access to the resource. The ALL operand can produce many EYUCR0009I messages and must normally be used only under the direction of IBM Support.
You can change SECLOGMSG dynamically in a CMAS with the COD0 SET command.
- SECRPTLVL (NONE | RESPONSE | DETAIL)
- Controls the level of detail available to a
client API task when a response of NOTPERMIT with reason USRID is returned by a request.
When you specify NONE, all indications of a security validation exception are suppressed. A response of OK or NODATA, as appropriate, is returned to the client API task.
Specifying the default, RESPONSE, causes the original API response of NOTPERMIT and reason of USRID to be returned to the client task.
Specifying DETAIL causes a result set of MASQRYER resources to be built, identifying the regions in which the requesting user was denied access to a resource. MASQRYER resources can be retrieved by running a FETCH command, passing the QUERYERROR parameter.
Note: The SECRPTLVL parameter controls the response from the CMAS in which it is processed even though the API request might have originated in a different CMAS. Thus a CMAS which manages MASs containing sensitive resources can be started with SECRPTLVL(NONE), while other CMASs managing MASs with lower sensitivity can be started with SECRPTLVL(RESPONSE) or SECRPTLVL(DETAIL). - SECTIMEOUT(value | 30)
- Specifies the time in minutes, in the range of
1 through 1440 (1 day), that idle user IDs are to remain signed on in the CMAS before being
considered for timeout.
You can also use this value to control how often the CMAS checks for idle users to timeout. For example, with the default value of 30, the CMAS checks every 30 minutes for users who have not used the CMAS for 30 minutes. However, because the times are not synchronized the user ID might not be timed out for up to double the SECTIMEOUT value. Setting a low value increases the number of calls to RACF®. Setting a high value means that users might have to wait a long time before automatically picking up security changes that affect the user ID (for example, adding the user to a new group).
You can use the CMAS or CMASLIST PURGE request, available from the API and WUI, to force a CMAS to check for users to time out immediately.
You can use the CMAS or CMASLIST RESET USERID request, available from the API and WUI, to force the CMAS to rebuild the user's security information the next time it is used. This request is used after adding or removing a user ID to or from a group, and the user does not want to wait to be timed out to pick up the change.
Note: 6.2 and later If RACFSYNC=YES is specified for the CMAS region, when the CMAS receives a type 71 ENF event, security information for the affected user ID is rebuilt the next time the user ID is used, irrespective of the setting of the SECTIMEOUT parameter. - SPOOLCLASS(class | P)
- Specifies a SYSOUT class value, from A to Z or
0 to 9, that identifies where CICSPlex SM spool
output is to be sent. Spool output can be generated by these CICSPlex SM functions:
- The online utility transaction COLU
- The PRINT and CAPTURE commands of the interactive debugging transaction COD0
- STALLxxxCNT
- xxx represents a CICSPlex SM suspend class. The values for xxx are shown in Table 2.
Identifies the number of consecutive occurrences of an entry in the suspend class required for CICSPlex SM to report a STALL. The value can be 0 - 999. Use 0 to indicate that STALL detection for the xxx suspend class is not active. The default value for each task is shown in Table 1.Note:
- From CICS Transaction Server for z/OS 5.4, tasks that are internally initiated in a MAS by CICSPlex SM no longer execute as user tasks. As a result, these tasks no longer qualify for STALL detection.
- From CICS Transaction Server for z/OS 5.4, MQSERIES suspends on the GETWAIT resource are not applicable for STALL detection.
- STALLxxxTSK
- xxx represents a CICSPlex SM suspend class. The values for
xxx are shown in Table 2. Identify the minimum number of concurrent tasks required to enter the suspend class. The value can be 0 - 999. Use 0 to indicate that STALL detection for the xxx suspend class is not active. The default value for each task is shown in Table 1.
EYUPNxxxx messages are issued when a stall condition occurs that generates a real-time analysis system availability monitoring (SAM) event.
Note:- From CICS Transaction Server for z/OS 5.4, tasks that are internally initiated in a MAS by CICSPlex SM no longer execute as user tasks. As a result, these tasks no longer qualify for STALL detection.
- From CICS Transaction Server for z/OS 5.4, MQSERIES suspends on the GETWAIT resource are not applicable for STALL detection.
- SUPPRESSCMF(YES | NO)
- For a local MAS, indicates whether the records collected by the CICS Monitor Facility are written to SMF.
The parameter suppresses only CICS type 3 performance class records. Type 4 exception records and type 5 transaction resource records are not suppressed. The type 3 performance records are suppressed only if the CICS region has an active CICSPlex SM monitor definition installed for the MTRAN monitoring class. You can verify which CICS regions have active monitoring for the MTRAN class by using the WUI Active monitor specifications (POLMON) tabular view.
- TOBATCHREQ(value | 0)
- Specifies
the time in seconds before a batch request directed to a MAS is timed out. This time includes RTA
requests and API requests initiated from non-CICS programs.
Specify zero or a value in the range 10 - 1800.
- If you specify zero, the default value of 240 seconds (4 minutes) is applied. This value is then doubled when the request is transmitted to the MAS.
- If you specify a non-zero value in the range 10 - 1800, that value is used.
- If you specify a non-zero value less than 10, TOBATCHREQ is set to 10.
Depending on the value specified for TOBATCHREQ, more timeouts can be received. You can check in the following ways:- RTA requests
- No data is processed for any MAS that times out and no external message is displayed. This occurrence might mean that an event is not created or might lead to premature termination of existing events.
- API requests initiated from non-CICS programs
- All API requests initiated from non-CICS programs receive a RESPONSE of ENVIRONERROR (1030) and REASON of REQTIMEOUT (1342) and no data records are returned, regardless of the CONTEXT and SCOPE of the request.
- TOONLINEREQ(value | 0)
- Specifies
the time in seconds before an online request directed to a MAS is timed out, including WUI requests
and API requests initiated from CICS programs. Specify zero,
or a value in the range 10 - 1800.
- If you specify zero, the default value of 240 seconds (4 minutes) is applied. This value is then doubled when a CMAS-to-CMAS link is crossed. For example, you might have a WUI connected to CMAS-1 and MAS-2 is connected to CMAS-2. If you inquire from the WUI to MAS-2, the TOONLINEREQ default value of 240 seconds is doubled to 480 seconds because the request is transmitted from CMAS-1 to CMAS-2.
- If you specify a non-zero value in the range 10 - 1800, that value is used.
- If you specify a non-zero value less than 10, TOONLINEREQ is set to 10.
Depending on the value specified for TOONLINEREQ, more timeouts can be received. You can check in the following ways:- WUI requests
- All WUI requests receive the following message and no data records are displayed, regardless of
the CONTEXT and SCOPE of the request.
- EYUVC1220E
- CICSPlex SM API command (GET) failed. (Environerror, Reqtimeout)
- API requests initiated from CICS programs
- All API requests initiated from CICS programs receive a RESPONSE of ENVIRONERROR (1030) and REASON of REQTIMEOUT (1342) and no data records are returned, regardless of the CONTEXT and SCOPE of the request.
- TOPOLLINT(value | 300)
- Specifies the
time in seconds that a CMAS delays between checking all requests to check if they exceed their
timeout time. Because polling is used to check when to timeout a request, more reliable timeouts
occur if this value is set less than or equal to both TOBATCHREQ and TOONLINEREQ.
When a request is directed to a MAS that is not connected to the originating CMAS, it is transmitted from the originating CMAS to the remote CMAS to which the MAS is connected. In this case, the remote CMAS performs the timeout processing, based on the TOBATCHREQ and TOONLINEREQ values specified in the originating CMAS and the TOPOLLINT value specified in the remote CMAS. For this reason, timeout processing is more consistent if all CMASes in the network have the same TOPOLLINT value.
- WLMLCUSH(value | 20)
- Specifies the percentage of additional pre-allocated storage that CICSPlex SM WLM list management uses in addition to
the value of MAXTASK at region initialization. This value is in the range of 0 to 100. Important: If this value is lower than the known variance of MAXTASK from the initial MXT value, additional allocation and deallocation of storage in the routing region occurs, leading to degraded performance. In such circumstances, you must increase the initial values of MXT or WLMLCUSH and restart the routing region.
CICSPlex SM suspend classes
| Suspend class | CICS suspend types | Value in STALLxxx parameters | Text in EYUPNxxxx messages |
|---|---|---|---|
| Allocate Session | ALLOCATE | SES | ALLCSESS |
| Asynchronous services |
AS_ANY
AS_CHILD ASPARENT |
ASY | ASYNC |
| Console | CQSYSTEM | CON | CONSOLE |
| DBCTL | DBCTL | DBC | DBCTL |
| Db2 |
CDB2®CONN
CDB2RDYQ CDB2TCB DB2_INIT DB2 DB2CDISC DB2EDISA |
DB2 | DB2 |
| DLI | DLI | DLI | DLI |
| Dispatcher |
DS_ASSOC
DS_HELD DISPATCH |
DSP | DISP |
| Enterprise Java™ |
EJ.ST.DJ.
EJ.ST.DC. |
EJB | EJB |
| Enterprise Java | RZRSTRAN | EJB | EJB |
| Enterprise Java | RZRSTRIG | EJB | EJB |
| Enterprise Java | SHREQEST | EJB | EJB |
| Enterprise Java | SHSYSTEM | EJB | EJB |
| Enqueue |
KC_ENQ
ENQUEUE |
ENQ | ENQUEUE |
| File |
FCxxxxxx
CFDTxxxx |
FLE | FILE |
| File | FCBFSUSP | FLE | FILE |
| File | FCWAITQ | FLE | FILE |
| Interval Control | ICxxxxxx | ITV | INTV |
| Interval Control | TIEXPIRY | ITV | INTV |
| IP Interconnectivity | IS_xxxx | IPC | IPIC |
| Journal |
JASUBTAS
JCxxxxxx |
JNL | JOURNAL |
| Lock Manager | LMQUEUE | LCK | LOCK |
| Logger | LGxxxxxx | LGR | LOGGER |
| Log Manager | LGxxxxxx | LGR | LOGGER |
| MQSeries® |
MQSERIES
WMQ_INIT WMQCDISC |
MQS | MQSERIES |
| Program Loader | APRDR | PGM | PROGRAM |
| Program Loader | CPI | PGM | PROGRAM |
| Program Loader | EDF | PGM | PROGRAM |
| Program Loader | PROGRAM | PGM | PROGRAM |
| Resource manager | DFHPTTW | RMI | RM |
| Resource manager | PRM | RMI | RM |
| Resource manager | RMCLIENT | RMI | RM |
| Resource manager | RMUOWOBJ | RMI | RM |
| Resource manager | UNSHUNT | RMI | RM |
| Sockets domain | CCACHE | SOC | SOCKETS |
| Sockets domain | SOCKETS | SOC | SOCKETS |
| Storage | SMSYSTEM | STG | STORAGE |
| Storage |
xDSA
ExDSA |
STG | STORAGE |
| Terminal | NOTI | ILK | IRLINK |
| Transaction manager | FOREVER | XMG | TRANSACT |
| Transaction manager | RESYNC | XMG | TRANSACT |
| Transaction manager | SOCBNOTI | XMG | TRANSACT |
| Transaction manager | SOCFNOTI | XMG | TRANSACT |
| Transaction manager | TRANDEF | XMG | TRANSACT |
| Transaction manager | XMCHILD | XMG | TRANSACT |
| Transaction manager | XMPARENT | XMG | TRANSACT |
| Transient Data |
MBCB_xxx
MRCB_xxx TDEPLOCK TDIPLOCK TD_INIT TD_READ |
TDQ | TSDATA |
| Terminal Control | ZCxxxxxx | TRM | TERM |
| Task Wait |
EKCWAIT
KCCOMPAT |
TSK | TASKWAIT |
| Temporary Storage | TSxxxxxx | TSQ | TEMPSTOR |
| Terminal | IRLINK | ILK | IRLINK |
| Terminal Control | AITM | TRM | TERM |
| Transaction Manager |
XM_HELD
MXT TCLASS |
XMG | TRANSACT |
| User wait |
USERWAIT
EDF |
USR | USERWAIT |
| Webservices |
WBALIAS
WEB_ECB |
WEB | WEBSERV |
| Webservices | PIISLSTN | WEB | WEBSERV |
| Webservices | PIPELINE | WEB | WEBSERV |
| Webservices | RZCBNOTI | WEB | WEBSERV |
| XRF | XRxxxxxx | XRF | XRF |
CICSPlex SM system parameters for problem determination
CICSPlex SM system parameters are used to identify or alter the attributes of a CMAS or MAS. Some system parameters are required in a CMAS or MAS startup job. However, the system parameters described here are optional and are used primarily for problem determination. In the course of diagnosing a problem, IBM Support might ask you to start a CMAS or MAS with one or more of these parameters specified.
| Name | Description | Values | Default 1 | Used by |
|---|---|---|---|---|
| BASTRACE | Business Application Services trace settings | 1–32 | None | Both |
| CHETRACE | Data Cache Manager trace settings | 1–32 | None | Both |
| CICSDUMPS | CICS system dumping active | YES | NO | NO | CMAS 2 |
| COMTRACE | Communications trace settings | 1–32 | None | Both |
| DATTRACE | Data Repository trace settings | 1–32 | None | Both |
| ESDUMP | Take SDUMP on all CMAS and MAS failures | YES | NO | NEVER | NO | Both 3 |
| ESDUMPCOM | Capture communication task dumps | YES | NO | NO | CMAS 4 |
| ESDUMPLIMIT | Controls the number of dumps collected for a given failure. | 0–999 | 1 | CMAS 5 |
| KNLTRACE | Kernel Linkage trace settings | 1–32 | None | Both |
| MASTRACE | Managed Application System trace settings | 1–32 | None | MAS |
| MONTRACE | Monitor Services trace settings | 1–32 | None | CMAS |
| MSGTRACE | Message Services trace settings | 1–32 | None | Both |
| QUETRACE | Queue Manager trace settings | 1–32 | None | Both |
| RTATRACE | real-time analysis trace settings | 1–32 | None | Both 6 |
| SRVTRACE | Common Services trace settings | 1–32 | None | Both |
| TOPTRACE | Topology Services trace settings | 1–32 | None | Both |
| TRCTRACE | Trace Services trace settings | 1–32 | None | Both |
| WLMTRACE | Workload Manager trace settings | 1–32 | None | Both 7 |
- You should only modify the default values at the request of your IBM Service Representative.
- When CICSDUMPS(NO), the default, is used, CICSPlex SM activates CICS Global System Dump suppression, which suppresses CICS generated system dumps.
CICSDUMPS(YES) may be set as requested by IBM Support if CICS Global System Dump suppression is to be deactivated.
For diagnosis of CICSPlex SM issues, the CICS-requested system dump would generally not contain sufficient information to diagnose a CICSPlex SM problem. However, in cases where CICSPlex SM is a victim of a problem within CICS, an SVC dump captured by CICS would be more beneficial for diagnosis.
- ESDUMP - SVC dumps are issued by CICSPlex SM through EYU9XLRV during abend recovery or on demand through EYU0XZPT and
EYU0XZSD.
- When ESDUMP(YES) is specified, no SVC dumps are suppressed.
- When ESDUMP(NO) is specified, duplicate dumps taken by EYU9XLRV, EYU0XZPT and internally by EYU0XZSD may be suppressed, depending upon the value of the ESDUMPLIMIT EYUPARM. SVC dump requests made through EYU0XZSD from the COD0 transaction continue to be honored.
- When ESDUMP(NEVER) is specified, all SVC dumps taken by EYU9XLRV, EYU0XZPT, and internally by EYU0XZSD are suppressed. SVC dump requests made through EYU0XZSD from the COD0 transaction continue to be honored.
To deactivate SVC dump suppression without restarting the CMAS or MAS, the ESDUMP value can also be updated using one of the following methods:- Using the COD0 SET command.
- For a CMAS only, by updating the CMAS resource table SDUMP field using the API or WUI
- When ESDUMPCOM(NO), the default, is used, CICSPlex SM suppresses SVC dumps for a select group
of abend codes, listed below, that can occur in CICSPlex SM communications tasks.
- AAL1
- AAO9
- AEXY
- AICG
- AKC3
- ASP1
- ASP2
- AZI2
- AZI4
- AZI6
- AZI9
- EYUY
In most cases, these types of abends can be easily diagnosed with the messages that appear in the region job log, MSGUSR, EYULOG, or MVS syslog, and an SVC dump to diagnose these errors is not needed.
When an SVC dump is needed, IBM Support will request that ESDUMPCOM(YES) be set so that SVC dumps are captured for communications tasks that encounter the above abend codes.
Note the ESDUMPCOM option honors the setting of ESDUMPLIMIT, which means that if a dump is allowed by ESDUMPCOM, it may be suppressed by ESDUMPLIMIT.
- If the ESDUMP system parameter is set to NO, the SVC dump suppression is
controlled by the ESDUMPLIMIT CICSPlex SM system
parameter. You can use it in the startup job for the CMAS. This parameter controls the number of
dumps collected for a given failure. The default is 1.For example, if you want to capture dump diagnostic information for the first 3 instances of an error, add the following to the CMAS's EYUPARM DD statement:
An abend control block of entries is created whenever a CICSPlex SM dump is requested. Each entry contains information about the number of different abends that have occurred. Separate entries are maintained for CMASes and MASes.ESDUMP(NO) ESDUMPLIMIT(3)The instances of an abend are determined by a combination of abending program name, abend codes, abend offset and region type (CMAS or MAS).
For dumps requested by a MAS, the ESDUMPLIMIT of the CMAS that the MAS connects to is used. For a MAS, the dump limit is shared among all the MASes that connect to the CMAS. For example, if ESDUMPLIMIT(5) is set in a CMAS, and 10 different MASes all receive the same abend, dumps are requested only by the first 5 MASes.
The number of abends that have occurred is reset to 0 for MAS-related abend entries when the last MAS disconnects from a CMAS.
The number of abends that have occurred is reset to 0 for CMAS related abend entries during CMAS initialization.
All abend entries are reset for both MASes and CMASes if a CMAS and all the MASes that connect to it are shut down at the same time.
- RTATRACE is valid in a MAS only if status definitions are installed and being used by a user-written status program.
- WLMTRACE is valid in a MAS only if it is a local MAS acting as a TOR in a CICSPlex SM workload.
Specifying system parameters for problem determination
System parameters are specified by means of an extrapartition transient data queue with a destination ID of COPR.
The parameters may be assigned to a DD * file, sequential data set, or a partitioned data set member. The DD name for the extrapartition transient data queue is EYUPARM.
keyword(value) where:- keyword is the name of a CICSPlex SM system parameter. There is a problem determination parameter for each CMAS or MAS component. The parameter is named as follows, where xxx is the 3-character component identifier:
- xxxTRACE
- Turns one or more levels of tracing on for the component. By default, component trace is not active when a CMAS or MAS starts.
- value is the alphanumeric data value assigned to the parameter.
For the trace and message parameters shown here, you can specify one or more values between 1 and 32. Values of 1 and 2 provide standard trace entries and messages; values of 3 through 32 cause special trace entries and messages to be recorded.
You can specify multiple values on a single parameter. To specify individual values, separate the values with a comma. To specify a range of values, separate the low and high values with a colon. For example, the following turns on trace levels 1 through 3, 16, and 28 through 32 in the Kernel Linkage (KNL) component.KNLTRACE(1:3,16,28:32)To request multiple values for the same parameter, you must specify them as a single entry. If the same parameter is specified more than once, only the last entry is used.
- CMAS detail (EYUSTARTCMAS.TRACE) view to change CMAS component trace settings
- MASs known to CICSplex (EYUSTARTMAS.TRACE) view to change MAS component trace settings