INGCPSM

Purpose

The INGCPSM command returns status information for a CICSPlex® System Manager (CICSPlex SM) object. This data is returned in ING150I messages. INGCPSM should be run in a virtual operator station task (VOST).

Syntax

Read syntax diagramSkip visual syntax diagramINGCPSMCONTEXT= contextSCOPE= contextSCOPE= scopeACTION=SAZOSACTION= actionTIMEOUT=10TIMEOUT= timeoutPREFIX=CPSMPREFIX= prefix

Parameters

CONTEXT
This identifies the context for the command. context must be the name of a CICSplex and can be 1–8 characters long. This parameter is required.

Note that a CICSPlex SM address space (CMAS) name is not allowed.

SCOPE
This qualifies the CONTEXT option. scope can be:
  • The 1- to 8-character name of the CICSPlex itself
  • A CICS® system or CICS system group within the CICSPlex
  • A logical scope, as defined in a CICSPlex SM resource description (RESDESC)
If scope is not specified the same value that is defined for the context is used.
ACTION
This limits the events that INGCPSM handles to those that are defined with a certain ACTION DEFINITION name.

If action is not specified SAZOS is used as the default.

TIMEOUT
This is the number of seconds to wait and collect events before ING150I messages are produced. This is also the interval during which monitor resources that require initial monitoring are determined. The valid range is 1–30 seconds.

If timeout is not specified 10 seconds is used as the default.

PREFIX
This is the 1-4 character string that prefixes a monitored CPSM object in the monitor resource. This is used to identify CPSM-related MTRs for initial monitoring.

If prefix is not specified CPSM is used as the default.

Return Codes

None.

Restrictions and Limitations

SA z/OS must be fully initialized.

INGCPSM requires CICSPlex SM to be installed and ready to use. Appropriate definitions must have been made within CPSM. See the step Installing CICSPlex SM REXX API in the chapter Installing SA z/OS on Host Systems in IBM Z® System Automation Planning and Installation.

Usage

Use the INGVSTRT command to run INGCPSM in a VOST, see INGVSTRT.

Examples

To start INGCPSM and monitor CICSplex CICPLX1, enter the following as a start command in the VOST management APL:
INGVSTRT SYNC,INGCPSM CONTEXT=CICSPLX1
To override the defaults for ACTION and TIMEOUT specify:
INGVSTRT SYNC,INGCPSM CONTEXT=CICSPLX1,ACTION=MYACT,TIMEOUT=30